mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

advice: recommend GIT_ADVICE=0 for tools

Browse Source 
The GIT_ADVICE environment variable was added implicitly in b79deeb554
(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.

Co-authored-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Derrick Stolee <stolee@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Derrick Stolee
2024-09-06 20:22:35 +00:00
committed by Junio C Hamano
parent 2e7b89e038
commit fb2b9815a4
2 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/config/advice.txt
View File

@ -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 subprocess find them
disruptive, they can set `GIT_ADVICE=0` in the environment to squelch
all advice messages.
+
--
addEmbeddedRepo::

11
Documentation/git.txt
View File

@ -1027,6 +1027,17 @@ standard output.
adequate and support for it is likely to be removed in the
foreseeable future (along with the variable).
`GIT_ADVICE`::
If set to `0`, then disable all advice messages. These messages are
intended to provide hints to human users that may help them get out of
problematic situations or take advantage of new features. Users can
disable individual messages using the `advice.*` config keys. These
messages may be disruptive to tools that execute Git processes, so this
variable is available to disable the messages. (The `--no-advice`
global option is also available, but old Git versions may fail when
this option is not understood. The environment variable will be ignored
by Git versions that do not understand it.)
Discussion[[Discussion]]
------------------------