rm: integrate with sparse-index

Enable the sparse index within the `git-rm` command. The `p2000` tests demonstrate a ~92% execution time reduction for 'git rm' using a sparse index. Test HEAD~1 HEAD -------------------------------------------------------------------------- 2000.74: git rm ... (full-v3) 0.41(0.37+0.05) 0.43(0.36+0.07) +4.9% 2000.75: git rm ... (full-v4) 0.38(0.34+0.05) 0.39(0.35+0.05) +2.6% 2000.76: git rm ... (sparse-v3) 0.57(0.56+0.01) 0.05(0.05+0.00) -91.2% 2000.77: git rm ... (sparse-v4) 0.57(0.55+0.02) 0.03(0.03+0.00) -94.7% ---- Also, normalize a behavioral difference of `git-rm` under sparse-index. See related discussion [1]. `git-rm` a sparse-directory entry within a sparse-index enabled repo behaves differently from a sparse directory within a sparse-checkout enabled repo. For example, in a sparse-index repo, where 'folder1' is a sparse-directory entry, `git rm -r --sparse folder1` provides this: rm 'folder1/' Whereas in a sparse-checkout repo *without* sparse-index, doing so provides this: rm 'folder1/0/0/0' rm 'folder1/0/1' rm 'folder1/a' Because `git rm` a sparse-directory entry does not need to expand the index, therefore we should accept the current behavior, which is faster than "expand the sparse-directory entry to match the sparse-checkout situation". Modify a previous test so such difference is not considered as an error. [1] https://github.com/ffyuanda/git/pull/6#discussion_r934861398 Helped-by: Victoria Dye <vdye@github.com> Helped-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Shaoxuan Yuan <shaoxuan.yuan02@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Shaoxuan Yuan committed Aug 7, 2022 at 12:13 UTC ede241c7154929c5c80fb784daa79de6103bf048
3 files changed +20 -3
builtin/rm.c
+2
@@ -287,6 +287,8 @@ int cmd_rm(int argc, const char **argv, const char *prefix)
287 if (!index_only)
288 setup_work_tree();
289
290 + prepare_repo_settings(the_repository);
291 + the_repository->settings.command_requires_full_index = 0;
292 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
293
294 if (read_cache() < 0)
t/perf/p2000-sparse-operations.sh
+1
@@ -123,5 +123,6 @@ test_perf_on_all git blame $SPARSE_CONE/f3/a
123 test_perf_on_all git read-tree -mu HEAD
124 test_perf_on_all git checkout-index -f --all
125 test_perf_on_all git update-index --add --remove $SPARSE_CONE/a
126 +test_perf_on_all "git rm -f $SPARSE_CONE/a && git checkout HEAD -- $SPARSE_CONE/a"
127
128 test_done
t/t1092-sparse-checkout-compatibility.sh
+17 -3
@@ -937,7 +937,7 @@ test_expect_success 'read-tree --prefix' '
937 test_all_match git read-tree --prefix=deep/deeper1/deepest -u deepest &&
938 test_all_match git status --porcelain=v2 &&
939
940 - test_all_match git rm -rf --sparse folder1/ &&
940 + run_on_all git rm -rf --sparse folder1/ &&
941 test_all_match git read-tree --prefix=folder1/ -u update-folder1 &&
942 test_all_match git status --porcelain=v2 &&
943
@@ -1899,7 +1899,7 @@ test_expect_success 'rm pathspec inside sparse definition' '
1899 test_all_match git status --porcelain=v2
1900 '
1901
1902 -test_expect_failure 'rm pathspec outside sparse definition' '
1902 +test_expect_success 'rm pathspec outside sparse definition' '
1903 init_repos &&
1904
1905 for file in folder1/a folder1/0/1
@@ -1939,7 +1939,7 @@ test_expect_failure 'rm pathspec outside sparse definition' '
1939 test_sparse_match git status --porcelain=v2
1940 '
1941
1942 -test_expect_failure 'rm pathspec expands index when necessary' '
1942 +test_expect_success 'rm pathspec expands index when necessary' '
1943 init_repos &&
1944
1945 # in-cone pathspec (do not expand)
@@ -1958,4 +1958,18 @@ test_expect_failure 'rm pathspec expands index when necessary' '
1958 test_must_be_empty sparse-index-err
1959 '
1960
1961 +test_expect_success 'sparse index is not expanded: rm' '
1962 + init_repos &&
1963 +
1964 + ensure_not_expanded rm deep/a &&
1965 +
1966 + # test in-cone wildcard
1967 + git -C sparse-index reset --hard &&
1968 + ensure_not_expanded rm deep/* &&
1969 +
1970 + # test recursive rm
1971 + git -C sparse-index reset --hard &&
1972 + ensure_not_expanded rm -r deep
1973 +'
1974 +
1975 test_done