2009-08-20 13:47:12 +00:00
|
|
|
#!/bin/sh
|
|
|
|
|
|
2010-07-31 06:14:25 +00:00
|
|
|
test_description='sparse checkout tests
|
|
|
|
|
|
2020-11-18 23:44:21 +00:00
|
|
|
* (tag: removed, main) removed
|
2010-07-31 06:14:25 +00:00
|
|
|
| D sub/added
|
|
|
|
|
* (HEAD, tag: top) modified and added
|
|
|
|
|
| M init.t
|
|
|
|
|
| A sub/added
|
|
|
|
|
* (tag: init) init
|
|
|
|
|
A init.t
|
|
|
|
|
'
|
2009-08-20 13:47:12 +00:00
|
|
|
|
2022-06-03 11:15:09 +00:00
|
|
|
TEST_CREATE_REPO_NO_TEMPLATE=1
|
2022-11-08 18:17:40 +00:00
|
|
|
TEST_PASSES_SANITIZE_LEAK=true
|
2009-08-20 13:47:12 +00:00
|
|
|
. ./test-lib.sh
|
2011-05-25 20:10:41 +00:00
|
|
|
. "$TEST_DIRECTORY"/lib-read-tree.sh
|
2009-08-20 13:47:12 +00:00
|
|
|
|
|
|
|
|
test_expect_success 'setup' '
|
2018-03-25 19:20:46 +00:00
|
|
|
test_commit init &&
|
|
|
|
|
echo modified >>init.t &&
|
|
|
|
|
|
2016-07-16 05:06:25 +00:00
|
|
|
cat >expected <<-EOF &&
|
2018-03-25 19:20:46 +00:00
|
|
|
100644 $(git hash-object init.t) 0 init.t
|
2016-07-16 05:06:25 +00:00
|
|
|
100644 $EMPTY_BLOB 0 sub/added
|
|
|
|
|
100644 $EMPTY_BLOB 0 sub/addedtoo
|
|
|
|
|
100644 $EMPTY_BLOB 0 subsub/added
|
2010-07-31 06:14:25 +00:00
|
|
|
EOF
|
|
|
|
|
cat >expected.swt <<-\EOF &&
|
|
|
|
|
H init.t
|
|
|
|
|
H sub/added
|
2011-05-02 12:47:43 +00:00
|
|
|
H sub/addedtoo
|
2010-11-07 18:04:58 +00:00
|
|
|
H subsub/added
|
2010-07-31 06:14:25 +00:00
|
|
|
EOF
|
|
|
|
|
|
2010-11-07 18:04:58 +00:00
|
|
|
mkdir sub subsub &&
|
2011-05-02 12:47:43 +00:00
|
|
|
touch sub/added sub/addedtoo subsub/added &&
|
|
|
|
|
git add init.t sub/added sub/addedtoo subsub/added &&
|
2009-08-20 13:47:12 +00:00
|
|
|
git commit -m "modified and added" &&
|
|
|
|
|
git tag top &&
|
|
|
|
|
git rm sub/added &&
|
|
|
|
|
git commit -m removed &&
|
|
|
|
|
git tag removed &&
|
|
|
|
|
git checkout top &&
|
2010-07-31 06:14:25 +00:00
|
|
|
git ls-files --stage >result &&
|
2009-08-20 13:47:12 +00:00
|
|
|
test_cmp expected result
|
|
|
|
|
'
|
|
|
|
|
|
|
|
|
|
test_expect_success 'read-tree without .git/info/sparse-checkout' '
|
2011-05-25 20:10:41 +00:00
|
|
|
read_tree_u_must_succeed -m -u HEAD &&
|
2010-07-31 06:14:25 +00:00
|
|
|
git ls-files --stage >result &&
|
2009-08-20 13:47:12 +00:00
|
|
|
test_cmp expected result &&
|
2010-07-31 06:14:25 +00:00
|
|
|
git ls-files -t >result &&
|
2009-08-20 13:47:12 +00:00
|
|
|
test_cmp expected.swt result
|
|
|
|
|
'
|
|
|
|
|
|
|
|
|
|
test_expect_success 'read-tree with .git/info/sparse-checkout but disabled' '
|
2022-06-03 11:15:09 +00:00
|
|
|
mkdir .git/info &&
|
2010-10-31 01:46:54 +00:00
|
|
|
echo >.git/info/sparse-checkout &&
|
2011-05-25 20:10:41 +00:00
|
|
|
read_tree_u_must_succeed -m -u HEAD &&
|
2010-07-31 06:14:25 +00:00
|
|
|
git ls-files -t >result &&
|
2009-08-20 13:47:12 +00:00
|
|
|
test_cmp expected.swt result &&
|
2022-04-12 20:37:22 +00:00
|
|
|
test_path_is_file init.t &&
|
|
|
|
|
test_path_is_file sub/added
|
2009-08-20 13:47:12 +00:00
|
|
|
'
|
|
|
|
|
|
|
|
|
|
test_expect_success 'read-tree --no-sparse-checkout with empty .git/info/sparse-checkout and enabled' '
|
|
|
|
|
git config core.sparsecheckout true &&
|
2010-07-31 06:14:25 +00:00
|
|
|
echo >.git/info/sparse-checkout &&
|
2011-05-25 20:10:41 +00:00
|
|
|
read_tree_u_must_succeed --no-sparse-checkout -m -u HEAD &&
|
2010-07-31 06:14:25 +00:00
|
|
|
git ls-files -t >result &&
|
2009-08-20 13:47:12 +00:00
|
|
|
test_cmp expected.swt result &&
|
2022-04-12 20:37:22 +00:00
|
|
|
test_path_is_file init.t &&
|
|
|
|
|
test_path_is_file sub/added
|
2009-08-20 13:47:12 +00:00
|
|
|
'
|
|
|
|
|
|
|
|
|
|
test_expect_success 'read-tree with empty .git/info/sparse-checkout' '
|
|
|
|
|
git config core.sparsecheckout true &&
|
2010-07-31 06:14:25 +00:00
|
|
|
echo >.git/info/sparse-checkout &&
|
2020-05-04 18:27:43 +00:00
|
|
|
read_tree_u_must_succeed -m -u HEAD &&
|
2010-07-31 06:14:25 +00:00
|
|
|
git ls-files --stage >result &&
|
2009-08-20 13:47:12 +00:00
|
|
|
test_cmp expected result &&
|
2010-07-31 06:14:25 +00:00
|
|
|
git ls-files -t >result &&
|
2020-05-04 18:27:43 +00:00
|
|
|
cat >expected.swt <<-\EOF &&
|
|
|
|
|
S init.t
|
|
|
|
|
S sub/added
|
|
|
|
|
S sub/addedtoo
|
|
|
|
|
S subsub/added
|
|
|
|
|
EOF
|
2009-08-20 13:47:12 +00:00
|
|
|
test_cmp expected.swt result &&
|
2022-04-12 20:37:22 +00:00
|
|
|
test_path_is_missing init.t &&
|
|
|
|
|
test_path_is_missing sub/added
|
2009-08-20 13:47:12 +00:00
|
|
|
'
|
|
|
|
|
|
|
|
|
|
test_expect_success 'match directories with trailing slash' '
|
2010-07-31 06:14:25 +00:00
|
|
|
cat >expected.swt-noinit <<-\EOF &&
|
|
|
|
|
S init.t
|
|
|
|
|
H sub/added
|
2011-05-02 12:47:43 +00:00
|
|
|
H sub/addedtoo
|
2010-11-07 18:04:58 +00:00
|
|
|
S subsub/added
|
2010-07-31 06:14:25 +00:00
|
|
|
EOF
|
|
|
|
|
|
2009-08-20 13:47:12 +00:00
|
|
|
echo sub/ > .git/info/sparse-checkout &&
|
2011-05-25 20:10:41 +00:00
|
|
|
read_tree_u_must_succeed -m -u HEAD &&
|
2009-08-20 13:47:12 +00:00
|
|
|
git ls-files -t > result &&
|
2010-07-31 06:14:25 +00:00
|
|
|
test_cmp expected.swt-noinit result &&
|
2022-04-12 20:37:22 +00:00
|
|
|
test_path_is_missing init.t &&
|
|
|
|
|
test_path_is_file sub/added
|
2009-08-20 13:47:12 +00:00
|
|
|
'
|
|
|
|
|
|
2010-11-26 18:17:46 +00:00
|
|
|
test_expect_success 'match directories without trailing slash' '
|
2011-05-02 12:47:43 +00:00
|
|
|
echo sub >.git/info/sparse-checkout &&
|
2011-05-25 20:10:41 +00:00
|
|
|
read_tree_u_must_succeed -m -u HEAD &&
|
2010-07-31 06:14:25 +00:00
|
|
|
git ls-files -t >result &&
|
2010-11-26 18:17:46 +00:00
|
|
|
test_cmp expected.swt-noinit result &&
|
2022-04-12 20:37:22 +00:00
|
|
|
test_path_is_missing init.t &&
|
|
|
|
|
test_path_is_file sub/added
|
2010-11-26 18:17:46 +00:00
|
|
|
'
|
|
|
|
|
|
2011-05-09 15:43:01 +00:00
|
|
|
test_expect_success 'match directories with negated patterns' '
|
|
|
|
|
cat >expected.swt-negation <<\EOF &&
|
|
|
|
|
S init.t
|
|
|
|
|
S sub/added
|
|
|
|
|
H sub/addedtoo
|
|
|
|
|
S subsub/added
|
|
|
|
|
EOF
|
|
|
|
|
|
|
|
|
|
cat >.git/info/sparse-checkout <<\EOF &&
|
|
|
|
|
sub
|
|
|
|
|
!sub/added
|
|
|
|
|
EOF
|
|
|
|
|
git read-tree -m -u HEAD &&
|
|
|
|
|
git ls-files -t >result &&
|
|
|
|
|
test_cmp expected.swt-negation result &&
|
2022-04-12 20:37:22 +00:00
|
|
|
test_path_is_missing init.t &&
|
|
|
|
|
test_path_is_missing sub/added &&
|
|
|
|
|
test_path_is_file sub/addedtoo
|
2011-05-09 15:43:01 +00:00
|
|
|
'
|
|
|
|
|
|
|
|
|
|
test_expect_success 'match directories with negated patterns (2)' '
|
|
|
|
|
cat >expected.swt-negation2 <<\EOF &&
|
|
|
|
|
H init.t
|
|
|
|
|
H sub/added
|
|
|
|
|
S sub/addedtoo
|
|
|
|
|
H subsub/added
|
|
|
|
|
EOF
|
|
|
|
|
|
|
|
|
|
cat >.git/info/sparse-checkout <<\EOF &&
|
|
|
|
|
/*
|
|
|
|
|
!sub
|
|
|
|
|
sub/added
|
|
|
|
|
EOF
|
|
|
|
|
git read-tree -m -u HEAD &&
|
|
|
|
|
git ls-files -t >result &&
|
|
|
|
|
test_cmp expected.swt-negation2 result &&
|
2022-04-12 20:37:22 +00:00
|
|
|
test_path_is_file init.t &&
|
|
|
|
|
test_path_is_file sub/added &&
|
|
|
|
|
test_path_is_missing sub/addedtoo
|
2011-05-09 15:43:01 +00:00
|
|
|
'
|
|
|
|
|
|
2010-11-26 18:17:46 +00:00
|
|
|
test_expect_success 'match directory pattern' '
|
2011-05-02 12:47:43 +00:00
|
|
|
echo "s?b" >.git/info/sparse-checkout &&
|
2011-05-25 20:10:41 +00:00
|
|
|
read_tree_u_must_succeed -m -u HEAD &&
|
2010-11-26 18:17:46 +00:00
|
|
|
git ls-files -t >result &&
|
|
|
|
|
test_cmp expected.swt-noinit result &&
|
2022-04-12 20:37:22 +00:00
|
|
|
test_path_is_missing init.t &&
|
|
|
|
|
test_path_is_file sub/added
|
2009-08-20 13:47:12 +00:00
|
|
|
'
|
|
|
|
|
|
|
|
|
|
test_expect_success 'checkout area changes' '
|
2010-07-31 06:14:25 +00:00
|
|
|
cat >expected.swt-nosub <<-\EOF &&
|
|
|
|
|
H init.t
|
|
|
|
|
S sub/added
|
2011-05-02 12:47:43 +00:00
|
|
|
S sub/addedtoo
|
2010-11-07 18:04:58 +00:00
|
|
|
S subsub/added
|
2010-07-31 06:14:25 +00:00
|
|
|
EOF
|
|
|
|
|
|
|
|
|
|
echo init.t >.git/info/sparse-checkout &&
|
2011-05-25 20:10:41 +00:00
|
|
|
read_tree_u_must_succeed -m -u HEAD &&
|
2010-07-31 06:14:25 +00:00
|
|
|
git ls-files -t >result &&
|
|
|
|
|
test_cmp expected.swt-nosub result &&
|
2022-04-12 20:37:22 +00:00
|
|
|
test_path_is_file init.t &&
|
|
|
|
|
test_path_is_missing sub/added
|
2009-08-20 13:47:12 +00:00
|
|
|
'
|
|
|
|
|
|
|
|
|
|
test_expect_success 'read-tree updates worktree, absent case' '
|
2010-07-31 06:14:25 +00:00
|
|
|
echo sub/added >.git/info/sparse-checkout &&
|
2009-08-20 13:47:12 +00:00
|
|
|
git checkout -f top &&
|
2011-05-25 20:10:41 +00:00
|
|
|
read_tree_u_must_succeed -m -u HEAD^ &&
|
2022-04-12 20:37:22 +00:00
|
|
|
test_path_is_missing init.t
|
2009-08-20 13:47:12 +00:00
|
|
|
'
|
|
|
|
|
|
2022-01-14 15:59:39 +00:00
|
|
|
test_expect_success 'read-tree will not throw away dirty changes, non-sparse' '
|
|
|
|
|
echo "/*" >.git/info/sparse-checkout &&
|
|
|
|
|
read_tree_u_must_succeed -m -u HEAD &&
|
|
|
|
|
|
|
|
|
|
echo dirty >init.t &&
|
|
|
|
|
read_tree_u_must_fail -m -u HEAD^ &&
|
|
|
|
|
test_path_is_file init.t &&
|
|
|
|
|
grep -q dirty init.t
|
|
|
|
|
'
|
|
|
|
|
|
unpack-trees: fix accidental loss of user changes
For sparse-checkouts, we don't want unpack-trees to error out on files
that are missing from the worktree, so there has traditionally been
logic to make it skip the verify_uptodate() check for these.
Unfortunately, it was skipping the verify_uptodate() check for files
that were expected to *become* SKIP_WORKTREE. For files that were not
already SKIP_WORKTREE, that can cause us to later delete the file in
apply_sparse_checkout(). Only skip the check for files that were
already SKIP_WORKTREE as well to avoid lightly discarding important
changes users may have made to files.
Note 1: unpack-trees.c is already a bit complex, and the logic around
CE_SKIP_WORKTREE and CE_NEW_SKIP_WORKTREE in that file are no exception.
I also tried just replacing CE_NEW_SKIP_WORKTREE with CE_SKIP_WORKTREE
in the verify_uptodate() check instead of checking for both flags, and
found that it also fixed this bug and passed all the tests. I also
attempted to devise a few testcases that might trip either variant of my
fix and was unable to find any problems. It may be that just checking
CE_SKIP_WORKTREE is a better fix, but I'm not sure. I thought it
was a bit safer to strictly reduce the number of cases where we skip the
up-to-date check rather than just toggling which kind of cases skip it,
and thus went with the current variant of the fix.
Note 2: I also wondered if verify_absent() might have a similar bug, but
despite my attempts to try to devise a testcase that would trigger such
a thing, I couldn't find any problematic testcases. Thus, this patch
makes no attempt to apply similar changes to verify_absent() and
verify_absent_if_directory().
Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-01-14 15:59:40 +00:00
|
|
|
test_expect_success 'read-tree will not throw away dirty changes, sparse' '
|
2022-01-14 15:59:39 +00:00
|
|
|
echo "/*" >.git/info/sparse-checkout &&
|
|
|
|
|
read_tree_u_must_succeed -m -u HEAD &&
|
|
|
|
|
|
|
|
|
|
echo dirty >init.t &&
|
|
|
|
|
echo sub/added >.git/info/sparse-checkout &&
|
|
|
|
|
read_tree_u_must_fail -m -u HEAD^ &&
|
|
|
|
|
test_path_is_file init.t &&
|
|
|
|
|
grep -q dirty init.t
|
|
|
|
|
'
|
|
|
|
|
|
2009-08-20 13:47:12 +00:00
|
|
|
test_expect_success 'read-tree updates worktree, dirty case' '
|
2010-07-31 06:14:25 +00:00
|
|
|
echo sub/added >.git/info/sparse-checkout &&
|
2009-08-20 13:47:12 +00:00
|
|
|
git checkout -f top &&
|
2010-07-31 06:14:25 +00:00
|
|
|
echo dirty >init.t &&
|
repo_read_index: clear SKIP_WORKTREE bit from files present in worktree
The fix is short (~30 lines), but the description is not. Sorry.
There is a set of problems caused by files in what I'll refer to as the
"present-despite-SKIP_WORKTREE" state. This commit aims to not just fix
these problems, but remove the entire class as a possibility -- for
those using sparse checkouts. But first, we need to understand the
problems this class presents. A quick outline:
* Problems
* User facing issues
* Problem space complexity
* Maintenance and code correctness challenges
* SKIP_WORKTREE expectations in Git
* Suggested solution
* Pros/Cons of suggested solution
* Notes on testcase modifications
=== User facing issues ===
There are various ways for users to get files to be present in the
working copy despite having the SKIP_WORKTREE bit set for that file in
the index. This may come from:
* various git commands not really supporting the SKIP_WORKTREE bit[1,2]
* users grabbing files from elsewhere and writing them to the worktree
(perhaps even cached in their editor)
* users attempting to "abort" a sparse-checkout operation with a
not-so-early Ctrl+C (updating $GIT_DIR/info/sparse-checkout and the
working tree is not atomic)[3].
Once users have present-despite-SKIP_WORKTREE files, any modifications
users make to these files will be ignored, possibly to users' confusion.
Further:
* these files will degrade performance for the sparse-index case due
to requiring the index to be expanded (see commit 55dfcf9591
("sparse-checkout: clear tracked sparse dirs", 2021-09-08) for why
we try to delete entire directories outside the sparse cone).
* these files will not be updated by by standard commands
(switch/checkout/pull/merge/rebase will leave them alone unless
conflicts happen -- and even then, the conflicted file may be
written somewhere else to avoid overwriting the SKIP_WORKTREE file
that is present and in the way)
* there is nothing in Git that users can use to discover such
files (status, diff, grep, etc. all ignore it)
* there is no reasonable mechanism to "recover" from such a condition
(neither `git sparse-checkout reapply` nor `git reset --hard` will
correct it).
So, not only are users modifications ignored, but the files get
progressively more stale over time. At some point in the future, they
may change their sparseness specification or disable sparse-checkouts.
At that time, all present-despite-SKIP_WORKTREE files will show up as
having lots of modifications because they represent a version from a
different branch or commit. These might include user-made local changes
from days before, but the only way to tell is to have users look through
them all closely.
If these users come to others for help, there will be no logs that
explain the issue; it's just a mysterious list of changes. Users might
adamantly claim (correctly, as it turns out) that they didn't modify
these files, while others presume they did.
[1] https://lore.kernel.org/git/xmqqbmb1a7ga.fsf@gitster-ct.c.googlers.com/
[2] https://lore.kernel.org/git/CABPp-BH9tju7WVm=QZDOvaMDdZbpNXrVWQdN-jmfN8wC6YVhmw@mail.gmail.com/
[3] https://lore.kernel.org/git/CABPp-BFnFpzwGC11TLoLs8YK5yiisA5D5-fFjXnJsbESVDwZsA@mail.gmail.com/
=== Problem space complexity ===
SKIP_WORKTREE has been part of Git for over a decade. Duy did lots of
work on it initially, and several others have since come along and put
lots of work into it. Stolee spent most of 2021 on the sparse-index,
with lots of bugfixes along the way including to non-sparse-index cases
as we are still trying to get sparse checkouts to behave reasonably.
Basically every codepath throughout the treat needs to be aware of an
additional type of file: tracked-but-not-present. The extra type
results in lots of extra testcases and lots of extra code everywhere.
But, the sad thing is that we actually have more than one extra type.
We have tracked, tracked-but-not-present (SKIP_WORKTREE), and
tracked-but-promised-to-not-be-present-but-is-present-anyway
(present-despite-SKIP_WORKTREE). Two types is a monumental amount of
effort to support, and adding a third feels a bit like insanity[4].
[4] Some examples of which can be seen at
https://lore.kernel.org/git/CABPp-BGJ_Nvi5TmgriD9Bh6eNXE2EDq2f8e8QKXAeYG3BxZafA@mail.gmail.com/
=== Maintenance and code correctness challenges ===
Matheus' patches to grep stalled for nearly a year, in part because of
complications of how to handle sparse-checkouts appropriately in all
cases[5][6] (with trying to sanely figure out how to sanely handle
present-despite-SKIP_WORKTREE files being one of the complications).
His rm/add follow-ups also took months because of those kinds of
issues[7]. The corner cases with things like submodules and
SKIP_WORKTREE with the addition of present-despite-SKIP_WORKTREE start
becoming really complex[8].
We've had to add ugly logic to merge-ort to attempt to handle
present-despite-SKIP_WORKTREE files[9], and basically just been forced
to give up in merge-recursive knowing full well that we'll sometimes
silently discard user modifications. Despite stash essentially being a
merge, it needed extra code (beyond what was in merge-ort and
merge-recursive) to manually tweak SKIP_WORKTREE bits in order to avoid
a few different bugs that'd result in an early abort with a partial
stash application[10].
[5] See https://lore.kernel.org/git/5f3f7ac77039d41d1692ceae4b0c5df3bb45b74a.1612901326.git.matheus.bernardino@usp.br/#t
and the dates on the thread; also Matheus and I had several
conversations off-list trying to resolve the issues over that time
[6] ...it finally kind of got unstuck after
https://lore.kernel.org/git/CABPp-BGJ_Nvi5TmgriD9Bh6eNXE2EDq2f8e8QKXAeYG3BxZafA@mail.gmail.com/
[7] See for example
https://lore.kernel.org/git/CABPp-BHwNoVnooqDFPAsZxBT9aR5Dwk5D9sDRCvYSb8akxAJgA@mail.gmail.com/#t
and quotes like "The core functionality of sparse-checkout has always
been only partially implemented", a statement I still believe is true
today.
[8] https://lore.kernel.org/git/pull.809.git.git.1592356884310.gitgitgadget@gmail.com/
[9] See commit 66b209b86a ("merge-ort: implement CE_SKIP_WORKTREE
handling with conflicted entries", 2021-03-20)
[10] See commit ba359fd507 ("stash: fix stash application in
sparse-checkouts", 2020-12-01)
=== SKIP_WORKTREE expectations in Git ===
A couple quotes:
* From [11] (before the "sparse-checkout" command existed):
If it needs too many special cases, hacks, and conditionals, then it
is not worth the complexity---if it is easier to write a correct code
by allowing Git to populate working tree files, it is perfectly fine
to do so.
In a sense, the sparse checkout "feature" itself is a hack by itself,
and that is why I think this part should be "best effort" as well.
* From the git-sparse-checkout manual (still present today):
THIS COMMAND IS EXPERIMENTAL. ITS BEHAVIOR, AND THE BEHAVIOR OF OTHER
COMMANDS IN THE PRESENCE OF SPARSE-CHECKOUTS, WILL LIKELY CHANGE IN
THE FUTURE.
[11] https://lore.kernel.org/git/xmqqbmb1a7ga.fsf@gitster-ct.c.googlers.com/
=== Suggested solution ===
SKIP_WORKTREE was written to allow sparse-checkouts, in particular, as
the name of the option implies, to allow the file to NOT be in the
worktree but consider it to be unchanged rather than deleted.
The suggests a simple solution: present-despite-SKIP_WORKTREE files
should not exist, for those using sparse-checkouts.
Enforce this at index loading time by checking if core.sparseCheckout is
true; if so, check files in the index with the SKIP_WORKTREE bit set to
verify that they are absent from the working tree. If they are present,
unset the bit (in memory, though any commands that write to the index
will record the update).
Users can, of course, can get the SKIP_WORKTREE bit back such as by
running `git sparse-checkout reapply` (if they have ensured the file is
unmodified and doesn't match the specified sparsity patterns).
=== Pros/Cons of suggested solution ===
Pros:
* Solves the user visible problems reported above, which I've been
complaining about for nearly a year but couldn't find a solution to.
* Helps prevent slow performance degradation with a sparse-index.
* Much easier behavior in sparse-checkouts for users to reason about
* Very simple, ~30 lines of code.
* Significantly simplifies some ugly testcases, and obviates the need
to test an entire class of potential issues.
* Reduces code complexity, reasoning, and maintenance. Avoids
disagreements about weird corner cases[12].
* It has been reported that some users might be (ab)using
SKIP_WORKTREE as a let-me-modify-but-keep-the-file-in-the-worktree
mechanism[13, and a few other similar references]. These users know
of multiple caveats and shortcomings in doing so; perhaps not
surprising given the "SKIP_WORKTREE expecations" section above.
However, these users use `git update-index --skip-worktree`, and not
`git sparse-checkout` or core.sparseCheckout=true. As such, these
users would be unaffected by this change and can continue abusing
the system as before.
[12] https://lore.kernel.org/git/CABPp-BH9tju7WVm=QZDOvaMDdZbpNXrVWQdN-jmfN8wC6YVhmw@mail.gmail.com/
[13] https://stackoverflow.com/questions/13630849/git-difference-between-assume-unchanged-and-skip-worktree
Cons:
* When core.sparseCheckout is enabled, this adds a performance cost to
reading the index. I'll defer discussion of this cost to a subsequent
patch, since I have some optimizations to add.
=== Notes on testcase modifications ===
The good:
* t1011: Compare to two cases above it ('read-tree will not throw away
dirty changes, non-sparse'); since the file is present, it should
match the non-sparse case now
* t1092: sparse-index & sparse-checkout now match full-worktree
behavior in more cases! Yaay for consistency!
* t6428, t7012: look at how much simpler the tests become! Merge and
stash can just fail early telling the user there's a file in the
way, instead of not noticing until it's about to write a file and
then have to implement sudden crash avoidance. Hurray for sanity!
* t7817: sparse behavior better matches full tree behavior. Hurray
for sanity!
The confusing:
* t3705: These changes were ONLY needed on Windows, but they don't
hurt other platforms. Let's discuss each individually:
* core.sparseCheckout should be false by default. Nothing in this
testcase toggles that until many, many tests later. However,
early tests (#5 in particular) were testing `update-index
--skip-worktree` behavior in a non-sparse-checkout, but the
Windows tests in CI were behaving as if core.sparseCheckout=true
had been specified somewhere. I do not have access to a Windows
machine. But I just manually did what should have been a no-op
and turned the config off. And it fixed the test.
* I have no idea why the leftover .gitattributes file from this
test was causing failures for test #18 on Windows, but only with
these changes of mine. Test #18 was checking for empty stderr,
and specifically wanted to know that some error completely
unrelated to file endings did not appear. The leftover
.gitattributes file thus caused some spurious stderr unrelated to
the thing being checked. Since other tests did not intend to
test normalization, just proactively remove the .gitattributes
file. I'm certain this is cleaner and better, I'm just unsure
why/how this didn't trigger problems before.
Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-01-14 15:59:41 +00:00
|
|
|
read_tree_u_must_fail -m -u HEAD^ &&
|
2009-08-20 13:47:12 +00:00
|
|
|
grep -q dirty init.t &&
|
|
|
|
|
rm init.t
|
|
|
|
|
'
|
|
|
|
|
|
|
|
|
|
test_expect_success 'read-tree removes worktree, dirty case' '
|
2010-07-31 06:14:25 +00:00
|
|
|
echo init.t >.git/info/sparse-checkout &&
|
2009-08-20 13:47:12 +00:00
|
|
|
git checkout -f top &&
|
2010-07-31 06:14:25 +00:00
|
|
|
echo dirty >added &&
|
2011-05-25 20:10:41 +00:00
|
|
|
read_tree_u_must_succeed -m -u HEAD^ &&
|
2009-08-20 13:47:12 +00:00
|
|
|
grep -q dirty added
|
|
|
|
|
'
|
|
|
|
|
|
|
|
|
|
test_expect_success 'read-tree adds to worktree, absent case' '
|
2010-07-31 06:14:25 +00:00
|
|
|
echo init.t >.git/info/sparse-checkout &&
|
2009-08-20 13:47:12 +00:00
|
|
|
git checkout -f removed &&
|
2011-05-25 20:10:41 +00:00
|
|
|
read_tree_u_must_succeed -u -m HEAD^ &&
|
2022-04-12 20:37:22 +00:00
|
|
|
test_path_is_missing sub/added
|
2009-08-20 13:47:12 +00:00
|
|
|
'
|
|
|
|
|
|
2010-07-31 06:14:29 +00:00
|
|
|
test_expect_success 'read-tree adds to worktree, dirty case' '
|
2010-07-31 06:14:25 +00:00
|
|
|
echo init.t >.git/info/sparse-checkout &&
|
2009-08-20 13:47:12 +00:00
|
|
|
git checkout -f removed &&
|
|
|
|
|
mkdir sub &&
|
2010-07-31 06:14:25 +00:00
|
|
|
echo dirty >sub/added &&
|
2011-05-25 20:10:41 +00:00
|
|
|
read_tree_u_must_succeed -u -m HEAD^ &&
|
2009-08-20 13:47:12 +00:00
|
|
|
grep -q dirty sub/added
|
|
|
|
|
'
|
|
|
|
|
|
2010-07-31 06:14:26 +00:00
|
|
|
test_expect_success 'index removal and worktree narrowing at the same time' '
|
|
|
|
|
echo init.t >.git/info/sparse-checkout &&
|
|
|
|
|
echo sub/added >>.git/info/sparse-checkout &&
|
|
|
|
|
git checkout -f top &&
|
|
|
|
|
echo init.t >.git/info/sparse-checkout &&
|
|
|
|
|
git checkout removed &&
|
|
|
|
|
git ls-files sub/added >result &&
|
2022-04-12 20:37:22 +00:00
|
|
|
test_path_is_missing sub/added &&
|
2019-11-27 07:51:43 +00:00
|
|
|
test_must_be_empty result
|
2010-07-31 06:14:26 +00:00
|
|
|
'
|
|
|
|
|
|
2010-07-31 06:14:27 +00:00
|
|
|
test_expect_success 'read-tree --reset removes outside worktree' '
|
|
|
|
|
echo init.t >.git/info/sparse-checkout &&
|
|
|
|
|
git checkout -f top &&
|
|
|
|
|
git reset --hard removed &&
|
|
|
|
|
git ls-files sub/added >result &&
|
2018-07-27 17:48:11 +00:00
|
|
|
test_must_be_empty result
|
2010-07-31 06:14:27 +00:00
|
|
|
'
|
|
|
|
|
|
unpack-trees: failure to set SKIP_WORKTREE bits always just a warning
Setting and clearing of the SKIP_WORKTREE bit is not only done when
users run 'sparse-checkout'; other commands such as 'checkout' also run
through unpack_trees() which has logic for handling this special bit.
As such, we need to consider how they handle special cases. A couple
comparison points should help explain the rationale for changing how
unpack_trees() handles these bits:
Ignoring sparse checkouts for a moment, if you are switching
branches and have dirty changes, it is only considered an error that
will prevent the branch switching from being successful if the dirty
file happens to be one of the paths with different contents.
SKIP_WORKTREE has always been considered advisory; for example, if
rebase or merge need or even want to materialize a path as part of
their work, they have always been allowed to do so regardless of the
SKIP_WORKTREE setting. This has been used for unmerged paths, but
it was often used for paths it wasn't needed just because it made
the code simpler. It was a best-effort consideration, and when it
materialized paths contrary to the SKIP_WORKTREE setting, it was
never required to even print a warning message.
In the past if you trying to run e.g. 'git checkout' and:
1) you had a path that was materialized and had some dirty changes
2) the path was listed in $GITDIR/info/sparse-checkout
3) this path did not different between the current and target branches
then despite the comparison points above, the inability to set
SKIP_WORKTREE was treated as a *hard* error that would abort the
checkout operation. This is completely inconsistent with how
SKIP_WORKTREE is handled elsewhere, and rather annoying for users as
leaving the paths materialized in the working copy (with a simple
warning) should present no problem at all.
Downgrade any errors from inability to toggle the SKIP_WORKTREE bit to a
warning and allow the operations to continue.
Reviewed-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-03-27 00:49:00 +00:00
|
|
|
test_expect_success 'print warnings when some worktree updates disabled' '
|
2011-09-22 11:24:22 +00:00
|
|
|
echo sub >.git/info/sparse-checkout &&
|
|
|
|
|
git checkout -f init &&
|
|
|
|
|
mkdir sub &&
|
|
|
|
|
touch sub/added sub/addedtoo &&
|
unpack-trees: failure to set SKIP_WORKTREE bits always just a warning
Setting and clearing of the SKIP_WORKTREE bit is not only done when
users run 'sparse-checkout'; other commands such as 'checkout' also run
through unpack_trees() which has logic for handling this special bit.
As such, we need to consider how they handle special cases. A couple
comparison points should help explain the rationale for changing how
unpack_trees() handles these bits:
Ignoring sparse checkouts for a moment, if you are switching
branches and have dirty changes, it is only considered an error that
will prevent the branch switching from being successful if the dirty
file happens to be one of the paths with different contents.
SKIP_WORKTREE has always been considered advisory; for example, if
rebase or merge need or even want to materialize a path as part of
their work, they have always been allowed to do so regardless of the
SKIP_WORKTREE setting. This has been used for unmerged paths, but
it was often used for paths it wasn't needed just because it made
the code simpler. It was a best-effort consideration, and when it
materialized paths contrary to the SKIP_WORKTREE setting, it was
never required to even print a warning message.
In the past if you trying to run e.g. 'git checkout' and:
1) you had a path that was materialized and had some dirty changes
2) the path was listed in $GITDIR/info/sparse-checkout
3) this path did not different between the current and target branches
then despite the comparison points above, the inability to set
SKIP_WORKTREE was treated as a *hard* error that would abort the
checkout operation. This is completely inconsistent with how
SKIP_WORKTREE is handled elsewhere, and rather annoying for users as
leaving the paths materialized in the working copy (with a simple
warning) should present no problem at all.
Downgrade any errors from inability to toggle the SKIP_WORKTREE bit to a
warning and allow the operations to continue.
Reviewed-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-03-27 00:49:00 +00:00
|
|
|
# Use -q to suppress "Previous HEAD position" and "Head is now at" msgs
|
|
|
|
|
git checkout -q top 2>actual &&
|
2011-09-22 11:24:22 +00:00
|
|
|
cat >expected <<\EOF &&
|
unpack-trees: failure to set SKIP_WORKTREE bits always just a warning
Setting and clearing of the SKIP_WORKTREE bit is not only done when
users run 'sparse-checkout'; other commands such as 'checkout' also run
through unpack_trees() which has logic for handling this special bit.
As such, we need to consider how they handle special cases. A couple
comparison points should help explain the rationale for changing how
unpack_trees() handles these bits:
Ignoring sparse checkouts for a moment, if you are switching
branches and have dirty changes, it is only considered an error that
will prevent the branch switching from being successful if the dirty
file happens to be one of the paths with different contents.
SKIP_WORKTREE has always been considered advisory; for example, if
rebase or merge need or even want to materialize a path as part of
their work, they have always been allowed to do so regardless of the
SKIP_WORKTREE setting. This has been used for unmerged paths, but
it was often used for paths it wasn't needed just because it made
the code simpler. It was a best-effort consideration, and when it
materialized paths contrary to the SKIP_WORKTREE setting, it was
never required to even print a warning message.
In the past if you trying to run e.g. 'git checkout' and:
1) you had a path that was materialized and had some dirty changes
2) the path was listed in $GITDIR/info/sparse-checkout
3) this path did not different between the current and target branches
then despite the comparison points above, the inability to set
SKIP_WORKTREE was treated as a *hard* error that would abort the
checkout operation. This is completely inconsistent with how
SKIP_WORKTREE is handled elsewhere, and rather annoying for users as
leaving the paths materialized in the working copy (with a simple
warning) should present no problem at all.
Downgrade any errors from inability to toggle the SKIP_WORKTREE bit to a
warning and allow the operations to continue.
Reviewed-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-03-27 00:49:00 +00:00
|
|
|
warning: The following paths were already present and thus not updated despite sparse patterns:
|
2011-09-22 11:24:22 +00:00
|
|
|
sub/added
|
|
|
|
|
sub/addedtoo
|
unpack-trees: failure to set SKIP_WORKTREE bits always just a warning
Setting and clearing of the SKIP_WORKTREE bit is not only done when
users run 'sparse-checkout'; other commands such as 'checkout' also run
through unpack_trees() which has logic for handling this special bit.
As such, we need to consider how they handle special cases. A couple
comparison points should help explain the rationale for changing how
unpack_trees() handles these bits:
Ignoring sparse checkouts for a moment, if you are switching
branches and have dirty changes, it is only considered an error that
will prevent the branch switching from being successful if the dirty
file happens to be one of the paths with different contents.
SKIP_WORKTREE has always been considered advisory; for example, if
rebase or merge need or even want to materialize a path as part of
their work, they have always been allowed to do so regardless of the
SKIP_WORKTREE setting. This has been used for unmerged paths, but
it was often used for paths it wasn't needed just because it made
the code simpler. It was a best-effort consideration, and when it
materialized paths contrary to the SKIP_WORKTREE setting, it was
never required to even print a warning message.
In the past if you trying to run e.g. 'git checkout' and:
1) you had a path that was materialized and had some dirty changes
2) the path was listed in $GITDIR/info/sparse-checkout
3) this path did not different between the current and target branches
then despite the comparison points above, the inability to set
SKIP_WORKTREE was treated as a *hard* error that would abort the
checkout operation. This is completely inconsistent with how
SKIP_WORKTREE is handled elsewhere, and rather annoying for users as
leaving the paths materialized in the working copy (with a simple
warning) should present no problem at all.
Downgrade any errors from inability to toggle the SKIP_WORKTREE bit to a
warning and allow the operations to continue.
Reviewed-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-03-27 00:49:00 +00:00
|
|
|
|
|
|
|
|
After fixing the above paths, you may want to run `git sparse-checkout reapply`.
|
2011-09-22 11:24:22 +00:00
|
|
|
EOF
|
2021-02-11 01:53:53 +00:00
|
|
|
test_cmp expected actual
|
2011-09-22 11:24:22 +00:00
|
|
|
'
|
|
|
|
|
|
2013-04-12 23:12:08 +00:00
|
|
|
test_expect_success 'checkout without --ignore-skip-worktree-bits' '
|
|
|
|
|
echo "*" >.git/info/sparse-checkout &&
|
|
|
|
|
git checkout -f top &&
|
|
|
|
|
test_path_is_file init.t &&
|
|
|
|
|
echo sub >.git/info/sparse-checkout &&
|
|
|
|
|
git checkout &&
|
|
|
|
|
echo modified >> sub/added &&
|
|
|
|
|
git checkout . &&
|
|
|
|
|
test_path_is_missing init.t &&
|
|
|
|
|
git diff --exit-code HEAD
|
|
|
|
|
'
|
|
|
|
|
|
|
|
|
|
test_expect_success 'checkout with --ignore-skip-worktree-bits' '
|
|
|
|
|
echo "*" >.git/info/sparse-checkout &&
|
|
|
|
|
git checkout -f top &&
|
|
|
|
|
test_path_is_file init.t &&
|
|
|
|
|
echo sub >.git/info/sparse-checkout &&
|
|
|
|
|
git checkout &&
|
|
|
|
|
echo modified >> sub/added &&
|
|
|
|
|
git checkout --ignore-skip-worktree-bits . &&
|
|
|
|
|
test_path_is_file init.t &&
|
|
|
|
|
git diff --exit-code HEAD
|
|
|
|
|
'
|
|
|
|
|
|
2009-08-20 13:47:12 +00:00
|
|
|
test_done
|