| 1 | advice.*:: |
| 2 | These variables control various optional help messages designed to |
| 3 | aid new users. When left unconfigured, Git will give the message |
| 4 | alongside instructions on how to squelch it. You can tell Git |
| 5 | that you have understood the issue and no longer need a specific |
| 6 | help message by setting the corresponding variable to `false`. |
| 7 | + |
| 8 | As they are intended to help human users, these messages are output to |
| 9 | the standard error. When tools that run Git as a subprocess find them |
| 10 | disruptive, they can set `GIT_ADVICE=0` in the environment to squelch |
| 11 | all advice messages. |
| 12 | + |
| 13 | -- |
| 14 | addEmbeddedRepo:: |
| 15 | Shown when the user accidentally adds one |
| 16 | git repo inside of another. |
| 17 | addEmptyPathspec:: |
| 18 | Shown when the user runs `git add` without providing |
| 19 | the pathspec parameter. |
| 20 | addIgnoredFile:: |
| 21 | Shown when the user attempts to add an ignored file to |
| 22 | the index. |
| 23 | amWorkDir:: |
| 24 | Shown when linkgit:git-am[1] fails to apply a patch |
| 25 | file, to tell the user the location of the file. |
| 26 | ambiguousFetchRefspec:: |
| 27 | Shown when a fetch refspec for multiple remotes maps to |
| 28 | the same remote-tracking branch namespace and causes branch |
| 29 | tracking set-up to fail. |
| 30 | checkoutAmbiguousRemoteBranchName:: |
| 31 | Shown when the argument to |
| 32 | linkgit:git-checkout[1] and linkgit:git-switch[1] |
| 33 | ambiguously resolves to a |
| 34 | remote tracking branch on more than one remote in |
| 35 | situations where an unambiguous argument would have |
| 36 | otherwise caused a remote-tracking branch to be |
| 37 | checked out. See the `checkout.defaultRemote` |
| 38 | configuration variable for how to set a given remote |
| 39 | to be used by default in some situations where this |
| 40 | advice would be printed. |
| 41 | commitBeforeMerge:: |
| 42 | Shown when linkgit:git-merge[1] refuses to |
| 43 | merge to avoid overwriting local changes. |
| 44 | detachedHead:: |
| 45 | Shown when the user uses |
| 46 | linkgit:git-switch[1] or linkgit:git-checkout[1] |
| 47 | to move to the detached HEAD state, to tell the user how |
| 48 | to create a local branch after the fact. |
| 49 | diverging:: |
| 50 | Shown when a fast-forward is not possible. |
| 51 | fetchRemoteHEADWarn:: |
| 52 | Shown when linkgit:git-fetch[1] reveals that a remote `HEAD` |
| 53 | differs from what is set locally and the user has opted into |
| 54 | receiving a warning in this situation. |
| 55 | fetchShowForcedUpdates:: |
| 56 | Shown when linkgit:git-fetch[1] takes a long time |
| 57 | to calculate forced updates after ref updates, or to warn |
| 58 | that the check is disabled. |
| 59 | forceDeleteBranch:: |
| 60 | Shown when the user tries to delete a not fully merged |
| 61 | branch without the force option set. |
| 62 | historyUpdateRefs:: |
| 63 | Shown when `git history squash` refuses because a ref points |
| 64 | into the range being folded, to tell the user about |
| 65 | `--update-refs=head`. |
| 66 | ignoredHook:: |
| 67 | Shown when a hook is ignored because the hook is not |
| 68 | set as executable. |
| 69 | implicitIdentity:: |
| 70 | Shown when the user's information is guessed from the |
| 71 | system username and domain name, to tell the user how to |
| 72 | set their identity configuration. |
| 73 | mergeConflict:: |
| 74 | Shown when various commands stop because of conflicts. |
| 75 | nestedTag:: |
| 76 | Shown when a user attempts to recursively tag a tag object. |
| 77 | pushAlreadyExists:: |
| 78 | Shown when linkgit:git-push[1] rejects an update that |
| 79 | does not qualify for fast-forwarding (e.g., a tag.) |
| 80 | pushFetchFirst:: |
| 81 | Shown when linkgit:git-push[1] rejects an update that |
| 82 | tries to overwrite a remote ref that points at an |
| 83 | object we do not have. |
| 84 | pushNeedsForce:: |
| 85 | Shown when linkgit:git-push[1] rejects an update that |
| 86 | tries to overwrite a remote ref that points at an |
| 87 | object that is not a commit-ish, or make the remote |
| 88 | ref point at an object that is not a commit-ish. |
| 89 | pushNonFFCurrent:: |
| 90 | Shown when linkgit:git-push[1] fails due to a |
| 91 | non-fast-forward update to the current branch. |
| 92 | pushNonFFMatching:: |
| 93 | Shown when the user ran linkgit:git-push[1] and pushed |
| 94 | "matching refs" explicitly (i.e. used `:`, or |
| 95 | specified a refspec that isn't the current branch) and |
| 96 | it resulted in a non-fast-forward error. |
| 97 | pushRefNeedsUpdate:: |
| 98 | Shown when linkgit:git-push[1] rejects a forced update of |
| 99 | a branch when its remote-tracking ref has updates that we |
| 100 | do not have locally. |
| 101 | pushRepoLooksLikeRef:: |
| 102 | Shown when the repository given to linkgit:git-push[1] is not |
| 103 | a configured remote but looks like a `<remote>/<branch>` ref, |
| 104 | suggesting that the remote and branch be given as separate |
| 105 | arguments. |
| 106 | pushUnqualifiedRefname:: |
| 107 | Shown when linkgit:git-push[1] gives up trying to |
| 108 | guess based on the source and destination refs what |
| 109 | remote ref namespace the source belongs in, but where |
| 110 | we can still suggest that the user push to either |
| 111 | `refs/heads/*` or `refs/tags/*` based on the type of the |
| 112 | source object. |
| 113 | pushUpdateRejected:: |
| 114 | Set this variable to `false` if you want to disable |
| 115 | `pushNonFFCurrent`, `pushNonFFMatching`, `pushAlreadyExists`, |
| 116 | `pushFetchFirst`, `pushNeedsForce`, and `pushRefNeedsUpdate` |
| 117 | simultaneously. |
| 118 | rebaseTodoError:: |
| 119 | Shown when there is an error after editing the rebase todo list. |
| 120 | refSyntax:: |
| 121 | Shown when the user provides an illegal ref name, to |
| 122 | tell the user about the ref syntax documentation. |
| 123 | resetNoRefresh:: |
| 124 | Shown when linkgit:git-reset[1] takes more than 2 |
| 125 | seconds to refresh the index after reset, to tell the user |
| 126 | that they can use the `--no-refresh` option. |
| 127 | resolveConflict:: |
| 128 | Shown by various commands when conflicts |
| 129 | prevent the operation from being performed. |
| 130 | rmHints:: |
| 131 | Shown on failure in the output of linkgit:git-rm[1], to |
| 132 | give directions on how to proceed from the current state. |
| 133 | sequencerInUse:: |
| 134 | Shown when a sequencer command is already in progress. |
| 135 | skippedCherryPicks:: |
| 136 | Shown when linkgit:git-rebase[1] skips a commit that has already |
| 137 | been cherry-picked onto the upstream branch. |
| 138 | sparseIndexExpanded:: |
| 139 | Shown when a sparse index is expanded to a full index, which is likely |
| 140 | due to an unexpected set of files existing outside of the |
| 141 | sparse-checkout. |
| 142 | statusAheadBehind:: |
| 143 | Shown when linkgit:git-status[1] computes the ahead/behind |
| 144 | counts for a local ref compared to its remote tracking ref, |
| 145 | and that calculation takes longer than expected. Will not |
| 146 | appear if `status.aheadBehind` is false or the option |
| 147 | `--no-ahead-behind` is given. |
| 148 | statusHints:: |
| 149 | Show directions on how to proceed from the current |
| 150 | state in the output of linkgit:git-status[1], in |
| 151 | the template shown when writing commit messages in |
| 152 | linkgit:git-commit[1], and in the help message shown |
| 153 | by linkgit:git-switch[1] or |
| 154 | linkgit:git-checkout[1] when switching branches. |
| 155 | statusUoption:: |
| 156 | Shown when linkgit:git-status[1] takes more than 2 |
| 157 | seconds to enumerate untracked files, to tell the user that |
| 158 | they can use the `-u` option. |
| 159 | submoduleAlternateErrorStrategyDie:: |
| 160 | Shown when a submodule.alternateErrorStrategy option |
| 161 | configured to "die" causes a fatal error. |
| 162 | submoduleMergeConflict:: |
| 163 | Advice shown when a non-trivial submodule merge conflict is |
| 164 | encountered. |
| 165 | submodulesNotUpdated:: |
| 166 | Shown when a user runs a submodule command that fails |
| 167 | because `git submodule update --init` was not run. |
| 168 | suggestDetachingHead:: |
| 169 | Shown when linkgit:git-switch[1] refuses to detach HEAD |
| 170 | without the explicit `--detach` option. |
| 171 | updateSparsePath:: |
| 172 | Shown when either linkgit:git-add[1] or linkgit:git-rm[1] |
| 173 | is asked to update index entries outside the current sparse |
| 174 | checkout. |
| 175 | waitingForEditor:: |
| 176 | Shown when Git is waiting for editor input. Relevant |
| 177 | when e.g. the editor is not launched inside the terminal. |
| 178 | worktreeAddOrphan:: |
| 179 | Shown when the user tries to create a worktree from an |
| 180 | invalid reference, to tell the user how to create a new unborn |
| 181 | branch instead. |
| 182 | -- |