Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

advice: recommend GIT_ADVICE=0 for tools #1781

Closed
wants to merge 1 commit into from
Closed

advice: recommend GIT_ADVICE=0 for tools #1781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Documentation/config/advice.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
11 changes: 11 additions & 0 deletions Documentation/git.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
------------------------

Expand Down
Loading