t1092: document bad sparse-checkout behavior
There are several situations where a repository with sparse-checkout enabled will act differently than a normal repository, and in ways that are not intentional. The test t1092-sparse-checkout-compatibility.sh documents some of these deviations, but a casual reader might think these are intentional behavior changes. Add comments on these tests that make it clear that these behaviors should be updated. Using 'NEEDSWORK' helps contributors find that these are potential areas for improvement. Helped-by: Elijah Newren <newren@gmail.com> Reviewed-by: Elijah Newren <newren@gmail.com> Signed-off-by: Derrick Stolee <dstolee@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Derrick Stolee committed
Jul 14, 2021 at 13:12 UTC
e5ca291076a8a936283bb2c57433c4393d3f80c2
1 file changed
+6
-4
t/t1092-sparse-checkout-compatibility.sh
+6
-4
@@ -392,8 +392,8 @@ test_expect_failure 'blame with pathspec outside sparse definition' '
392
test_all_match git blame deep/deeper2/deepest/a
393
'
394
395
-# TODO: reset currently does not behave as expected when in a
396
-# sparse-checkout.
395
+# NEEDSWORK: a sparse-checkout behaves differently from a full checkout
396
+# in this scenario, but it shouldn't.
397
test_expect_failure 'checkout and reset (mixed)' '
398
init_repos &&
399
@@ -403,8 +403,8 @@ test_expect_failure 'checkout and reset (mixed)' '
403
test_all_match git reset update-folder2
404
'
405
406
-# Ensure that sparse-index behaves identically to
407
-# sparse-checkout with a full index.
406
+# NEEDSWORK: a sparse-checkout behaves differently from a full checkout
407
+# in this scenario, but it shouldn't.
408
test_expect_success 'checkout and reset (mixed) [sparse]' '
409
init_repos &&
410
@@ -524,6 +524,8 @@ test_expect_success 'sparse-index is not expanded' '
524
test_region ! index ensure_full_index trace2.txt
525
'
526
527
+# NEEDSWORK: a sparse-checkout behaves differently from a full checkout
528
+# in this scenario, but it shouldn't.
529
test_expect_success 'reset mixed and checkout orphan' '
530
init_repos &&
531