git-commit-vandalism/Documentation/git-commit-graph.txt
Derrick Stolee 2a2e32bdc5 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>
2018-04-11 10:43:01 +09:00

64 lines
1.4 KiB
Plaintext

git-commit-graph(1)
===================
NAME
----
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>]
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.
'read'::
Read a graph file given by the commit-graph file and output basic
details about the graph file. Used for debugging purposes.
EXAMPLES
--------
* Write a commit graph file for the packed commits in your local .git folder.
+
------------------------------------------------
$ git commit-graph write
------------------------------------------------
* Read basic information from the commit-graph file.
+
------------------------------------------------
$ git commit-graph read
------------------------------------------------
GIT
---
Part of the linkgit:git[1] suite