diff options
| author | Derrick Stolee <dstolee@microsoft.com> | 2021-09-24 15:39:08 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2021-09-28 17:31:02 (GMT) |
| commit | 0299a69694fcf486a0880439bb4dacfafe3ffc38 (patch) | |
| tree | 2e719f647be34a55ec6c560202b2a4c5e5ffc735 /Documentation/git-add.txt | |
| parent | 49fdd51a235fe2ca91a6d1b16315204f0f016a96 (diff) | |
| download | git-0299a69694fcf486a0880439bb4dacfafe3ffc38.zip git-0299a69694fcf486a0880439bb4dacfafe3ffc38.tar.gz git-0299a69694fcf486a0880439bb4dacfafe3ffc38.tar.bz2 | |
add: implement the --sparse option
We previously modified 'git add' to refuse updating index entries
outside of the sparse-checkout cone. This is justified to prevent users
from accidentally getting into a confusing state when Git removes those
files from the working tree at some later point.
Unfortunately, this caused some workflows that were previously possible
to become impossible, especially around merge conflicts outside of the
sparse-checkout cone. These were documented in tests within t1092.
We now re-enable these workflows using a new '--sparse' option to 'git
add'. This allows users to signal "Yes, I do know what I'm doing with
these files," and accept the consequences of the files leaving the
worktree later.
We delay updating the advice message until implementing a similar option
in 'git rm' and 'git mv'.
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-add.txt')
| -rw-r--r-- | Documentation/git-add.txt | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt index be5e3ac..11eb70f 100644 --- a/Documentation/git-add.txt +++ b/Documentation/git-add.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'git add' [--verbose | -v] [--dry-run | -n] [--force | -f] [--interactive | -i] [--patch | -p] - [--edit | -e] [--[no-]all | --[no-]ignore-removal | [--update | -u]] + [--edit | -e] [--[no-]all | --[no-]ignore-removal | [--update | -u]] [--sparse] [--intent-to-add | -N] [--refresh] [--ignore-errors] [--ignore-missing] [--renormalize] [--chmod=(+|-)x] [--pathspec-from-file=<file> [--pathspec-file-nul]] [--] [<pathspec>...] @@ -79,6 +79,13 @@ in linkgit:gitglossary[7]. --force:: Allow adding otherwise ignored files. +--sparse:: + Allow updating index entries outside of the sparse-checkout cone. + Normally, `git add` refuses to update index entries whose paths do + not fit within the sparse-checkout cone, since those files might + be removed from the working tree without warning. See + linkgit:git-sparse-checkout[1] for more details. + -i:: --interactive:: Add modified contents in the working tree interactively to |