Git fork
1advice.*::
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+
8As they are intended to help human users, these messages are output to
9the standard error. When tools that run Git as a subprocess find them
10disruptive, they can set `GIT_ADVICE=0` in the environment to squelch
11all 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 fetchShowForcedUpdates::
52 Shown when linkgit:git-fetch[1] takes a long time
53 to calculate forced updates after ref updates, or to warn
54 that the check is disabled.
55 forceDeleteBranch::
56 Shown when the user tries to delete a not fully merged
57 branch without the force option set.
58 ignoredHook::
59 Shown when a hook is ignored because the hook is not
60 set as executable.
61 implicitIdentity::
62 Shown when the user's information is guessed from the
63 system username and domain name, to tell the user how to
64 set their identity configuration.
65 mergeConflict::
66 Shown when various commands stop because of conflicts.
67 nestedTag::
68 Shown when a user attempts to recursively tag a tag object.
69 pushAlreadyExists::
70 Shown when linkgit:git-push[1] rejects an update that
71 does not qualify for fast-forwarding (e.g., a tag.)
72 pushFetchFirst::
73 Shown when linkgit:git-push[1] rejects an update that
74 tries to overwrite a remote ref that points at an
75 object we do not have.
76 pushNeedsForce::
77 Shown when linkgit:git-push[1] rejects an update that
78 tries to overwrite a remote ref that points at an
79 object that is not a commit-ish, or make the remote
80 ref point at an object that is not a commit-ish.
81 pushNonFFCurrent::
82 Shown when linkgit:git-push[1] fails due to a
83 non-fast-forward update to the current branch.
84 pushNonFFMatching::
85 Shown when the user ran linkgit:git-push[1] and pushed
86 "matching refs" explicitly (i.e. used `:`, or
87 specified a refspec that isn't the current branch) and
88 it resulted in a non-fast-forward error.
89 pushRefNeedsUpdate::
90 Shown when linkgit:git-push[1] rejects a forced update of
91 a branch when its remote-tracking ref has updates that we
92 do not have locally.
93 pushUnqualifiedRefname::
94 Shown when linkgit:git-push[1] gives up trying to
95 guess based on the source and destination refs what
96 remote ref namespace the source belongs in, but where
97 we can still suggest that the user push to either
98 `refs/heads/*` or `refs/tags/*` based on the type of the
99 source object.
100 pushUpdateRejected::
101 Set this variable to `false` if you want to disable
102 `pushNonFFCurrent`, `pushNonFFMatching`, `pushAlreadyExists`,
103 `pushFetchFirst`, `pushNeedsForce`, and `pushRefNeedsUpdate`
104 simultaneously.
105 rebaseTodoError::
106 Shown when there is an error after editing the rebase todo list.
107 refSyntax::
108 Shown when the user provides an illegal ref name, to
109 tell the user about the ref syntax documentation.
110 resetNoRefresh::
111 Shown when linkgit:git-reset[1] takes more than 2
112 seconds to refresh the index after reset, to tell the user
113 that they can use the `--no-refresh` option.
114 resolveConflict::
115 Shown by various commands when conflicts
116 prevent the operation from being performed.
117 rmHints::
118 Shown on failure in the output of linkgit:git-rm[1], to
119 give directions on how to proceed from the current state.
120 sequencerInUse::
121 Shown when a sequencer command is already in progress.
122 skippedCherryPicks::
123 Shown when linkgit:git-rebase[1] skips a commit that has already
124 been cherry-picked onto the upstream branch.
125 sparseIndexExpanded::
126 Shown when a sparse index is expanded to a full index, which is likely
127 due to an unexpected set of files existing outside of the
128 sparse-checkout.
129 statusAheadBehind::
130 Shown when linkgit:git-status[1] computes the ahead/behind
131 counts for a local ref compared to its remote tracking ref,
132 and that calculation takes longer than expected. Will not
133 appear if `status.aheadBehind` is false or the option
134 `--no-ahead-behind` is given.
135 statusHints::
136 Show directions on how to proceed from the current
137 state in the output of linkgit:git-status[1], in
138 the template shown when writing commit messages in
139 linkgit:git-commit[1], and in the help message shown
140 by linkgit:git-switch[1] or
141 linkgit:git-checkout[1] when switching branches.
142 statusUoption::
143 Shown when linkgit:git-status[1] takes more than 2
144 seconds to enumerate untracked files, to tell the user that
145 they can use the `-u` option.
146 submoduleAlternateErrorStrategyDie::
147 Shown when a submodule.alternateErrorStrategy option
148 configured to "die" causes a fatal error.
149 submoduleMergeConflict::
150 Advice shown when a non-trivial submodule merge conflict is
151 encountered.
152 submodulesNotUpdated::
153 Shown when a user runs a submodule command that fails
154 because `git submodule update --init` was not run.
155 suggestDetachingHead::
156 Shown when linkgit:git-switch[1] refuses to detach HEAD
157 without the explicit `--detach` option.
158 updateSparsePath::
159 Shown when either linkgit:git-add[1] or linkgit:git-rm[1]
160 is asked to update index entries outside the current sparse
161 checkout.
162 waitingForEditor::
163 Shown when Git is waiting for editor input. Relevant
164 when e.g. the editor is not launched inside the terminal.
165 worktreeAddOrphan::
166 Shown when the user tries to create a worktree from an
167 invalid reference, to tell the user how to create a new unborn
168 branch instead.
169--