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                 Advice on what to do when you've accidentally added one
  10                 git repo inside of another.
  11         addEmptyPathspec::
  12                 Advice shown if a user runs the add command without providing
  13                 the pathspec parameter.
  14         addIgnoredFile::
  15                 Advice shown if a user attempts to add an ignored file to
  16                 the index.
  17         amWorkDir::
  18                 Advice that shows the location of the patch file when
  19                 linkgit:git-am[1] fails to apply it.
  20         ambiguousFetchRefspec::
  21                 Advice 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                 Advice 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                 Advice shown when linkgit:git-merge[1] refuses to
  37                 merge to avoid overwriting local changes.
  38         detachedHead::
  39                 Advice shown when you used
  40                 linkgit:git-switch[1] or linkgit:git-checkout[1]
  41                 to move to the detached HEAD state, to instruct how to
  42                 create a local branch after the fact.
  43         diverging::
  44                 Advice shown when a fast-forward is not possible.
  45         fetchShowForcedUpdates::
  46                 Advice 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                 Advice shown when a user tries to delete a not fully merged
  51                 branch without the force option set.
  52         ignoredHook::
  53                 Advice shown if a hook is ignored because the hook is not
  54                 set as executable.
  55         implicitIdentity::
  56                 Advice on how to set your identity configuration when
  57                 your information is guessed from the system username and
  58                 domain name.
  59         nestedTag::
  60                 Advice shown if 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                 Advice shown when linkgit:git-push[1] fails due to a
  75                 non-fast-forward update to the current branch.
  76         pushNonFFMatching::
  77                 Advice shown when you ran linkgit:git-push[1] and pushed
  78                 'matching refs' explicitly (i.e. you used ':', or
  79                 specified a refspec that isn't your 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         resetNoRefresh::
  98                 Advice to consider using the `--no-refresh` option to
  99                 linkgit:git-reset[1] when the command takes more than 2 seconds
 100                 to refresh the index after reset.
 101         resolveConflict::
 102                 Advice shown by various commands when conflicts
 103                 prevent the operation from being performed.
 104         rmHints::
 105                 In case of failure in the output of linkgit:git-rm[1],
 106                 show directions on how to proceed from the current state.
 107         sequencerInUse::
 108                 Advice shown when a sequencer command is already in progress.
 109         skippedCherryPicks::
 110                 Shown when linkgit:git-rebase[1] skips a commit that has already
 111                 been cherry-picked onto the upstream branch.
 112         statusAheadBehind::
 113                 Shown when linkgit:git-status[1] computes the ahead/behind
 114                 counts for a local ref compared to its remote tracking ref,
 115                 and that calculation takes longer than expected. Will not
 116                 appear if `status.aheadBehind` is false or the option
 117                 `--no-ahead-behind` is given.
 118         statusHints::
 119                 Show directions on how to proceed from the current
 120                 state in the output of linkgit:git-status[1], in
 121                 the template shown when writing commit messages in
 122                 linkgit:git-commit[1], and in the help message shown
 123                 by linkgit:git-switch[1] or
 124                 linkgit:git-checkout[1] when switching branches.
 125         statusUoption::
 126                 Advise to consider using the `-u` option to linkgit:git-status[1]
 127                 when the command takes more than 2 seconds to enumerate untracked
 128                 files.
 129         submoduleAlternateErrorStrategyDie::
 130                 Advice shown when a submodule.alternateErrorStrategy option
 131                 configured to "die" causes a fatal error.
 132         submoduleMergeConflict::
 133                 Advice shown when a non-trivial submodule merge conflict is
 134                 encountered.
 135         submodulesNotUpdated::
 136                 Advice shown when a user runs a submodule command that fails
 137                 because `git submodule update --init` was not run.
 138         suggestDetachingHead::
 139                 Advice shown when linkgit:git-switch[1] refuses to detach HEAD
 140                 without the explicit `--detach` option.
 141         updateSparsePath::
 142                 Advice 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                 Print a message to the terminal whenever Git is waiting for
 147                 editor input from the user.
 148         worktreeAddOrphan::
 149                 Advice shown when a user tries to create a worktree from an
 150                 invalid reference, to instruct how to create a new unborn
 151                 branch instead.
 152 --