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