From ca7b9ae3403b1a46fffbdae312092c4029470eee Mon Sep 17 00:00:00 2001 From: Derrick Stolee Date: Tue, 26 May 2026 20:26:33 +0000 Subject: [PATCH 1/2] t1092: test 'git restore' with sparse index A user reported that 'git restore --staged .' causes the sparse index to expand. This is somewhat natural because the '.' pathspec means 'check every path'. However, the restore will not update paths marked with the SKIP_WORKTREE bit, so we shouldn't need to process such entries. For now, establish the current behavior, including the sparse index expansion, in the t1092 test case as a baseline. Signed-off-by: Derrick Stolee Signed-off-by: Junio C Hamano --- t/t1092-sparse-checkout-compatibility.sh | 50 ++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/t/t1092-sparse-checkout-compatibility.sh b/t/t1092-sparse-checkout-compatibility.sh index d98cb4ac11..d69434e7ab 100755 --- a/t/t1092-sparse-checkout-compatibility.sh +++ b/t/t1092-sparse-checkout-compatibility.sh @@ -2573,4 +2573,54 @@ test_expect_success 'sparse-index is not expanded: merge-ours' ' ensure_not_expanded merge -s ours merge-right ' +test_expect_success 'restore --staged with sparse definition' ' + init_repos && + + # Stage changes within the sparse definition + test_all_match git checkout -b restore-staged-1 base && + test_all_match git reset --soft update-deep && + test_all_match git restore --staged . && + test_all_match git status --porcelain=v2 && + test_all_match git diff --cached +' + +test_expect_success 'restore --staged with outside sparse definition' ' + init_repos && + + # Stage changes that include paths outside the sparse definition. + # Although the working tree differs between full and sparse checkouts + # after restore, the state of the index should be the same. + test_all_match git checkout -b restore-staged-2 base && + test_all_match git reset --soft update-folder1 && + test_sparse_match git restore --staged . && + git -C full-checkout restore --staged . && + test_all_match git ls-files -s -- folder1 && + test_all_match git diff --cached -- folder1 +' + +test_expect_success 'restore --staged with wildcards' ' + init_repos && + + test_all_match git checkout -b restore-staged-3 base && + test_all_match git reset --soft update-deep && + test_all_match git restore --staged "deep/*" && + test_all_match git status --porcelain=v2 && + test_all_match git diff --cached +' + +test_expect_success 'sparse-index is expanded: restore --staged' ' + init_repos && + + git -C sparse-index checkout -b restore-staged-exp base && + git -C sparse-index reset --soft update-folder1 && + ensure_expanded restore --staged . +' + +test_expect_success 'sparse-index is expanded: restore --source --staged' ' + init_repos && + + git -C sparse-index checkout -b restore-source-staged base && + ensure_expanded restore --source update-folder1 --staged . +' + test_done From 105aacd072e41c55948d016b46f86f75db2487b3 Mon Sep 17 00:00:00 2001 From: Derrick Stolee Date: Tue, 26 May 2026 20:26:34 +0000 Subject: [PATCH 2/2] restore: avoid sparse index expansion Teach update_some() to handle sparse directory entries at the tree level rather than expanding the entire sparse index. When iterating a source tree during checkout/restore operations: - If a directory matches a sparse directory entry with the same OID, skip it entirely (no change needed). - If the OID differs and we are in non-overlay mode (e.g., restore --staged), update the sparse directory entry's OID in place. This is semantically correct because non-overlay mode removes paths not in the source tree anyway. - In overlay mode (e.g., checkout -- .), fall through to recursive descent so individual file entries are preserved correctly. Also switch from index_name_pos() to index_name_pos_sparse() for individual file lookups to avoid triggering ensure_full_index() when the file is already individually tracked in the index. Update the test expectation in t1092 to assert that 'restore --staged' no longer expands the sparse index. Signed-off-by: Derrick Stolee Signed-off-by: Junio C Hamano --- builtin/checkout.c | 65 +++++++++++++++++++++--- t/t1092-sparse-checkout-compatibility.sh | 8 +-- 2 files changed, 63 insertions(+), 10 deletions(-) diff --git a/builtin/checkout.c b/builtin/checkout.c index 1345e8574a..86e23a07b1 100644 --- a/builtin/checkout.c +++ b/builtin/checkout.c @@ -31,6 +31,7 @@ #include "revision.h" #include "sequencer.h" #include "setup.h" +#include "sparse-index.h" #include "strvec.h" #include "submodule.h" #include "symlinks.h" @@ -141,15 +142,65 @@ static int post_checkout_hook(struct commit *old_commit, struct commit *new_comm return run_hooks_opt(the_repository, "post-checkout", &opt); } +/* + * Handle a tree object and determine if we need to recurse into the + * tree (READ_TREE_RECURSIVE) or skip it (0). + */ +static int try_update_sparse_directory(const struct object_id *oid, + struct strbuf *base, + const char *pathname, + int overlay_mode) +{ + struct strbuf dirpath = STRBUF_INIT; + struct cache_entry *old; + int pos, result = READ_TREE_RECURSIVE; + + if (!the_repository->index->sparse_index) + return result; + + strbuf_addbuf(&dirpath, base); + strbuf_addstr(&dirpath, pathname); + strbuf_addch(&dirpath, '/'); + + pos = index_name_pos_sparse(the_repository->index, + dirpath.buf, dirpath.len); + if (pos < 0) + goto cleanup; + + old = the_repository->index->cache[pos]; + if (!S_ISSPARSEDIR(old->ce_mode)) + goto cleanup; + + if (oideq(oid, &old->oid)) { + /* Tree content already matches; no need to descend. */ + result = 0; + } else if (!overlay_mode) { + /* + * In non-overlay mode (e.g., restore --staged), replace the + * sparse directory OID directly since files not present in + * the source tree should be removed anyway. + */ + oidcpy(&old->oid, oid); + old->ce_flags |= CE_UPDATE; + result = 0; + } + +cleanup: + strbuf_release(&dirpath); + return result; +} + static int update_some(const struct object_id *oid, struct strbuf *base, - const char *pathname, unsigned mode, void *context UNUSED) + const char *pathname, unsigned mode, void *context) { int len; struct cache_entry *ce; int pos; + int overlay_mode = context ? *((int *)context) : 1; if (S_ISDIR(mode)) - return READ_TREE_RECURSIVE; + return try_update_sparse_directory(oid, base, pathname, + overlay_mode); len = base->len + strlen(pathname); ce = make_empty_cache_entry(the_repository->index, len); @@ -165,7 +216,7 @@ static int update_some(const struct object_id *oid, struct strbuf *base, * entry in place. Whether it is UPTODATE or not, checkout_entry will * do the right thing. */ - pos = index_name_pos(the_repository->index, ce->name, ce->ce_namelen); + pos = index_name_pos_sparse(the_repository->index, ce->name, ce->ce_namelen); if (pos >= 0) { struct cache_entry *old = the_repository->index->cache[pos]; if (ce->ce_mode == old->ce_mode && @@ -182,10 +233,11 @@ static int update_some(const struct object_id *oid, struct strbuf *base, return 0; } -static int read_tree_some(struct tree *tree, const struct pathspec *pathspec) +static int read_tree_some(struct tree *tree, const struct pathspec *pathspec, + int overlay_mode) { read_tree(the_repository, tree, - pathspec, update_some, NULL); + pathspec, update_some, &overlay_mode); /* update the index with the given tree's info * for all args, expanding wildcards, and exit @@ -580,7 +632,8 @@ static int checkout_paths(const struct checkout_opts *opts, return error(_("index file corrupt")); if (opts->source_tree) - read_tree_some(opts->source_tree, &opts->pathspec); + read_tree_some(opts->source_tree, &opts->pathspec, + opts->overlay_mode); if (opts->merge) unmerge_index(the_repository->index, &opts->pathspec, CE_MATCHED); diff --git a/t/t1092-sparse-checkout-compatibility.sh b/t/t1092-sparse-checkout-compatibility.sh index d69434e7ab..8186da5c88 100755 --- a/t/t1092-sparse-checkout-compatibility.sh +++ b/t/t1092-sparse-checkout-compatibility.sh @@ -2608,19 +2608,19 @@ test_expect_success 'restore --staged with wildcards' ' test_all_match git diff --cached ' -test_expect_success 'sparse-index is expanded: restore --staged' ' +test_expect_success 'sparse-index is not expanded: restore --staged' ' init_repos && git -C sparse-index checkout -b restore-staged-exp base && git -C sparse-index reset --soft update-folder1 && - ensure_expanded restore --staged . + ensure_not_expanded restore --staged . ' -test_expect_success 'sparse-index is expanded: restore --source --staged' ' +test_expect_success 'sparse-index is not expanded: restore --source --staged' ' init_repos && git -C sparse-index checkout -b restore-source-staged base && - ensure_expanded restore --source update-folder1 --staged . + ensure_not_expanded restore --source update-folder1 --staged . ' test_done