From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: Andrei Rybak <rybak.a.v@gmail.com>
Cc: git@vger.kernel.org, dstolee@microsoft.com
Subject: Re: [PATCH] config doc: indent descriptions of feature.* variables
Date: Thu, 03 Jun 2021 09:02:49 +0200 [thread overview]
Message-ID: <87k0nb77lq.fsf@evledraar.gmail.com> (raw)
In-Reply-To: <20210602001132.459705-1-rybak.a.v@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.
next prev parent reply other threads:[~2021-06-03 7:03 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-02 0:11 [PATCH] config doc: indent descriptions of feature.* variables Andrei Rybak
2021-06-02 1:14 ` Đoàn Trần Công Danh
2021-06-02 1:17 ` Derrick Stolee
2021-06-02 16:59 ` Taylor Blau
2021-06-02 20:38 ` Todd Zullinger
2021-06-02 23:04 ` Felipe Contreras
2021-06-03 7:02 ` Ævar Arnfjörð Bjarmason [this message]
2021-06-03 7:43 ` Ævar Arnfjörð Bjarmason
2021-06-03 18:03 ` Felipe Contreras
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87k0nb77lq.fsf@evledraar.gmail.com \
--to=avarab@gmail.com \
--cc=dstolee@microsoft.com \
--cc=git@vger.kernel.org \
--cc=rybak.a.v@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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 NNTP newsgroup(s).