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         nestedTag::
  60                 Shown when a user attempts to recursively tag a tag object.
  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.
  73         pushNonFFCurrent::
  74                 Shown when linkgit:git-push[1] fails due to a
  75                 non-fast-forward update to the current branch.
  76         pushNonFFMatching::
  77                 Shown when the user ran linkgit:git-push[1] and pushed
  78                 "matching refs" explicitly (i.e. used `:`, or
  79                 specified a refspec that isn't the current branch) and
  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.
  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
  90                 `refs/heads/*` or `refs/tags/*` based on the type of the
  91                 source object.
  92         pushUpdateRejected::
  93                 Set this variable to `false` if you want to disable
  94                 `pushNonFFCurrent`, `pushNonFFMatching`, `pushAlreadyExists`,
  95                 `pushFetchFirst`, `pushNeedsForce`, and `pushRefNeedsUpdate`
  96                 simultaneously.
  97         refSyntax::
  98                 Shown when the user provides an illegal ref name, to
  99                 tell the user about the ref syntax documentation.
 100         resetNoRefresh::
 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.
 104         resolveConflict::
 105                 Shown by various commands when conflicts
 106                 prevent the operation from being performed.
 107         rmHints::
 108                 Shown on failure in the output of linkgit:git-rm[1], to
 109                 give directions on how to proceed from the current state.
 110         sequencerInUse::
 111                 Shown when a sequencer command is already in progress.
 112         skippedCherryPicks::
 113                 Shown when linkgit:git-rebase[1] skips a commit that has already
 114                 been cherry-picked onto the upstream branch.
 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.
 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
 126                 by linkgit:git-switch[1] or
 127                 linkgit:git-checkout[1] when switching branches.
 128         statusUoption::
 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.
 132         submoduleAlternateErrorStrategyDie::
 133                 Shown when a submodule.alternateErrorStrategy option
 134                 configured to "die" causes a fatal error.
 135         submodulesNotUpdated::
 136                 Shown when a user runs a submodule command that fails
 137                 because `git submodule update --init` was not run.
 138         suggestDetachingHead::
 139                 Shown when linkgit:git-switch[1] refuses to detach HEAD
 140                 without the explicit `--detach` option.
 141         updateSparsePath::
 142                 Shown when either linkgit:git-add[1] or linkgit:git-rm[1]
 143                 is asked to update index entries outside the current sparse
 144                 checkout.
 145         waitingForEditor::
 146                 Shown when Git is waiting for editor input. Relevant
 147                 when e.g. the editor is not launched inside the terminal.
 148         worktreeAddOrphan::
 149                 Shown when the user tries to create a worktree from an
 150                 invalid reference, to tell the user how to create a new unborn
 151                 branch instead.
 152 --