{"thread":{"id":"49190","subject":"[PATCH] config: fix commit-graph related config docs","startedAt":"2018-08-22T13:16:06Z","lastAt":"2018-08-23T17:20:12Z","messageCount":5,"participants":["Derrick Stolee","Duy Nguyen","Johannes Sixt","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"356246","messageId":"20180822131547.56899-1-dstolee@microsoft.com","threadId":"49190","inReplyTo":null,"subject":"[PATCH] config: fix commit-graph related config docs","fromName":"Derrick Stolee","fromEmail":"dstolee@microsoft.com","sentAt":"2018-08-22T13:16:02Z","receivedAt":"2018-08-22T13:16:06Z","isPatch":true,"sender":{"key":"stolee@gmail.com","avatar":"https://avatars.githubusercontent.com/u/570044?v=4"},"body":"The core.commitGraph config setting was accidentally removed from\nthe config documentation. In that same patch, the config setting\nthat writes a commit-graph during garbage collection was incorrectly\nwritten to the doc as \"gc.commitGraph\" instead of \"gc.writeCommitGraph\".\n\nReported-by: Szeder Gábor \nSigned-off-by: Derrick Stolee \n---\n\nSzeder reported this in [1] and I forgot until now to come back to it.\n\n[1] https://public-inbox.org/git/20180803093909.2853-1-szeder.dev@gmail.com/\n\n Documentation/config.txt | 6 +++++-\n 1 file changed, 5 insertions(+), 1 deletion(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex 1c42364988..f846543414 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -917,7 +917,11 @@ core.notesRef::\n This setting defaults to \"refs/notes/commits\", and it can be overridden by\n the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].\n \n-gc.commitGraph::\n+core.commitGraph::\n+\tEnable git commit graph feature. Allows reading from the\n+\tcommit-graph file.\n+\n+gc.writeCommitGraph::\n \tIf true, then gc will rewrite the commit-graph file when\n \tlinkgit:git-gc[1] is run. When using linkgit:git-gc[1]\n \t'--auto' the commit-graph will be updated if housekeeping is\n\nbase-commit: 7e8bfb0412581daf8f3c89909f1d37844e8610dd\n-- \n2.19.0.rc0\n\n"},{"id":"356254","messageId":"CACsJy8C6DPTjhLm0tgyK4+RepQmWBkxnwTwoUhVvDYoXC_+m4w@mail.gmail.com","threadId":"49190","inReplyTo":"20180822131547.56899-1-dstolee@microsoft.com","subject":"Re: [PATCH] config: fix commit-graph related config docs","fromName":"Duy Nguyen","fromEmail":"pclouds@gmail.com","sentAt":"2018-08-22T15:25:44Z","receivedAt":"2018-08-22T15:26:13Z","isPatch":true,"sender":{"key":"pclouds@gmail.com","avatar":"https://avatars.githubusercontent.com/u/720?v=4"},"body":"On Wed, Aug 22, 2018 at 3:18 PM Derrick Stolee wrote:\n>\n> The core.commitGraph config setting was accidentally removed from\n> the config documentation. In that same patch, the config setting\n> that writes a commit-graph during garbage collection was incorrectly\n> written to the doc as \"gc.commitGraph\" instead of \"gc.writeCommitGraph\".\n>\n> Reported-by: Szeder Gábor \n> Signed-off-by: Derrick Stolee \n> ---\n>\n> Szeder reported this in [1] and I forgot until now to come back to it.\n>\n> [1] https://public-inbox.org/git/20180803093909.2853-1-szeder.dev@gmail.com/\n>\n> Documentation/config.txt | 6 +++++-\n> 1 file changed, 5 insertions(+), 1 deletion(-)\n>\n> diff --git a/Documentation/config.txt b/Documentation/config.txt\n> index 1c42364988..f846543414 100644\n> --- a/Documentation/config.txt\n> +++ b/Documentation/config.txt\n> @@ -917,7 +917,11 @@ core.notesRef::\n> This setting defaults to \"refs/notes/commits\", and it can be overridden by\n> the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].\n>\n> -gc.commitGraph::\n> +core.commitGraph::\n> + Enable git commit graph feature. Allows reading from the\n> + commit-graph file.\n> +\n> +gc.writeCommitGraph::\n\nDo\n\ngit grep -i '^[a-z.]*::' Documentation/config.txt\n\nand you will see that we (mostly) group config keys by section.\nThere's already gc group and this gc.writeCommitGraph belongs there,\nnot in the middle of \"core\" stuff.\n\n> If true, then gc will rewrite the commit-graph file when\n> linkgit:git-gc[1] is run. When using linkgit:git-gc[1]\n> '--auto' the commit-graph will be updated if housekeeping is\n>\n> base-commit: 7e8bfb0412581daf8f3c89909f1d37844e8610dd\n> --\n> 2.19.0.rc0\n>\n\n\n-- \nDuy\n"},{"id":"356257","messageId":"51671d59-8654-d79a-3fd9-9353aa4de1d7@kdbg.org","threadId":"49190","inReplyTo":"20180822131547.56899-1-dstolee@microsoft.com","subject":"Re: [PATCH] config: fix commit-graph related config docs","fromName":"Johannes Sixt","fromEmail":"j6t@kdbg.org","sentAt":"2018-08-22T15:33:55Z","receivedAt":"2018-08-22T15:34:00Z","isPatch":true,"sender":{"key":"j6t@kdbg.org","avatar":"https://avatars.githubusercontent.com/u/14810926?v=4"},"body":"Am 22.08.2018 um 15:16 schrieb Derrick Stolee:\n> diff --git a/Documentation/config.txt b/Documentation/config.txt\n> index 1c42364988..f846543414 100644\n> --- a/Documentation/config.txt\n> +++ b/Documentation/config.txt\n> @@ -917,7 +917,11 @@ core.notesRef::\n> This setting defaults to \"refs/notes/commits\", and it can be overridden by\n> the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].\n> \n> -gc.commitGraph::\n> +core.commitGraph::\n> +\tEnable git commit graph feature. Allows reading from the\n> +\tcommit-graph file.\n\nPlease do not assume that everybody knows what \"the commit-graph file\" \nis and that they know that they want it or do not want it. I do not \nknow. You should mention here when to set this configuration variable to \nwhich values and what the default value is.\n\n> +\n> +gc.writeCommitGraph::\n> \tIf true, then gc will rewrite the commit-graph file when\n> \tlinkgit:git-gc[1] is run. When using linkgit:git-gc[1]\n> \t'--auto' the commit-graph will be updated if housekeeping is\n\n-- Hannes\n"},{"id":"356376","messageId":"20180823155107.16658-1-dstolee@microsoft.com","threadId":"49190","inReplyTo":"20180822131547.56899-1-dstolee@microsoft.com","subject":"[PATCH v2] config: fix commit-graph related config docs","fromName":"Derrick Stolee","fromEmail":"dstolee@microsoft.com","sentAt":"2018-08-23T15:51:19Z","receivedAt":"2018-08-23T15:53:04Z","isPatch":true,"sender":{"key":"stolee@gmail.com","avatar":"https://avatars.githubusercontent.com/u/570044?v=4"},"body":"The core.commitGraph config setting was accidentally removed from\nthe config documentation. In that same patch, the config setting\nthat writes a commit-graph during garbage collection was incorrectly\nwritten to the doc as \"gc.commitGraph\" instead of \"gc.writeCommitGraph\".\n\nReported-by: Szeder Gábor \nSigned-off-by: Derrick Stolee \n---\n Documentation/config.txt | 17 +++++++++++------\n 1 file changed, 11 insertions(+), 6 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex 1c42364988..6ee1890984 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -917,12 +917,10 @@ core.notesRef::\n This setting defaults to \"refs/notes/commits\", and it can be overridden by\n the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].\n \n-gc.commitGraph::\n-\tIf true, then gc will rewrite the commit-graph file when\n-\tlinkgit:git-gc[1] is run. When using linkgit:git-gc[1]\n-\t'--auto' the commit-graph will be updated if housekeeping is\n-\trequired. Default is false. See linkgit:git-commit-graph[1]\n-\tfor details.\n+core.commitGraph::\n+\tIf true, then git will read the commit-graph file (if it exists)\n+\tto parse the graph structure of commits. Defaults to false. See\n+\tlinkgit:git-commit-graph[1] for more information.\n \n core.useReplaceRefs::\n \tIf set to `false`, behave as if the `--no-replace-objects`\n@@ -1763,6 +1761,13 @@ this configuration variable is ignored, all packs except the base pack\n will be repacked. After this the number of packs should go below\n gc.autoPackLimit and gc.bigPackThreshold should be respected again.\n \n+gc.writeCommitGraph::\n+\tIf true, then gc will rewrite the commit-graph file when\n+\tlinkgit:git-gc[1] is run. When using linkgit:git-gc[1]\n+\t'--auto' the commit-graph will be updated if housekeeping is\n+\trequired. Default is false. See linkgit:git-commit-graph[1]\n+\tfor details.\n+\n gc.logExpiry::\n \tIf the file gc.log exists, then `git gc --auto` won't run\n \tunless that file is more than 'gc.logExpiry' old. Default is\n-- \n2.19.0.rc0\n\n"},{"id":"356384","messageId":"xmqq1sapj8zd.fsf@gitster-ct.c.googlers.com","threadId":"49190","inReplyTo":"20180823155107.16658-1-dstolee@microsoft.com","subject":"Re: [PATCH v2] config: fix commit-graph related config docs","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2018-08-23T17:20:06Z","receivedAt":"2018-08-23T17:20:12Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Derrick Stolee writes:\n\n> The core.commitGraph config setting was accidentally removed from\n> the config documentation. In that same patch, the config setting\n> that writes a commit-graph during garbage collection was incorrectly\n> written to the doc as \"gc.commitGraph\" instead of \"gc.writeCommitGraph\".\n>\n> Reported-by: Szeder Gábor \n> Signed-off-by: Derrick Stolee \n> ---\n> Documentation/config.txt | 17 +++++++++++------\n> 1 file changed, 11 insertions(+), 6 deletions(-)\n\nThanks; that's an appropriate update before the release to tie the\nfinal loose ends. Will apply.\n\n> diff --git a/Documentation/config.txt b/Documentation/config.txt\n> index 1c42364988..6ee1890984 100644\n> --- a/Documentation/config.txt\n> +++ b/Documentation/config.txt\n> @@ -917,12 +917,10 @@ core.notesRef::\n> This setting defaults to \"refs/notes/commits\", and it can be overridden by\n> the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].\n> \n> -gc.commitGraph::\n> -\tIf true, then gc will rewrite the commit-graph file when\n> -\tlinkgit:git-gc[1] is run. When using linkgit:git-gc[1]\n> -\t'--auto' the commit-graph will be updated if housekeeping is\n> -\trequired. Default is false. See linkgit:git-commit-graph[1]\n> -\tfor details.\n> +core.commitGraph::\n> +\tIf true, then git will read the commit-graph file (if it exists)\n> +\tto parse the graph structure of commits. Defaults to false. See\n> +\tlinkgit:git-commit-graph[1] for more information.\n> \n> core.useReplaceRefs::\n> \tIf set to `false`, behave as if the `--no-replace-objects`\n> @@ -1763,6 +1761,13 @@ this configuration variable is ignored, all packs except the base pack\n> will be repacked. After this the number of packs should go below\n> gc.autoPackLimit and gc.bigPackThreshold should be respected again.\n> \n> +gc.writeCommitGraph::\n> +\tIf true, then gc will rewrite the commit-graph file when\n> +\tlinkgit:git-gc[1] is run. When using linkgit:git-gc[1]\n> +\t'--auto' the commit-graph will be updated if housekeeping is\n> +\trequired. Default is false. See linkgit:git-commit-graph[1]\n> +\tfor details.\n> +\n> gc.logExpiry::\n> \tIf the file gc.log exists, then `git gc --auto` won't run\n> \tunless that file is more than 'gc.logExpiry' old. Default is\n"}]}