[PATCH v2] 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 Signed-off-by: Derrick Stolee --- Documentation/config.txt | 17 +++-- 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index 1c42364988..6ee1890984 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -917,12 +917,10 @@ core.notesRef:: This setting defaults to "refs/notes/commits", and it can be overridden by the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. -gc.commitGraph:: - If true, then gc will rewrite the commit-graph file when - linkgit:git-gc[1] is run. When using linkgit:git-gc[1] - '--auto' the commit-graph will be updated if housekeeping is - required. Default is false. See linkgit:git-commit-graph[1] - for details. +core.commitGraph:: + If true, then git will read the commit-graph file (if it exists) + to parse the graph structure of commits. Defaults to false. See + linkgit:git-commit-graph[1] for more information. core.useReplaceRefs:: If set to `false`, behave as if the `--no-replace-objects` @@ -1763,6 +1761,13 @@ this configuration variable is ignored, all packs except the base pack will be repacked. After this the number of packs should go below gc.autoPackLimit and gc.bigPackThreshold should be respected again. +gc.writeCommitGraph:: + If true, then gc will rewrite the commit-graph file when + linkgit:git-gc[1] is run. When using linkgit:git-gc[1] + '--auto' the commit-graph will be updated if housekeeping is + required. Default is false. See linkgit:git-commit-graph[1] + for details. + gc.logExpiry:: If the file gc.log exists, then `git gc --auto` won't run unless that file is more than 'gc.logExpiry' old. Default is -- 2.19.0.rc0
Re: [PATCH v2] config: fix commit-graph related config docs
Derrick Stolee writes: > 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 > Signed-off-by: Derrick Stolee > --- > Documentation/config.txt | 17 +++-- > 1 file changed, 11 insertions(+), 6 deletions(-) Thanks; that's an appropriate update before the release to tie the final loose ends. Will apply. > diff --git a/Documentation/config.txt b/Documentation/config.txt > index 1c42364988..6ee1890984 100644 > --- a/Documentation/config.txt > +++ b/Documentation/config.txt > @@ -917,12 +917,10 @@ core.notesRef:: > This setting defaults to "refs/notes/commits", and it can be overridden by > the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. > > -gc.commitGraph:: > - If true, then gc will rewrite the commit-graph file when > - linkgit:git-gc[1] is run. When using linkgit:git-gc[1] > - '--auto' the commit-graph will be updated if housekeeping is > - required. Default is false. See linkgit:git-commit-graph[1] > - for details. > +core.commitGraph:: > + If true, then git will read the commit-graph file (if it exists) > + to parse the graph structure of commits. Defaults to false. See > + linkgit:git-commit-graph[1] for more information. > > core.useReplaceRefs:: > If set to `false`, behave as if the `--no-replace-objects` > @@ -1763,6 +1761,13 @@ this configuration variable is ignored, all packs > except the base pack > will be repacked. After this the number of packs should go below > gc.autoPackLimit and gc.bigPackThreshold should be respected again. > > +gc.writeCommitGraph:: > + If true, then gc will rewrite the commit-graph file when > + linkgit:git-gc[1] is run. When using linkgit:git-gc[1] > + '--auto' the commit-graph will be updated if housekeeping is > + required. Default is false. See linkgit:git-commit-graph[1] > + for details. > + > gc.logExpiry:: > If the file gc.log exists, then `git gc --auto` won't run > unless that file is more than 'gc.logExpiry' old. Default is
