undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: refer to the "commit-graph file" with dash

Browse Source 
The file processed by `git commit-graph` is referred to as the
"commit-graph file", also with a dash. We have a few references to the
"commit graph file", though, without the dash. These occur in
git-commit-graph.txt as well as in Doc/technical/commit-graph.txt. Fix
them.

Do not change the references to the "commit graph" (without "... file")
as a data structure.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
Reviewed-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Martin Ågren 2018-09-27 21:12:22 +02:00 committed by Junio C Hamano
parent 4893d717a4
commit 4c399442f7
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/git-commit-graph.txt
View File

@ -3,7 +3,7 @@ git-commit-graph(1)
NAME NAME
---- ----
git-commit-graph - Write and verify Git commit graph files git-commit-graph - Write and verify Git commit-graph files
SYNOPSIS SYNOPSIS
@ -17,16 +17,16 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
----------- -----------
Manage the serialized commit graph file. Manage the serialized commit-graph file.
OPTIONS OPTIONS
------- -------
--object-dir:: --object-dir::
Use given directory for the location of packfiles and commit graph Use given directory for the location of packfiles and commit-graph
file. This parameter exists to specify the location of an alternate file. This parameter exists to specify the location of an alternate
that only has the objects directory, not a full `.git` directory. The 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 commit-graph file is expected to be at `<dir>/info/commit-graph` and
the packfiles are expected to be in `<dir>/pack`. the packfiles are expected to be in `<dir>/pack`.
@ -34,7 +34,7 @@ COMMANDS
-------- --------
'write':: 'write'::
Write a commit graph file based on the commits found in packfiles. Write a commit-graph file based on the commits found in packfiles.
+ +
With the `--stdin-packs` option, generate the new commit graph by With the `--stdin-packs` option, generate the new commit graph by
walking objects only in the specified pack-indexes. (Cannot be combined walking objects only in the specified pack-indexes. (Cannot be combined
@ -66,7 +66,7 @@ database. Used to check for corrupted data.
EXAMPLES EXAMPLES
-------- --------
* Write a commit graph file for the packed commits in your local `.git` * Write a commit-graph file for the packed commits in your local `.git`
directory. directory.
+ +
------------------------------------------------ ------------------------------------------------

8
Documentation/technical/commit-graph.txt
View File

@ -15,13 +15,13 @@ There are two main costs here:
1. Decompressing and parsing commits. 1. Decompressing and parsing commits.
2. Walking the entire graph to satisfy topological order constraints. 2. Walking the entire graph to satisfy topological order constraints.
The commit graph file is a supplemental data structure that accelerates The commit-graph file is a supplemental data structure that accelerates
commit graph walks. If a user downgrades or disables the 'core.commitGraph' commit graph walks. If a user downgrades or disables the 'core.commitGraph'
config setting, then the existing ODB is sufficient. The file is stored config setting, then the existing ODB is sufficient. The file is stored
as "commit-graph" either in the .git/objects/info directory or in the info as "commit-graph" either in the .git/objects/info directory or in the info
directory of an alternate. directory of an alternate.
The commit graph file stores the commit graph structure along with some The commit-graph file stores the commit graph structure along with some
extra metadata to speed up graph walks. By listing commit OIDs in lexi- extra metadata to speed up graph walks. By listing commit OIDs in lexi-
cographic order, we can identify an integer position for each commit and cographic order, we can identify an integer position for each commit and
refer to the parents of a commit using those integer positions. We use refer to the parents of a commit using those integer positions. We use
@ -103,7 +103,7 @@ that of a parent.
Design Details Design Details
-------------- --------------
- The commit graph file is stored in a file named 'commit-graph' in the - The commit-graph file is stored in a file named 'commit-graph' in the
.git/objects/info directory. This could be stored in the info directory .git/objects/info directory. This could be stored in the info directory
of an alternate. of an alternate.
@ -127,7 +127,7 @@ Future Work
- 'log --topo-order' - 'log --topo-order'
- 'tag --merged' - 'tag --merged'
- A server could provide a commit graph file as part of the network protocol - A server could provide a commit-graph file as part of the network protocol
to avoid extra calculations by clients. This feature is only of benefit if to avoid extra calculations by clients. This feature is only of benefit if
the user is willing to trust the file, because verifying the file is correct the user is willing to trust the file, because verifying the file is correct
is as hard as computing it from scratch. is as hard as computing it from scratch.