Skip to content

Commit 4c39944

Browse files
Martin Ågrengitster
authored andcommitted
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 <[email protected]> Reviewed-by: Derrick Stolee <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 4893d71 commit 4c39944

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

Documentation/git-commit-graph.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ git-commit-graph(1)
33

44
NAME
55
----
6-
git-commit-graph - Write and verify Git commit graph files
6+
git-commit-graph - Write and verify Git commit-graph files
77

88

99
SYNOPSIS
@@ -17,24 +17,24 @@ SYNOPSIS
1717
DESCRIPTION
1818
-----------
1919

20-
Manage the serialized commit graph file.
20+
Manage the serialized commit-graph file.
2121

2222

2323
OPTIONS
2424
-------
2525
--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
2727
file. This parameter exists to specify the location of an alternate
2828
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
3030
the packfiles are expected to be in `<dir>/pack`.
3131

3232

3333
COMMANDS
3434
--------
3535
'write'::
3636

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.
3838
+
3939
With the `--stdin-packs` option, generate the new commit graph by
4040
walking objects only in the specified pack-indexes. (Cannot be combined
@@ -66,7 +66,7 @@ database. Used to check for corrupted data.
6666
EXAMPLES
6767
--------
6868

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`
7070
directory.
7171
+
7272
------------------------------------------------

Documentation/technical/commit-graph.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ There are two main costs here:
1515
1. Decompressing and parsing commits.
1616
2. Walking the entire graph to satisfy topological order constraints.
1717

18-
The commit graph file is a supplemental data structure that accelerates
18+
The commit-graph file is a supplemental data structure that accelerates
1919
commit graph walks. If a user downgrades or disables the 'core.commitGraph'
2020
config setting, then the existing ODB is sufficient. The file is stored
2121
as "commit-graph" either in the .git/objects/info directory or in the info
2222
directory of an alternate.
2323

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
2525
extra metadata to speed up graph walks. By listing commit OIDs in lexi-
2626
cographic order, we can identify an integer position for each commit and
2727
refer to the parents of a commit using those integer positions. We use
@@ -103,7 +103,7 @@ that of a parent.
103103
Design Details
104104
--------------
105105

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
107107
.git/objects/info directory. This could be stored in the info directory
108108
of an alternate.
109109

@@ -127,7 +127,7 @@ Future Work
127127
- 'log --topo-order'
128128
- 'tag --merged'
129129

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
131131
to avoid extra calculations by clients. This feature is only of benefit if
132132
the user is willing to trust the file, because verifying the file is correct
133133
is as hard as computing it from scratch.

0 commit comments

Comments
 (0)