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