mirror of
https://github.com/git/git.git
synced 2026-01-10 01:56:42 +00:00
9479a31d60
Typically, forcing a sparse index to expand to a full index means that
Git could not determine the status of a file outside of the
sparse-checkout and needed to expand sparse trees into the full list of
sparse blobs. This operation can be very slow when the sparse-checkout
is much smaller than the full tree at HEAD.
When users are in this state, there is usually a modified or untracked
file outside of the sparse-checkout mentioned by the output of 'git
status'. There are a number of reasons why this is insufficient:
1. Users may not have a full understanding of which files are inside or
outside of their sparse-checkout. This is more common in monorepos
that manage the sparse-checkout using custom tools that map build
dependencies into sparse-checkout definitions.
2. In some cases, an empty directory could exist outside the
sparse-checkout and these empty directories are not reported by 'git
status' and friends.
3. If the user has '.gitignore' or 'exclude' files, then 'git status'
will squelch the warnings and not demonstrate any problems.
In order to help users who are in this state, add a new advice message
to indicate that a sparse index is expanded to a full index. This
message should be written at most once per process, so add a static
global 'give_advice_on_expansion' to sparse-index.c. Further, there is a
case in 'git sparse-checkout set' that uses the sparse index as an
in-memory data structure (even when writing a full index) so we need to
disable the message in that kind of case.
The t1092-sparse-checkout-compatibility.sh test script compares the
behavior of several Git commands across full and sparse repositories,
including sparse repositories with and without a sparse index. We need
to disable the advice in the sparse-index repo to avoid differences in
stderr. By leaving the advice on in the sparse-checkout repo (without
the sparse index), we can test the behavior of disabling the advice in
convert_to_sparse(). (Indeed, these tests are how that necessity was
discovered.) Add a test that reenables the advice and demonstrates that
the message is output.
The advice message is defined outside of expand_index() to avoid super-
wide lines. It is also defined as a macro to avoid compile issues with
-Werror=format-security.
Signed-off-by: Derrick Stolee <stolee@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
154 lines
6.2 KiB
Plaintext
154 lines
6.2 KiB
Plaintext
advice.*::
|
|
These variables control various optional help messages designed to
|
|
aid new users. When left unconfigured, Git will give the message
|
|
alongside instructions on how to squelch it. You can tell Git
|
|
that you do not need the help message by setting these to 'false':
|
|
+
|
|
--
|
|
addEmbeddedRepo::
|
|
Advice on what to do when you've accidentally added one
|
|
git repo inside of another.
|
|
addEmptyPathspec::
|
|
Advice shown if a user runs the add command without providing
|
|
the pathspec parameter.
|
|
addIgnoredFile::
|
|
Advice shown if a user attempts to add an ignored file to
|
|
the index.
|
|
amWorkDir::
|
|
Advice that shows the location of the patch file when
|
|
linkgit:git-am[1] fails to apply it.
|
|
ambiguousFetchRefspec::
|
|
Advice shown when a fetch refspec for multiple remotes maps to
|
|
the same remote-tracking branch namespace and causes branch
|
|
tracking set-up to fail.
|
|
checkoutAmbiguousRemoteBranchName::
|
|
Advice shown when the argument to
|
|
linkgit:git-checkout[1] and linkgit:git-switch[1]
|
|
ambiguously resolves to a
|
|
remote tracking branch on more than one remote in
|
|
situations where an unambiguous argument would have
|
|
otherwise caused a remote-tracking branch to be
|
|
checked out. See the `checkout.defaultRemote`
|
|
configuration variable for how to set a given remote
|
|
to be used by default in some situations where this
|
|
advice would be printed.
|
|
commitBeforeMerge::
|
|
Advice shown when linkgit:git-merge[1] refuses to
|
|
merge to avoid overwriting local changes.
|
|
detachedHead::
|
|
Advice shown when you used
|
|
linkgit:git-switch[1] or linkgit:git-checkout[1]
|
|
to move to the detached HEAD state, to instruct how to
|
|
create a local branch after the fact.
|
|
diverging::
|
|
Advice shown when a fast-forward is not possible.
|
|
fetchShowForcedUpdates::
|
|
Advice shown when linkgit:git-fetch[1] takes a long time
|
|
to calculate forced updates after ref updates, or to warn
|
|
that the check is disabled.
|
|
forceDeleteBranch::
|
|
Advice shown when a user tries to delete a not fully merged
|
|
branch without the force option set.
|
|
ignoredHook::
|
|
Advice shown if a hook is ignored because the hook is not
|
|
set as executable.
|
|
implicitIdentity::
|
|
Advice on how to set your identity configuration when
|
|
your information is guessed from the system username and
|
|
domain name.
|
|
nestedTag::
|
|
Advice shown if a user attempts to recursively tag a tag object.
|
|
pushAlreadyExists::
|
|
Shown when linkgit:git-push[1] rejects an update that
|
|
does not qualify for fast-forwarding (e.g., a tag.)
|
|
pushFetchFirst::
|
|
Shown when linkgit:git-push[1] rejects an update that
|
|
tries to overwrite a remote ref that points at an
|
|
object we do not have.
|
|
pushNeedsForce::
|
|
Shown when linkgit:git-push[1] rejects an update that
|
|
tries to overwrite a remote ref that points at an
|
|
object that is not a commit-ish, or make the remote
|
|
ref point at an object that is not a commit-ish.
|
|
pushNonFFCurrent::
|
|
Advice shown when linkgit:git-push[1] fails due to a
|
|
non-fast-forward update to the current branch.
|
|
pushNonFFMatching::
|
|
Advice shown when you ran linkgit:git-push[1] and pushed
|
|
'matching refs' explicitly (i.e. you used ':', or
|
|
specified a refspec that isn't your current branch) and
|
|
it resulted in a non-fast-forward error.
|
|
pushRefNeedsUpdate::
|
|
Shown when linkgit:git-push[1] rejects a forced update of
|
|
a branch when its remote-tracking ref has updates that we
|
|
do not have locally.
|
|
pushUnqualifiedRefname::
|
|
Shown when linkgit:git-push[1] gives up trying to
|
|
guess based on the source and destination refs what
|
|
remote ref namespace the source belongs in, but where
|
|
we can still suggest that the user push to either
|
|
refs/heads/* or refs/tags/* based on the type of the
|
|
source object.
|
|
pushUpdateRejected::
|
|
Set this variable to 'false' if you want to disable
|
|
'pushNonFFCurrent', 'pushNonFFMatching', 'pushAlreadyExists',
|
|
'pushFetchFirst', 'pushNeedsForce', and 'pushRefNeedsUpdate'
|
|
simultaneously.
|
|
resetNoRefresh::
|
|
Advice to consider using the `--no-refresh` option to
|
|
linkgit:git-reset[1] when the command takes more than 2 seconds
|
|
to refresh the index after reset.
|
|
resolveConflict::
|
|
Advice shown by various commands when conflicts
|
|
prevent the operation from being performed.
|
|
rmHints::
|
|
In case of failure in the output of linkgit:git-rm[1],
|
|
show directions on how to proceed from the current state.
|
|
sequencerInUse::
|
|
Advice shown when a sequencer command is already in progress.
|
|
skippedCherryPicks::
|
|
Shown when linkgit:git-rebase[1] skips a commit that has already
|
|
been cherry-picked onto the upstream branch.
|
|
sparseIndexExpanded::
|
|
Shown when a sparse index is expanded to a full index, which is likely
|
|
due to an unexpected set of files existing outside of the
|
|
sparse-checkout.
|
|
statusAheadBehind::
|
|
Shown when linkgit:git-status[1] computes the ahead/behind
|
|
counts for a local ref compared to its remote tracking ref,
|
|
and that calculation takes longer than expected. Will not
|
|
appear if `status.aheadBehind` is false or the option
|
|
`--no-ahead-behind` is given.
|
|
statusHints::
|
|
Show directions on how to proceed from the current
|
|
state in the output of linkgit:git-status[1], in
|
|
the template shown when writing commit messages in
|
|
linkgit:git-commit[1], and in the help message shown
|
|
by linkgit:git-switch[1] or
|
|
linkgit:git-checkout[1] when switching branches.
|
|
statusUoption::
|
|
Advise to consider using the `-u` option to linkgit:git-status[1]
|
|
when the command takes more than 2 seconds to enumerate untracked
|
|
files.
|
|
submoduleAlternateErrorStrategyDie::
|
|
Advice shown when a submodule.alternateErrorStrategy option
|
|
configured to "die" causes a fatal error.
|
|
submodulesNotUpdated::
|
|
Advice shown when a user runs a submodule command that fails
|
|
because `git submodule update --init` was not run.
|
|
suggestDetachingHead::
|
|
Advice shown when linkgit:git-switch[1] refuses to detach HEAD
|
|
without the explicit `--detach` option.
|
|
updateSparsePath::
|
|
Advice shown when either linkgit:git-add[1] or linkgit:git-rm[1]
|
|
is asked to update index entries outside the current sparse
|
|
checkout.
|
|
waitingForEditor::
|
|
Print a message to the terminal whenever Git is waiting for
|
|
editor input from the user.
|
|
worktreeAddOrphan::
|
|
Advice shown when a user tries to create a worktree from an
|
|
invalid reference, to instruct how to create a new unborn
|
|
branch instead.
|
|
--
|