aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-commit-graph.txt
diff options
context:
space:
mode:
authorDerrick Stolee <dstolee@microsoft.com>2018-04-10 08:56:02 -0400
committerJunio C Hamano <gitster@pobox.com>2018-04-11 10:43:01 +0900
commit2a2e32bdc5a80221981939e77643cec3462b4793 (patch)
treeae0344a998a46747dec3fbaf443e852ae4f71db4 /Documentation/git-commit-graph.txt
parentf237c8b6feaa3bad352bd27c14f0d83d0a1c061a (diff)
downloadgit-2a2e32bdc5a80221981939e77643cec3462b4793.tar.gz
commit-graph: implement git commit-graph read
Teach git-commit-graph to read commit graph files and summarize their contents. Use the read subcommand to verify the contents of a commit graph file in the tests. Signed-off-by: Derrick Stolee <dstolee@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-commit-graph.txt')
-rw-r--r--Documentation/git-commit-graph.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/git-commit-graph.txt b/Documentation/git-commit-graph.txt
index 47996e8f89..8aad8303f5 100644
--- a/Documentation/git-commit-graph.txt
+++ b/Documentation/git-commit-graph.txt
@@ -9,6 +9,7 @@ git-commit-graph - Write and verify Git commit graph files
SYNOPSIS
--------
[verse]
+'git commit-graph read' [--object-dir <dir>]
'git commit-graph write' <options> [--object-dir <dir>]
@@ -35,6 +36,11 @@ COMMANDS
Write a commit graph file based on the commits found in packfiles.
Includes all commits from the existing commit graph file.
+'read'::
+
+Read a graph file given by the commit-graph file and output basic
+details about the graph file. Used for debugging purposes.
+
EXAMPLES
--------
@@ -45,6 +51,12 @@ EXAMPLES
$ git commit-graph write
------------------------------------------------
+* Read basic information from the commit-graph file.
++
+------------------------------------------------
+$ git commit-graph read
+------------------------------------------------
+
GIT
---