Documentation/config/advice.txt

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