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         addEmbeddedRepo::
   8                 Advice on what to do when you've accidentally added one
   9                 git repo inside of another.
  10         addEmptyPathspec::
  11                 Advice shown if a user runs the add command without providing
  12                 the pathspec parameter.
  13         addIgnoredFile::
  14                 Advice shown if a user attempts to add an ignored file to
  15                 the index.
  16         amWorkDir::
  17                 Advice that shows the location of the patch file when
  18                 linkgit:git-am[1] fails to apply it.
  19         ambiguousFetchRefspec::
  20                 Advice shown when a fetch refspec for multiple remotes maps to
  21                 the same remote-tracking branch namespace and causes branch
  22                 tracking set-up to fail.
  23         checkoutAmbiguousRemoteBranchName::
  24                 Advice shown when the argument to
  25                 linkgit:git-checkout[1] and linkgit:git-switch[1]
  26                 ambiguously resolves to a
  27                 remote tracking branch on more than one remote in
  28                 situations where an unambiguous argument would have
  29                 otherwise caused a remote-tracking branch to be
  30                 checked out. See the `checkout.defaultRemote`
  31                 configuration variable for how to set a given remote
  32                 to be used by default in some situations where this
  33                 advice would be printed.
  34         commitBeforeMerge::
  35                 Advice shown when linkgit:git-merge[1] refuses to
  36                 merge to avoid overwriting local changes.
  37         detachedHead::
  38                 Advice shown when you used
  39                 linkgit:git-switch[1] or linkgit:git-checkout[1]
  40                 to move to the detached HEAD state, to instruct how to
  41                 create a local branch after the fact.
  42         diverging::
  43                 Advice shown when a fast-forward is not possible.
  44         fetchShowForcedUpdates::
  45                 Advice shown when linkgit:git-fetch[1] takes a long time
  46                 to calculate forced updates after ref updates, or to warn
  47                 that the check is disabled.
  48         ignoredHook::
  49                 Advice shown if a hook is ignored because the hook is not
  50                 set as executable.
  51         implicitIdentity::
  52                 Advice on how to set your identity configuration when
  53                 your information is guessed from the system username and
  54                 domain name.
  55         nestedTag::
  56                 Advice shown if a user attempts to recursively tag a tag object.
  57         pushAlreadyExists::
  58                 Shown when linkgit:git-push[1] rejects an update that
  59                 does not qualify for fast-forwarding (e.g., a tag.)
  60         pushFetchFirst::
  61                 Shown when linkgit:git-push[1] rejects an update that
  62                 tries to overwrite a remote ref that points at an
  63                 object we do not have.
  64         pushNeedsForce::
  65                 Shown when linkgit:git-push[1] rejects an update that
  66                 tries to overwrite a remote ref that points at an
  67                 object that is not a commit-ish, or make the remote
  68                 ref point at an object that is not a commit-ish.
  69         pushNonFFCurrent::
  70                 Advice shown when linkgit:git-push[1] fails due to a
  71                 non-fast-forward update to the current branch.
  72         pushNonFFMatching::
  73                 Advice shown when you ran linkgit:git-push[1] and pushed
  74                 'matching refs' explicitly (i.e. you used ':', or
  75                 specified a refspec that isn't your current branch) and
  76                 it resulted in a non-fast-forward error.
  77         pushRefNeedsUpdate::
  78                 Shown when linkgit:git-push[1] rejects a forced update of
  79                 a branch when its remote-tracking ref has updates that we
  80                 do not have locally.
  81         pushUnqualifiedRefname::
  82                 Shown when linkgit:git-push[1] gives up trying to
  83                 guess based on the source and destination refs what
  84                 remote ref namespace the source belongs in, but where
  85                 we can still suggest that the user push to either
  86                 refs/heads/* or refs/tags/* based on the type of the
  87                 source object.
  88         pushUpdateRejected::
  89                 Set this variable to 'false' if you want to disable
  90                 'pushNonFFCurrent', 'pushNonFFMatching', 'pushAlreadyExists',
  91                 'pushFetchFirst', 'pushNeedsForce', and 'pushRefNeedsUpdate'
  92                 simultaneously.
  93         resetNoRefresh::
  94                 Advice to consider using the `--no-refresh` option to
  95                 linkgit:git-reset[1] when the command takes more than 2 seconds
  96                 to refresh the index after reset.
  97         resolveConflict::
  98                 Advice shown by various commands when conflicts
  99                 prevent the operation from being performed.
 100         rmHints::
 101                 In case of failure in the output of linkgit:git-rm[1],
 102                 show directions on how to proceed from the current state.
 103         sequencerInUse::
 104                 Advice shown when a sequencer command is already in progress.
 105         skippedCherryPicks::
 106                 Shown when linkgit:git-rebase[1] skips a commit that has already
 107                 been cherry-picked onto the upstream branch.
 108         statusAheadBehind::
 109                 Shown when linkgit:git-status[1] computes the ahead/behind
 110                 counts for a local ref compared to its remote tracking ref,
 111                 and that calculation takes longer than expected. Will not
 112                 appear if `status.aheadBehind` is false or the option
 113                 `--no-ahead-behind` is given.
 114         statusHints::
 115                 Show directions on how to proceed from the current
 116                 state in the output of linkgit:git-status[1], in
 117                 the template shown when writing commit messages in
 118                 linkgit:git-commit[1], and in the help message shown
 119                 by linkgit:git-switch[1] or
 120                 linkgit:git-checkout[1] when switching branches.
 121         statusUoption::
 122                 Advise to consider using the `-u` option to linkgit:git-status[1]
 123                 when the command takes more than 2 seconds to enumerate untracked
 124                 files.
 125         submoduleAlternateErrorStrategyDie::
 126                 Advice shown when a submodule.alternateErrorStrategy option
 127                 configured to "die" causes a fatal error.
 128         submodulesNotUpdated::
 129                 Advice shown when a user runs a submodule command that fails
 130                 because `git submodule update --init` was not run.
 131         suggestDetachingHead::
 132                 Advice shown when linkgit:git-switch[1] refuses to detach HEAD
 133                 without the explicit `--detach` option.
 134         updateSparsePath::
 135                 Advice shown when either linkgit:git-add[1] or linkgit:git-rm[1]
 136                 is asked to update index entries outside the current sparse
 137                 checkout.
 138         waitingForEditor::
 139                 Print a message to the terminal whenever Git is waiting for
 140                 editor input from the user.
 141         worktreeAddOrphan::
 142                 Advice shown when a user tries to create a worktree from an
 143                 invalid reference, to instruct how to create a new unborn
 144                 branch instead.
 145 --