Merge branch 'nd/the-index' into md/list-objects-filter-by-depth
[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         statusHints::
34                 Show directions on how to proceed from the current
35                 state in the output of linkgit:git-status[1], in
36                 the template shown when writing commit messages in
37                 linkgit:git-commit[1], and in the help message shown
38                 by linkgit:git-checkout[1] when switching branch.
39         statusUoption::
40                 Advise to consider using the `-u` option to linkgit:git-status[1]
41                 when the command takes more than 2 seconds to enumerate untracked
42                 files.
43         commitBeforeMerge::
44                 Advice shown when linkgit:git-merge[1] refuses to
45                 merge to avoid overwriting local changes.
46         resetQuiet::
47                 Advice to consider using the `--quiet` option to linkgit:git-reset[1]
48                 when the command takes more than 2 seconds to enumerate unstaged
49                 changes after reset.
50         resolveConflict::
51                 Advice shown by various commands when conflicts
52                 prevent the operation from being performed.
53         implicitIdentity::
54                 Advice on how to set your identity configuration when
55                 your information is guessed from the system username and
56                 domain name.
57         detachedHead::
58                 Advice shown when you used linkgit:git-checkout[1] to
59                 move to the detach HEAD state, to instruct how to create
60                 a local branch after the fact.
61         checkoutAmbiguousRemoteBranchName::
62                 Advice shown when the argument to
63                 linkgit:git-checkout[1] ambiguously resolves to a
64                 remote tracking branch on more than one remote in
65                 situations where an unambiguous argument would have
66                 otherwise caused a remote-tracking branch to be
67                 checked out. See the `checkout.defaultRemote`
68                 configuration variable for how to set a given remote
69                 to used by default in some situations where this
70                 advice would be printed.
71         amWorkDir::
72                 Advice that shows the location of the patch file when
73                 linkgit:git-am[1] fails to apply it.
74         rmHints::
75                 In case of failure in the output of linkgit:git-rm[1],
76                 show directions on how to proceed from the current state.
77         addEmbeddedRepo::
78                 Advice on what to do when you've accidentally added one
79                 git repo inside of another.
80         ignoredHook::
81                 Advice shown if a hook is ignored because the hook is not
82                 set as executable.
83         waitingForEditor::
84                 Print a message to the terminal whenever Git is waiting for
85                 editor input from the user.
86 --