Doc: refer to the "commit-graph file" with dash
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>
Martin Ågren committed
Sep 27, 2018 at 21:12 UTC
4c399442f781f70a00273746ca6a0de9fef9b0d3
2 files changed
+10
-10
Documentation/git-commit-graph.txt
+6
-6
@@ -3,7 +3,7 @@ git-commit-graph(1)
3
4
NAME
5
----
6
-git-commit-graph - Write and verify Git commit graph files
6
+git-commit-graph - Write and verify Git commit-graph files
7
8
9
SYNOPSIS
@@ -17,16 +17,16 @@ SYNOPSIS
17
DESCRIPTION
18
-----------
19
20
-Manage the serialized commit graph file.
20
+Manage the serialized commit-graph file.
21
22
23
OPTIONS
24
-------
25
--object-dir::
26
- Use given directory for the location of packfiles and commit graph
26
+ Use given directory for the location of packfiles and commit-graph
27
file. This parameter exists to specify the location of an alternate
28
that only has the objects directory, not a full `.git` directory. The
29
- commit graph file is expected to be at `<dir>/info/commit-graph` and
29
+ commit-graph file is expected to be at `<dir>/info/commit-graph` and
30
the packfiles are expected to be in `<dir>/pack`.
31
32
@@ -34,7 +34,7 @@ COMMANDS
34
--------
35
'write'::
36
37
-Write a commit graph file based on the commits found in packfiles.
37
+Write a commit-graph file based on the commits found in packfiles.
38
+
39
With the `--stdin-packs` option, generate the new commit graph by
40
walking objects only in the specified pack-indexes. (Cannot be combined
@@ -66,7 +66,7 @@ database. Used to check for corrupted data.
66
EXAMPLES
67
--------
68
69
-* Write a commit graph file for the packed commits in your local `.git`
69
+* Write a commit-graph file for the packed commits in your local `.git`
70
directory.
71
+
72
------------------------------------------------
Documentation/technical/commit-graph.txt
+4
-4
@@ -15,13 +15,13 @@ There are two main costs here:
15
1. Decompressing and parsing commits.
16
2. Walking the entire graph to satisfy topological order constraints.
17
18
-The commit graph file is a supplemental data structure that accelerates
18
+The commit-graph file is a supplemental data structure that accelerates
19
commit graph walks. If a user downgrades or disables the 'core.commitGraph'
20
config setting, then the existing ODB is sufficient. The file is stored
21
as "commit-graph" either in the .git/objects/info directory or in the info
22
directory of an alternate.
23
24
-The commit graph file stores the commit graph structure along with some
24
+The commit-graph file stores the commit graph structure along with some
25
extra metadata to speed up graph walks. By listing commit OIDs in lexi-
26
cographic order, we can identify an integer position for each commit and
27
refer to the parents of a commit using those integer positions. We use
@@ -103,7 +103,7 @@ that of a parent.
103
Design Details
104
--------------
105
106
-- The commit graph file is stored in a file named 'commit-graph' in the
106
+- The commit-graph file is stored in a file named 'commit-graph' in the
107
.git/objects/info directory. This could be stored in the info directory
108
of an alternate.
109
@@ -127,7 +127,7 @@ Future Work
127
- 'log --topo-order'
128
- 'tag --merged'
129
130
-- A server could provide a commit graph file as part of the network protocol
130
+- A server could provide a commit-graph file as part of the network protocol
131
to avoid extra calculations by clients. This feature is only of benefit if
132
the user is willing to trust the file, because verifying the file is correct
133
is as hard as computing it from scratch.