git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[RFC][PATCH V1] diff-tree: integrate with sparse index

From
Shuqi Liang <cheskaqiqi@gmail.com>
Date
May 15, 2023, 19:18 UTC
Message-ID
<20230515191836.674234-1-cheskaqiqi@gmail.com>

Remove full index requirement for `git diff-tree`. Add tests that verify that 'git diff-tree' behaves correctly when the sparse index is enabled and test to ensure the index is not expanded.

The `p2000` tests demonstrate a ~98% execution time reduction for 'git diff-tree' using a sparse index:

Test before after ------------------------------------------------------------------------ 2000.94: git diff-tree HEAD (full-v3) 0.05 0.04 -20.0% 2000.95: git diff-tree HEAD (full-v4) 0.06 0.05 -16.7% 2000.96: git diff-tree HEAD (sparse-v3) 0.59 0.01 -98.3% 2000.97: git diff-tree HEAD (sparse-v4) 0.61 0.01 -98.4% 2000.98: git diff-tree HEAD -- f2/f4/a (full-v3) 0.05 0.05 +0.0% 2000.99: git diff-tree HEAD -- f2/f4/a (full-v4) 0.05 0.04 -20.0% 2000.100: git diff-tree HEAD -- f2/f4/a (sparse-v3) 0.58 0.01 -98.3% 2000.101: git diff-tree HEAD -- f2/f4/a (sparse-v4) 0.55 0.01 -98.2%

Signed-off-by: Shuqi Liang <cheskaqiqi@gmail.com>
---
 builtin/diff-tree.c                      |  4 ++
 t/perf/p2000-sparse-operations.sh        |  2 +
 t/t1092-sparse-checkout-compatibility.sh | 62 ++++++++++++++++++++++++
 3 files changed, 68 insertions(+)
diff --git a/builtin/diff-tree.c b/builtin/diff-tree.c
index 385c2d0230..c5d5730ebf 100644
--- a/builtin/diff-tree.c
+++ b/builtin/diff-tree.c
@@ -121,6 +121,10 @@ int cmd_diff_tree(int argc, const char **argv, const char *prefix)
 		usage(diff_tree_usage);
 
 	git_config(git_diff_basic_config, NULL); /* no "diff" UI options */
+
+	prepare_repo_settings(the_repository);
+	the_repository->settings.command_requires_full_index = 0;
+
 	repo_init_revisions(the_repository, opt, prefix);
 	if (repo_read_index(the_repository) < 0)
 		die(_("index file corrupt"));
diff --git a/t/perf/p2000-sparse-operations.sh b/t/perf/p2000-sparse-operations.sh
index 60d1de0662..14caf01718 100755
--- a/t/perf/p2000-sparse-operations.sh
+++ b/t/perf/p2000-sparse-operations.sh
@@ -129,5 +129,7 @@ test_perf_on_all git grep --cached bogus -- "f2/f1/f1/*"
 test_perf_on_all git write-tree
 test_perf_on_all git describe --dirty
 test_perf_on_all 'echo >>new && git describe --dirty'
+test_perf_on_all git diff-tree HEAD
+test_perf_on_all git diff-tree HEAD -- $SPARSE_CONE/a
 
 test_done
diff --git a/t/t1092-sparse-checkout-compatibility.sh b/t/t1092-sparse-checkout-compatibility.sh
index 0c784813f1..f08edcbf8e 100755
--- a/t/t1092-sparse-checkout-compatibility.sh
+++ b/t/t1092-sparse-checkout-compatibility.sh
@@ -2108,4 +2108,66 @@ test_expect_success 'sparse-index is not expanded: write-tree' '
 	ensure_not_expanded write-tree
 '
 
+test_expect_success 'diff-tree' '
+	init_repos &&
+
+	write_script edit-contents <<-\EOF &&
+	echo text >>"$1"
+	EOF
+
+	# Get the tree SHA for the current HEAD
+	tree1=$(git -C sparse-index rev-parse HEAD^{tree}) &&
+
+	# make a change inside the sparse cone
+	run_on_all ../edit-contents deep/a &&
+	test_all_match git add deep/a &&
+	test_all_match git commit -m "Change deep/a" &&
+
+	# Get the tree SHA for the new HEAD
+	tree2=$(git -C sparse-index rev-parse HEAD^{tree}) &&
+
+
+	test_all_match git diff-tree $tree1 $tree2 &&
+	test_all_match git diff-tree HEAD &&
+	test_all_match git diff-tree HEAD -- deep/a &&
+
+	# make a change outside the sparse cone
+	run_on_all mkdir -p folder1 &&
+	run_on_all cp a folder1/a &&
+	run_on_all ../edit-contents folder1/a &&
+	test_all_match git update-index folder1/a &&
+	test_all_match git commit -m "Change folder1/a" &&
+
+	# Get the tree SHA for the new HEAD
+	tree3=$(git -C sparse-index rev-parse HEAD^{tree}) &&
+
+	test_all_match git diff-tree $tree1 $tree3 &&
+	test_all_match git diff-tree $tree1 $tree3 -- folder1/a &&
+	test_all_match git diff-tree HEAD &&
+	test_all_match git diff-tree HEAD -- folder1/a &&
+
+	# check that SKIP_WORKTREE files are not materialized
+	test_path_is_missing sparse-checkout/folder2/a &&
+	test_path_is_missing sparse-index/folder2/a
+'
+
+test_expect_success 'sparse-index is not expanded: diff-tree' '
+	init_repos &&
+
+	# Get the tree SHA for the current HEAD
+	tree1=$(git -C sparse-index rev-parse HEAD^{tree}) &&
+
+	echo "test1" >>sparse-index/deep/a &&
+	git -C sparse-index add deep/a &&
+	git -C sparse-index commit -m "Change deep/a" &&
+
+	# Get the tree SHA for the new HEAD
+	tree2=$(git -C sparse-index rev-parse HEAD^{tree}) &&
+
+	ensure_not_expanded diff-tree $tree1 $tree2 &&
+	ensure_not_expanded diff-tree $tree1 $tree2 -- deep/a &&
+	ensure_not_expanded diff-tree HEAD &&
+	ensure_not_expanded diff-tree HEAD -- deep/a
+'
+
 test_done
-- 
2.39.0
Next: Victoria Dye
Message 1 of 7 in “diff-tree: integrate with sparse index”
  1. Shuqi LiangMay 15, 2023
  2. Victoria DyeMay 16, 2023
  3. Junio C HamanoMay 16, 2023
  4. Victoria DyeMay 17, 2023
  5. diff-tree: integrate with sparse indexShuqi Liang, May 18, 2023
  6. Victoria DyeMay 22, 2023
  7. Junio C HamanoMay 23, 2023

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.