Skip to content

Commit d915114

Browse files
derrickstoleegitster
authored andcommitted
config: fix commit-graph related config docs
The core.commitGraph config setting was accidentally removed from the config documentation. In that same patch, the config setting that writes a commit-graph during garbage collection was incorrectly written to the doc as "gc.commitGraph" instead of "gc.writeCommitGraph". Reported-by: Szeder Gábor <[email protected]> Signed-off-by: Derrick Stolee <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent eb7cc5b commit d915114

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

Documentation/config.txt

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -904,12 +904,10 @@ core.notesRef::
904904
This setting defaults to "refs/notes/commits", and it can be overridden by
905905
the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
906906

907-
gc.commitGraph::
908-
If true, then gc will rewrite the commit-graph file when
909-
linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
910-
'--auto' the commit-graph will be updated if housekeeping is
911-
required. Default is false. See linkgit:git-commit-graph[1]
912-
for details.
907+
core.commitGraph::
908+
If true, then git will read the commit-graph file (if it exists)
909+
to parse the graph structure of commits. Defaults to false. See
910+
linkgit:git-commit-graph[1] for more information.
913911

914912
core.sparseCheckout::
915913
Enable "sparse checkout" feature. See section "Sparse checkout" in
@@ -1651,6 +1649,13 @@ this configuration variable is ignored, all packs except the base pack
16511649
will be repacked. After this the number of packs should go below
16521650
gc.autoPackLimit and gc.bigPackThreshold should be respected again.
16531651

1652+
gc.writeCommitGraph::
1653+
If true, then gc will rewrite the commit-graph file when
1654+
linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
1655+
'--auto' the commit-graph will be updated if housekeeping is
1656+
required. Default is false. See linkgit:git-commit-graph[1]
1657+
for details.
1658+
16541659
gc.logExpiry::
16551660
If the file gc.log exists, then `git gc --auto` won't run
16561661
unless that file is more than 'gc.logExpiry' old. Default is

0 commit comments

Comments
 (0)