]> git.ipfire.org Git - thirdparty/git.git/blob - Documentation/config/advice.txt
Merge branch 'sd/negotiate-trace-fix' into maint-2.43
[thirdparty/git.git] / Documentation / config / advice.txt
1 advice.*::
2 These variables control various optional help messages designed to
3 aid new users. All 'advice.*' variables default to 'true', and you
4 can tell Git that you do not need help by setting these to 'false':
5 +
6 --
7 ambiguousFetchRefspec::
8 Advice shown when a fetch refspec for multiple remotes maps to
9 the same remote-tracking branch namespace and causes branch
10 tracking set-up to fail.
11 fetchShowForcedUpdates::
12 Advice shown when linkgit:git-fetch[1] takes a long time
13 to calculate forced updates after ref updates, or to warn
14 that the check is disabled.
15 pushUpdateRejected::
16 Set this variable to 'false' if you want to disable
17 'pushNonFFCurrent', 'pushNonFFMatching', 'pushAlreadyExists',
18 'pushFetchFirst', 'pushNeedsForce', and 'pushRefNeedsUpdate'
19 simultaneously.
20 pushNonFFCurrent::
21 Advice shown when linkgit:git-push[1] fails due to a
22 non-fast-forward update to the current branch.
23 pushNonFFMatching::
24 Advice shown when you ran linkgit:git-push[1] and pushed
25 'matching refs' explicitly (i.e. you used ':', or
26 specified a refspec that isn't your current branch) and
27 it resulted in a non-fast-forward error.
28 pushAlreadyExists::
29 Shown when linkgit:git-push[1] rejects an update that
30 does not qualify for fast-forwarding (e.g., a tag.)
31 pushFetchFirst::
32 Shown when linkgit:git-push[1] rejects an update that
33 tries to overwrite a remote ref that points at an
34 object we do not have.
35 pushNeedsForce::
36 Shown when linkgit:git-push[1] rejects an update that
37 tries to overwrite a remote ref that points at an
38 object that is not a commit-ish, or make the remote
39 ref point at an object that is not a commit-ish.
40 pushUnqualifiedRefname::
41 Shown when linkgit:git-push[1] gives up trying to
42 guess based on the source and destination refs what
43 remote ref namespace the source belongs in, but where
44 we can still suggest that the user push to either
45 refs/heads/* or refs/tags/* based on the type of the
46 source object.
47 pushRefNeedsUpdate::
48 Shown when linkgit:git-push[1] rejects a forced update of
49 a branch when its remote-tracking ref has updates that we
50 do not have locally.
51 skippedCherryPicks::
52 Shown when linkgit:git-rebase[1] skips a commit that has already
53 been cherry-picked onto the upstream branch.
54 statusAheadBehind::
55 Shown when linkgit:git-status[1] computes the ahead/behind
56 counts for a local ref compared to its remote tracking ref,
57 and that calculation takes longer than expected. Will not
58 appear if `status.aheadBehind` is false or the option
59 `--no-ahead-behind` is given.
60 statusHints::
61 Show directions on how to proceed from the current
62 state in the output of linkgit:git-status[1], in
63 the template shown when writing commit messages in
64 linkgit:git-commit[1], and in the help message shown
65 by linkgit:git-switch[1] or
66 linkgit:git-checkout[1] when switching branches.
67 statusUoption::
68 Advise to consider using the `-u` option to linkgit:git-status[1]
69 when the command takes more than 2 seconds to enumerate untracked
70 files.
71 commitBeforeMerge::
72 Advice shown when linkgit:git-merge[1] refuses to
73 merge to avoid overwriting local changes.
74 resetNoRefresh::
75 Advice to consider using the `--no-refresh` option to
76 linkgit:git-reset[1] when the command takes more than 2 seconds
77 to refresh the index after reset.
78 resolveConflict::
79 Advice shown by various commands when conflicts
80 prevent the operation from being performed.
81 sequencerInUse::
82 Advice shown when a sequencer command is already in progress.
83 implicitIdentity::
84 Advice on how to set your identity configuration when
85 your information is guessed from the system username and
86 domain name.
87 detachedHead::
88 Advice shown when you used
89 linkgit:git-switch[1] or linkgit:git-checkout[1]
90 to move to the detached HEAD state, to instruct how to
91 create a local branch after the fact.
92 suggestDetachingHead::
93 Advice shown when linkgit:git-switch[1] refuses to detach HEAD
94 without the explicit `--detach` option.
95 checkoutAmbiguousRemoteBranchName::
96 Advice shown when the argument to
97 linkgit:git-checkout[1] and linkgit:git-switch[1]
98 ambiguously resolves to a
99 remote tracking branch on more than one remote in
100 situations where an unambiguous argument would have
101 otherwise caused a remote-tracking branch to be
102 checked out. See the `checkout.defaultRemote`
103 configuration variable for how to set a given remote
104 to be used by default in some situations where this
105 advice would be printed.
106 amWorkDir::
107 Advice that shows the location of the patch file when
108 linkgit:git-am[1] fails to apply it.
109 rmHints::
110 In case of failure in the output of linkgit:git-rm[1],
111 show directions on how to proceed from the current state.
112 addEmbeddedRepo::
113 Advice on what to do when you've accidentally added one
114 git repo inside of another.
115 ignoredHook::
116 Advice shown if a hook is ignored because the hook is not
117 set as executable.
118 waitingForEditor::
119 Print a message to the terminal whenever Git is waiting for
120 editor input from the user.
121 nestedTag::
122 Advice shown if a user attempts to recursively tag a tag object.
123 submoduleAlternateErrorStrategyDie::
124 Advice shown when a submodule.alternateErrorStrategy option
125 configured to "die" causes a fatal error.
126 submodulesNotUpdated::
127 Advice shown when a user runs a submodule command that fails
128 because `git submodule update --init` was not run.
129 addIgnoredFile::
130 Advice shown if a user attempts to add an ignored file to
131 the index.
132 addEmptyPathspec::
133 Advice shown if a user runs the add command without providing
134 the pathspec parameter.
135 updateSparsePath::
136 Advice shown when either linkgit:git-add[1] or linkgit:git-rm[1]
137 is asked to update index entries outside the current sparse
138 checkout.
139 diverging::
140 Advice shown when a fast-forward is not possible.
141 worktreeAddOrphan::
142 Advice shown when a user tries to create a worktree from an
143 invalid reference, to instruct how to create a new unborn
144 branch instead.
145 --