Re: [PATCH] config: fix commit-graph related config docs

From: Johannes Sixt <j6t@kdbg.org>
Date: Aug 22, 2018, 15:33 UTC
Message-ID: <51671d59-8654-d79a-3fd9-9353aa4de1d7@kdbg.org>
In-Reply-To: <20180822131547.56899-1-dstolee@microsoft.com>

Am 22.08.2018 um 15:16 schrieb Derrick Stolee:

Show 12 quoted lines

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

Show 5 quoted lines

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