summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorDerrick Stolee <dstolee@microsoft.com>2018-04-02 20:34:20 (GMT)
committerJunio C Hamano <gitster@pobox.com>2018-04-02 21:27:38 (GMT)
commitf237c8b6feaa3bad352bd27c14f0d83d0a1c061a (patch)
tree1d98f278fb73d3c073ed08d8d66baf7c98b65b2a /Documentation
parent08fd81c9b6495a395a527985d18aa51c4ae66cdc (diff)
downloadgit-f237c8b6feaa3bad352bd27c14f0d83d0a1c061a.zip
git-f237c8b6feaa3bad352bd27c14f0d83d0a1c061a.tar.gz
git-f237c8b6feaa3bad352bd27c14f0d83d0a1c061a.tar.bz2
commit-graph: implement git-commit-graph write
Teach git-commit-graph to write graph files. Create new test script to verify this command succeeds without failure. Signed-off-by: Derrick Stolee <dstolee@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-commit-graph.txt41
1 files changed, 41 insertions, 0 deletions
diff --git a/Documentation/git-commit-graph.txt b/Documentation/git-commit-graph.txt
index f3b3462..47996e8 100644
--- a/Documentation/git-commit-graph.txt
+++ b/Documentation/git-commit-graph.txt
@@ -5,6 +5,47 @@ NAME
----
git-commit-graph - Write and verify Git commit graph files
+
+SYNOPSIS
+--------
+[verse]
+'git commit-graph write' <options> [--object-dir <dir>]
+
+
+DESCRIPTION
+-----------
+
+Manage the serialized commit graph file.
+
+
+OPTIONS
+-------
+--object-dir::
+ Use given directory for the location of packfiles and commit graph
+ file. This parameter exists to specify the location of an alternate
+ that only has the objects directory, not a full .git directory. The
+ commit graph file is expected to be at <dir>/info/commit-graph and
+ the packfiles are expected to be in <dir>/pack.
+
+
+COMMANDS
+--------
+'write'::
+
+Write a commit graph file based on the commits found in packfiles.
+Includes all commits from the existing commit graph file.
+
+
+EXAMPLES
+--------
+
+* Write a commit graph file for the packed commits in your local .git folder.
++
+------------------------------------------------
+$ git commit-graph write
+------------------------------------------------
+
+
GIT
---
Part of the linkgit:git[1] suite