Re: [PATCH] advice: recommend GIT_ADVICE=0 for tools
- From
Eric Sunshine <sunshine@sunshineco.com>
- Date
- Sep 5, 2024, 18:02 UTC
- Message-ID
- <CAPig+cSGry+QMpkkiJb8A94w1M+J_5beEKaT-xrGeL34xME4hA@mail.gmail.com>
- In-Reply-To
- <pull.1781.git.1725559154387.gitgitgadget@gmail.com>
On Thu, Sep 5, 2024 at 1:59 PM Derrick Stolee via GitGitGadget <gitgitgadget@gmail.com> wrote:
Show 20 quoted lines
> The GIT_ADVICE environment variable was added implicitly in b79deeb5544 > (advice: add --no-advice global option, 2024-05-03) but was not > documented. Add documentation to show that it is an option for tools > that want to disable these messages. Make note that while the > --no-advice option exists, older Git versions will fail to parse that > option. The environment variable presents a way to change the behavior > of Git versions that understand it without disrupting older versions. > > Signed-off-by: Derrick Stolee <stolee@gmail.com> > --- > diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt > @@ -1,8 +1,12 @@ > advice.*:: > These variables control various optional help messages designed to > - aid new users. When left unconfigured, Git will give the message > - alongside instructions on how to squelch it. You can tell Git > - that you do not need the help message by setting these to `false`: > + aid new users. These are output to `stderr` by default as they are > + intended to help human readers. Tools that execute Git as a subprocess > + can disable these messages by setting `GIT_ACVICE=0` in the environment.
s/GIT_ACVICE/GIT_ADVICE/