Raw
1 advice.*::
2 These variables control various optional help messages designed to
3 aid new users. When left unconfigured, Git will give the message
4 alongside instructions on how to squelch it. You can tell Git
5 that you have understood the issue and no longer need a specific
6 help message by setting the corresponding variable to `false`.
7 +
8 As they are intended to help human users, these messages are output to
9 the standard error. When tools that run Git as a subprocess find them
10 disruptive, they can set `GIT_ADVICE=0` in the environment to squelch
11 all advice messages.
12 +
13 --
14 addEmbeddedRepo::
15 Shown when the user accidentally adds one
16 git repo inside of another.
17 addEmptyPathspec::
18 Shown when the user runs `git add` without providing
19 the pathspec parameter.
20 addIgnoredFile::
21 Shown when the user attempts to add an ignored file to
22 the index.
23 amWorkDir::
24 Shown when linkgit:git-am[1] fails to apply a patch
25 file, to tell the user the location of the file.
26 ambiguousFetchRefspec::
27 Shown when a fetch refspec for multiple remotes maps to
28 the same remote-tracking branch namespace and causes branch
29 tracking set-up to fail.
30 checkoutAmbiguousRemoteBranchName::
31 Shown when the argument to
32 linkgit:git-checkout[1] and linkgit:git-switch[1]
33 ambiguously resolves to a
34 remote tracking branch on more than one remote in
35 situations where an unambiguous argument would have
36 otherwise caused a remote-tracking branch to be
37 checked out. See the `checkout.defaultRemote`
38 configuration variable for how to set a given remote
39 to be used by default in some situations where this
40 advice would be printed.
41 commitBeforeMerge::
42 Shown when linkgit:git-merge[1] refuses to
43 merge to avoid overwriting local changes.
44 detachedHead::
45 Shown when the user uses
46 linkgit:git-switch[1] or linkgit:git-checkout[1]
47 to move to the detached HEAD state, to tell the user how
48 to create a local branch after the fact.
49 diverging::
50 Shown when a fast-forward is not possible.
51 fetchRemoteHEADWarn::
52 Shown when linkgit:git-fetch[1] reveals that a remote `HEAD`
53 differs from what is set locally and the user has opted into
54 receiving a warning in this situation.
55 fetchShowForcedUpdates::
56 Shown when linkgit:git-fetch[1] takes a long time
57 to calculate forced updates after ref updates, or to warn
58 that the check is disabled.
59 forceDeleteBranch::
60 Shown when the user tries to delete a not fully merged
61 branch without the force option set.
62 ignoredHook::
63 Shown when a hook is ignored because the hook is not
64 set as executable.
65 implicitIdentity::
66 Shown when the user's information is guessed from the
67 system username and domain name, to tell the user how to
68 set their identity configuration.
69 mergeConflict::
70 Shown when various commands stop because of conflicts.
71 nestedTag::
72 Shown when a user attempts to recursively tag a tag object.
73 pushAlreadyExists::
74 Shown when linkgit:git-push[1] rejects an update that
75 does not qualify for fast-forwarding (e.g., a tag.)
76 pushFetchFirst::
77 Shown when linkgit:git-push[1] rejects an update that
78 tries to overwrite a remote ref that points at an
79 object we do not have.
80 pushNeedsForce::
81 Shown when linkgit:git-push[1] rejects an update that
82 tries to overwrite a remote ref that points at an
83 object that is not a commit-ish, or make the remote
84 ref point at an object that is not a commit-ish.
85 pushNonFFCurrent::
86 Shown when linkgit:git-push[1] fails due to a
87 non-fast-forward update to the current branch.
88 pushNonFFMatching::
89 Shown when the user ran linkgit:git-push[1] and pushed
90 "matching refs" explicitly (i.e. used `:`, or
91 specified a refspec that isn't the current branch) and
92 it resulted in a non-fast-forward error.
93 pushRefNeedsUpdate::
94 Shown when linkgit:git-push[1] rejects a forced update of
95 a branch when its remote-tracking ref has updates that we
96 do not have locally.
97 pushRepoLooksLikeRef::
98 Shown when the repository given to linkgit:git-push[1] is not
99 a configured remote but looks like a `<remote>/<branch>` ref,
100 suggesting that the remote and branch be given as separate
101 arguments.
102 pushUnqualifiedRefname::
103 Shown when linkgit:git-push[1] gives up trying to
104 guess based on the source and destination refs what
105 remote ref namespace the source belongs in, but where
106 we can still suggest that the user push to either
107 `refs/heads/*` or `refs/tags/*` based on the type of the
108 source object.
109 pushUpdateRejected::
110 Set this variable to `false` if you want to disable
111 `pushNonFFCurrent`, `pushNonFFMatching`, `pushAlreadyExists`,
112 `pushFetchFirst`, `pushNeedsForce`, and `pushRefNeedsUpdate`
113 simultaneously.
114 rebaseTodoError::
115 Shown when there is an error after editing the rebase todo list.
116 refSyntax::
117 Shown when the user provides an illegal ref name, to
118 tell the user about the ref syntax documentation.
119 resetNoRefresh::
120 Shown when linkgit:git-reset[1] takes more than 2
121 seconds to refresh the index after reset, to tell the user
122 that they can use the `--no-refresh` option.
123 resolveConflict::
124 Shown by various commands when conflicts
125 prevent the operation from being performed.
126 rmHints::
127 Shown on failure in the output of linkgit:git-rm[1], to
128 give directions on how to proceed from the current state.
129 sequencerInUse::
130 Shown when a sequencer command is already in progress.
131 skippedCherryPicks::
132 Shown when linkgit:git-rebase[1] skips a commit that has already
133 been cherry-picked onto the upstream branch.
134 sparseIndexExpanded::
135 Shown when a sparse index is expanded to a full index, which is likely
136 due to an unexpected set of files existing outside of the
137 sparse-checkout.
138 statusAheadBehind::
139 Shown when linkgit:git-status[1] computes the ahead/behind
140 counts for a local ref compared to its remote tracking ref,
141 and that calculation takes longer than expected. Will not
142 appear if `status.aheadBehind` is false or the option
143 `--no-ahead-behind` is given.
144 statusHints::
145 Show directions on how to proceed from the current
146 state in the output of linkgit:git-status[1], in
147 the template shown when writing commit messages in
148 linkgit:git-commit[1], and in the help message shown
149 by linkgit:git-switch[1] or
150 linkgit:git-checkout[1] when switching branches.
151 statusUoption::
152 Shown when linkgit:git-status[1] takes more than 2
153 seconds to enumerate untracked files, to tell the user that
154 they can use the `-u` option.
155 submoduleAlternateErrorStrategyDie::
156 Shown when a submodule.alternateErrorStrategy option
157 configured to "die" causes a fatal error.
158 submoduleMergeConflict::
159 Advice shown when a non-trivial submodule merge conflict is
160 encountered.
161 submodulesNotUpdated::
162 Shown when a user runs a submodule command that fails
163 because `git submodule update --init` was not run.
164 suggestDetachingHead::
165 Shown when linkgit:git-switch[1] refuses to detach HEAD
166 without the explicit `--detach` option.
167 updateSparsePath::
168 Shown when either linkgit:git-add[1] or linkgit:git-rm[1]
169 is asked to update index entries outside the current sparse
170 checkout.
171 waitingForEditor::
172 Shown when Git is waiting for editor input. Relevant
173 when e.g. the editor is not launched inside the terminal.
174 worktreeAddOrphan::
175 Shown when the user tries to create a worktree from an
176 invalid reference, to tell the user how to create a new unborn
177 branch instead.
178 --