Skip to contentSkip to conversation

config: fix commit-graph related config docs

PATCH Superseded Derrick Stolee 4 participants 5 messages Aug 22, 2018 – Aug 23, 2018 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 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".

---

Szeder reported this in [1] and I forgot until now to come back to it.

[1] https://public-inbox.org/git/[email protected]/

 Documentation/config.txt | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
Documentation/config.txt +5 -1
index 1c42364988..f846543414 100644
@@ -917,7 +917,11 @@ 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::
+core.commitGraph::
+	Enable git commit graph feature. Allows reading from the
+	commit-graph file.
+
+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

base-commit: 7e8bfb0412581daf8f3c89909f1d37844e8610dd

Signature · 1 line
2.19.0.rc0
#1 lore raw
Quoted 22 lines · Derrick Stolee

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".

---

Szeder reported this in [1] and I forgot until now to come back to it.

[1] https://public-inbox.org/git/[email protected]/

 Documentation/config.txt | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
Documentation/config.txt +0 -0
index 1c42364988..f846543414 100644

Documentation/config.txt core.notesRef:: · line 924

Quoted 9 lines
Documentation/config.txt +5 -1
@@ -917,7 +917,11 @@ 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::
+core.commitGraph::
+       Enable git commit graph feature. Allows reading from the
+       commit-graph file.
+
+gc.writeCommitGraph::

Do

git grep -i '^[a-z.]*::' Documentation/config.txt

and you will see that we (mostly) group config keys by section. There's already gc group and this gc.writeCommitGraph belongs there, not in the middle of "core" stuff.

Quoted 8 lines
Documentation/config.txt +0 -0
        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

base-commit: 7e8bfb0412581daf8f3c89909f1d37844e8610dd --
2.19.0.rc0

Signature · 1 line
Duy
#2 lore raw
In reply to Derrick Stolee

Am 22.08.2018 um 15:16 schrieb Derrick Stolee:

Documentation/config.txt core.notesRef:: · line 922

Quoted 12 lines
Documentation/config.txt +3 -1
index 1c42364988..f846543414 100644
@@ -917,7 +917,11 @@ 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::
+core.commitGraph::
+	Enable git commit graph feature. Allows reading from the
+	commit-graph file.

Please do not assume that everybody knows what "the commit-graph file" is and that they know that they want it or do not want it. I do not know. You should mention here when to set this configuration variable to which values and what the default value is.

Documentation/config.txt core.notesRef:: · line 927

Quoted 5 lines
Documentation/config.txt +2 -0
+
+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

-- Hannes

#3 lore raw

PATCH v2 1/1 config: fix commit-graph related config docs

In reply to Derrick Stolee

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".

---
 Documentation/config.txt | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)
Documentation/config.txt +11 -6
index 1c42364988..6ee1890984 100644
@@ -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
Signature · 1 line
2.19.0.rc0
#4 lore raw
Quoted 10 lines · Derrick Stolee

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".

---
 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.

Quoted 35 lines
Documentation/config.txt +11 -6
index 1c42364988..6ee1890984 100644
@@ -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