kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

Merge branch 'ds/restore-sparse-index' 

'git restore --staged' has been optimized to avoid unnecessarily expanding
the sparse index when operating on paths within the sparse checkout
definition, by handling sparse directory entries at the tree level.

* ds/restore-sparse-index:
  restore: avoid sparse index expansion
  t1092: test 'git restore' with sparse index
main
Junio C Hamano 2026-06-07 23:58:24 +09:00
parent 17204228cf 105aacd072
commit 7450009e6f
2 changed files with 109 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
builtin/checkout.c
View File

@ -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);


50
t/t1092-sparse-checkout-compatibility.sh
View File

@ -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 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_not_expanded restore --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_not_expanded restore --source update-folder1 --staged .
'

test_done