From: Felipe Contreras <felipe.contreras@gmail.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"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 13:03:24 -0500 [thread overview]
Message-ID: <60b9196c238c_2588012081d@natae.notmuch> (raw)
In-Reply-To: <87h7if74vd.fsf@evledraar.gmail.com>
Ævar Arnfjörð Bjarmason wrote:
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -299,9 +299,8 @@ pathname::
> is expanded to the value of `$HOME`, and `~user/` to the
> specified user's home directory.
>
> -
> -Variables
> -~~~~~~~~~
> +CONFIGURATION VARIABLES
> +-----------------------
>
> Note that this list is non-comprehensive and not necessarily complete.
> For command-specific variables, you will find a more detailed description
> @@ -312,10 +311,24 @@ inventing new variables for use in your own tool, make sure their
> names do not conflict with those that are used by Git itself and
> other popular tools, and describe them in your documentation.
>
> +
> +advice.*
> +~~~~~~~~
> +
> +These variables control various optional help messages designed to aid
> +new users. All 'advice.*' variables default to 'true', and you can
> +tell Git that you do not need help by setting these to 'false':
> +
> include::config/advice.txt[]
>
> +core.*
> +~~~~~~
> +
> include::config/core.txt[]
>
> +add.*
> +~~~~~
> +
> include::config/add.txt[]
This looks much better to me. +1
> include::config/alias.txt[]
> diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt
> index 8b2849ff7b3..35d6b0e20ff 100644
> --- a/Documentation/config/advice.txt
> +++ b/Documentation/config/advice.txt
> @@ -1,126 +1,119 @@
> -advice.*::
> - These variables control various optional help messages designed to
> - aid new users. All 'advice.*' variables default to 'true', and you
> - can tell Git that you do not need help by setting these to 'false':
> -+
> ---
...
> ---
> +advice.*fetchShowForcedUpdates::
> + Advice shown when linkgit:git-fetch[1] takes a long time
> + to calculate forced updates after ref updates, or to warn
> + that the check is disabled.
> +advice.pushUpdateRejected::
> + Set this variable to 'false' if you want to disable
> + 'pushNonFFCurrent', 'pushNonFFMatching', 'pushAlreadyExists',
> + 'pushFetchFirst', 'pushNeedsForce', and 'pushRefNeedsUpdate'
> + simultaneously.
> +advice.pushNonFFCurrent::
> + Advice shown when linkgit:git-push[1] fails due to a
> + non-fast-forward update to the current branch.
> +advice.pushNonFFMatching::
> + Advice shown when you ran linkgit:git-push[1] and pushed
> + 'matching refs' explicitly (i.e. you used ':', or
> + specified a refspec that isn't your current branch) and
> + it resulted in a non-fast-forward error.
> +advice.pushAlreadyExists::
> + Shown when linkgit:git-push[1] rejects an update that
> + does not qualify for fast-forwarding (e.g., a tag.)
> +pushFetchFirst::
I presume this also has the 'advice.' prefix added (and so do the rest),
it was just an example patch.
Cheers.
--
Felipe Contreras
prev parent reply other threads:[~2021-06-03 18: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
2021-06-03 7:43 ` Ævar Arnfjörð Bjarmason
2021-06-03 18:03 ` Felipe Contreras [this message]
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=60b9196c238c_2588012081d@natae.notmuch \
--to=felipe.contreras@gmail.com \
--cc=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).