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

From: Derrick Stolee <stolee@gmail.com>
Date: Jun 2, 2021, 01:17 UTC
Message-ID: <057126a2-81c4-41cf-e41a-52a24a0c9a52@gmail.com>
In-Reply-To: <20210602001132.459705-1-rybak.a.v@gmail.com>

On 6/1/2021 8:11 PM, Andrei Rybak wrote:

Show 6 quoted lines

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

I'm not sure how these extra tabs help in the rendered text, or in the formatted HTML output for the git-scm.com web page. I do believe that we would want to re-wrap the paragraphs to ensure we are not using too many characters per line.

Is there precedence for a simple tabbing like this? I was able to find a similar grouping for advice.* in Documentation/config/advice.txt, but it uses a different kind of grouping. Perhaps reorganize the file to use that strategy instead?

Or, perhaps just point me to an existing use of this pattern.

Thanks, -Stolee