Re: [PATCH] advice: recommend GIT_ADVICE=0 for tools
- From
Derrick Stolee <stolee@gmail.com>
- Date
- Sep 6, 2024, 19:49 UTC
- Message-ID
- <da98da07-b2f4-4608-9038-7ce4b8e2d74b@gmail.com>
- In-Reply-To
- <xmqq4j6t26fs.fsf@gitster.g>
On 9/5/24 4:26 PM, Junio C Hamano wrote:
Show 30 quoted lines
> This somehow makes it sounds like it is an "aside, by the way" that > these trigger by default and that you can selectively disable it by > setting these variables, but shouldn't the stress be the other way > around? Shouldn't the mention of GIT_ADVICE be a side note, leaving > primary text target human users? > > Perhaps like this? > > Thanks. > > Documentation/config/advice.txt | 8 +++++++- > Documentation/git.txt | 11 +++++++++++ > 2 files changed, 18 insertions(+), 1 deletion(-) > > diff --git c/Documentation/config/advice.txt w/Documentation/config/advice.txt > index 0ba8989820..d749aee7f4 100644 > --- c/Documentation/config/advice.txt > +++ w/Documentation/config/advice.txt > @@ -2,7 +2,13 @@ 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`: > + that you have understood the issue and no longer need a specific > + help message by setting the corresponding variable to `false`. > ++ > +As they are intended to help human users, these messages are output > +to the standard error. When tools that run Git as a subprocesses > +find them disruptive, they can set `GIT_ADVICE=0` in the environment > +to squelch all advice messages.
I like this a lot better. Your careful edit is substantial enough that I will give you co-authored-by in v2.
Thanks, -Stolee