Re: [PATCH] config doc: indent descriptions of feature.* variables

["Ævar Arnfjörð Bjarmason" <avarab@gmail.com>]

On Wed, Jun 02 2021, Andrei Rybak wrote:

> Config variables feature.experimental and feature.manyFiles are grouped
> together under "feature.*".  However, this is not easily visible when
> scanning the help page of git-config.
>
> Indent the descriptions of individual feature.* config variables to help
> the reader distinguish this group of variables.
>
> Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
> ---
>  Documentation/config/feature.txt | 40 +++++++++++++++++---------------
>  1 file changed, 21 insertions(+), 19 deletions(-)
>
> diff --git a/Documentation/config/feature.txt b/Documentation/config/feature.txt
> index cdecd04e5b..2c4dee170b 100644
> --- a/Documentation/config/feature.txt
> +++ b/Documentation/config/feature.txt
> @@ -3,24 +3,26 @@ feature.*::
>  	a group of other config settings. These groups are created by the Git
>  	developer community as recommended defaults and are subject to change.
>  	In particular, new config options may be added with different defaults.
> -
> -feature.experimental::
> -	Enable config options that are new to Git, and are being considered for
> -	future defaults. Config settings included here may be added or removed
> -	with each release, including minor version updates. These settings may
> -	have unintended interactions since they are so new. Please enable this
> -	setting if you are interested in providing feedback on experimental
> -	features. The new default values are:
>  +
> -* `fetch.negotiationAlgorithm=skipping` may improve fetch negotiation times by
> -skipping more commits at a time, reducing the number of round trips.
> +--
> +	feature.experimental::
> +		Enable config options that are new to Git, and are being considered for
> +		future defaults. Config settings included here may be added or removed
> +		with each release, including minor version updates. These settings may
> +		have unintended interactions since they are so new. Please enable this
> +		setting if you are interested in providing feedback on experimental
> +		features. The new default values are:
> +	+
> +	* `fetch.negotiationAlgorithm=skipping` may improve fetch negotiation times by
> +	skipping more commits at a time, reducing the number of round trips.
>  
> -feature.manyFiles::
> -	Enable config options that optimize for repos with many files in the
> -	working directory. With many files, commands such as `git status` and
> -	`git checkout` may be slow and these new defaults improve performance:
> -+
> -* `index.version=4` enables path-prefix compression in the index.
> -+
> -* `core.untrackedCache=true` enables the untracked cache. This setting assumes
> -that mtime is working on your machine.
> +	feature.manyFiles::
> +		Enable config options that optimize for repos with many files in the
> +		working directory. With many files, commands such as `git status` and
> +		`git checkout` may be slow and these new defaults improve performance:
> +	+
> +	* `index.version=4` enables path-prefix compression in the index.
> +	+
> +	* `core.untrackedCache=true` enables the untracked cache. This setting assumes
> +	that mtime is working on your machine.
> +--

I don't know if/how this helps readability, but this breaks the
feature.* generation of these variables in config-list.h, see
generate-configlist.sh.

So if you make this change you need to fix that script as well.