* [PATCH] config: fix commit-graph related config docs
@ 2018-08-22 13:16 Derrick Stolee
2018-08-22 15:25 ` Duy Nguyen
` (2 more replies)
0 siblings, 3 replies; 5+ messages in thread
From: Derrick Stolee @ 2018-08-22 13:16 UTC (permalink / raw)
To: git@vger.kernel.org
Cc: gitster@pobox.com, szeder.dev@gmail.com, 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".
Reported-by: Szeder Gábor <szeder.dev@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
---
Szeder reported this in [1] and I forgot until now to come back to it.
[1] https://public-inbox.org/git/20180803093909.2853-1-szeder.dev@gmail.com/
Documentation/config.txt | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 1c42364988..f846543414 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -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
--
2.19.0.rc0
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] config: fix commit-graph related config docs
2018-08-22 13:16 [PATCH] config: fix commit-graph related config docs Derrick Stolee
@ 2018-08-22 15:25 ` Duy Nguyen
2018-08-22 15:33 ` Johannes Sixt
2018-08-23 15:51 ` [PATCH v2] " Derrick Stolee
2 siblings, 0 replies; 5+ messages in thread
From: Duy Nguyen @ 2018-08-22 15:25 UTC (permalink / raw)
To: Derrick Stolee; +Cc: Git Mailing List, Junio C Hamano, SZEDER Gábor
On Wed, Aug 22, 2018 at 3:18 PM Derrick Stolee <dstolee@microsoft.com> wrote:
>
> 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 <szeder.dev@gmail.com>
> Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
> ---
>
> Szeder reported this in [1] and I forgot until now to come back to it.
>
> [1] https://public-inbox.org/git/20180803093909.2853-1-szeder.dev@gmail.com/
>
> Documentation/config.txt | 6 +++++-
> 1 file changed, 5 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index 1c42364988..f846543414 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -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.
> 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
>
--
Duy
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] config: fix commit-graph related config docs
2018-08-22 13:16 [PATCH] config: fix commit-graph related config docs Derrick Stolee
2018-08-22 15:25 ` Duy Nguyen
@ 2018-08-22 15:33 ` Johannes Sixt
2018-08-23 15:51 ` [PATCH v2] " Derrick Stolee
2 siblings, 0 replies; 5+ messages in thread
From: Johannes Sixt @ 2018-08-22 15:33 UTC (permalink / raw)
To: Derrick Stolee
Cc: git@vger.kernel.org, gitster@pobox.com, szeder.dev@gmail.com
Am 22.08.2018 um 15:16 schrieb Derrick Stolee:
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index 1c42364988..f846543414 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -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.
> +
> +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
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH v2] config: fix commit-graph related config docs
2018-08-22 13:16 [PATCH] config: fix commit-graph related config docs Derrick Stolee
2018-08-22 15:25 ` Duy Nguyen
2018-08-22 15:33 ` Johannes Sixt
@ 2018-08-23 15:51 ` Derrick Stolee
2018-08-23 17:20 ` Junio C Hamano
2 siblings, 1 reply; 5+ messages in thread
From: Derrick Stolee @ 2018-08-23 15:51 UTC (permalink / raw)
To: git@vger.kernel.org
Cc: gitster@pobox.com, szeder.dev@gmail.com, pclouds@gmail.com,
j6t@kdbg.org, 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".
Reported-by: Szeder Gábor <szeder.dev@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
---
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
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH v2] config: fix commit-graph related config docs
2018-08-23 15:51 ` [PATCH v2] " Derrick Stolee
@ 2018-08-23 17:20 ` Junio C Hamano
0 siblings, 0 replies; 5+ messages in thread
From: Junio C Hamano @ 2018-08-23 17:20 UTC (permalink / raw)
To: Derrick Stolee
Cc: git@vger.kernel.org, szeder.dev@gmail.com, pclouds@gmail.com,
j6t@kdbg.org
Derrick Stolee <dstolee@microsoft.com> 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 <szeder.dev@gmail.com>
> Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
> ---
> 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
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2018-08-23 17:20 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-08-22 13:16 [PATCH] config: fix commit-graph related config docs Derrick Stolee
2018-08-22 15:25 ` Duy Nguyen
2018-08-22 15:33 ` Johannes Sixt
2018-08-23 15:51 ` [PATCH v2] " Derrick Stolee
2018-08-23 17:20 ` Junio C Hamano
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).