Merge branch 'jh/status-aheadbehind'
[git/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 pushUpdateRejected::
8 Set this variable to 'false' if you want to disable
9 'pushNonFFCurrent',
10 'pushNonFFMatching', 'pushAlreadyExists',
11 'pushFetchFirst', and 'pushNeedsForce'
12 simultaneously.
13 pushNonFFCurrent::
14 Advice shown when linkgit:git-push[1] fails due to a
15 non-fast-forward update to the current branch.
16 pushNonFFMatching::
17 Advice shown when you ran linkgit:git-push[1] and pushed
18 'matching refs' explicitly (i.e. you used ':', or
19 specified a refspec that isn't your current branch) and
20 it resulted in a non-fast-forward error.
21 pushAlreadyExists::
22 Shown when linkgit:git-push[1] rejects an update that
23 does not qualify for fast-forwarding (e.g., a tag.)
24 pushFetchFirst::
25 Shown when linkgit:git-push[1] rejects an update that
26 tries to overwrite a remote ref that points at an
27 object we do not have.
28 pushNeedsForce::
29 Shown when linkgit:git-push[1] rejects an update that
30 tries to overwrite a remote ref that points at an
31 object that is not a commit-ish, or make the remote
32 ref point at an object that is not a commit-ish.
33 pushUnqualifiedRefname::
34 Shown when linkgit:git-push[1] gives up trying to
35 guess based on the source and destination refs what
36 remote ref namespace the source belongs in, but where
37 we can still suggest that the user push to either
38 refs/heads/* or refs/tags/* based on the type of the
39 source object.
40 statusAheadBehind::
41 Shown when linkgit:git-status[1] computes the ahead/behind
42 counts for a local ref compared to its remote tracking ref,
43 and that calculation takes longer than expected. Will not
44 appear if `status.aheadBehind` is false or the option
45 `--no-ahead-behind` is given.
46 statusHints::
47 Show directions on how to proceed from the current
48 state in the output of linkgit:git-status[1], in
49 the template shown when writing commit messages in
50 linkgit:git-commit[1], and in the help message shown
51 by linkgit:git-switch[1] or
52 linkgit:git-checkout[1] when switching branch.
53 statusUoption::
54 Advise to consider using the `-u` option to linkgit:git-status[1]
55 when the command takes more than 2 seconds to enumerate untracked
56 files.
57 commitBeforeMerge::
58 Advice shown when linkgit:git-merge[1] refuses to
59 merge to avoid overwriting local changes.
60 resetQuiet::
61 Advice to consider using the `--quiet` option to linkgit:git-reset[1]
62 when the command takes more than 2 seconds to enumerate unstaged
63 changes after reset.
64 resolveConflict::
65 Advice shown by various commands when conflicts
66 prevent the operation from being performed.
67 implicitIdentity::
68 Advice on how to set your identity configuration when
69 your information is guessed from the system username and
70 domain name.
71 detachedHead::
72 Advice shown when you used
73 linkgit:git-switch[1] or linkgit:git-checkout[1]
74 to move to the detach HEAD state, to instruct how to
75 create a local branch after the fact.
76 checkoutAmbiguousRemoteBranchName::
77 Advice shown when the argument to
78 linkgit:git-checkout[1] and linkgit:git-switch[1]
79 ambiguously resolves to a
80 remote tracking branch on more than one remote in
81 situations where an unambiguous argument would have
82 otherwise caused a remote-tracking branch to be
83 checked out. See the `checkout.defaultRemote`
84 configuration variable for how to set a given remote
85 to used by default in some situations where this
86 advice would be printed.
87 amWorkDir::
88 Advice that shows the location of the patch file when
89 linkgit:git-am[1] fails to apply it.
90 rmHints::
91 In case of failure in the output of linkgit:git-rm[1],
92 show directions on how to proceed from the current state.
93 addEmbeddedRepo::
94 Advice on what to do when you've accidentally added one
95 git repo inside of another.
96 ignoredHook::
97 Advice shown if a hook is ignored because the hook is not
98 set as executable.
99 waitingForEditor::
100 Print a message to the terminal whenever Git is waiting for
101 editor input from the user.
102 nestedTag::
103 Advice shown if a user attempts to recursively tag a tag object.
104 --