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