Skip to content

Commit f74015a

Browse files
derrickstoleederrickstolee
committed
sparse-checkout: clear tracked sparse dirs
When changing the scope of a sparse-checkout using cone mode, we might have some tracked directories go out of scope. The current logic removes the tracked files from within those directories, but leaves the ignored files within those directories. This is a bit unexpected to users who have given input to Git saying they don't need those directories anymore. This is something that is new to the cone mode pattern type: the user has explicitly said "I want these directories and _not_ those directories." The typical sparse-checkout patterns more generally apply to "I want files with with these patterns" so it is natural to leave ignored files as they are. This focus on directories in cone mode provides us an opportunity to change the behavior. Leaving these ignored files in the sparse directories makes it impossible to gain performance benefits in the sparse index. When we track into these directories, we need to know if the files are ignored or not, which might depend on the _tracked_ .gitignore file(s) within the sparse directory. This depends on the indexed version of the file, so the sparse directory must be expanded. By deleting the sparse directories when changing scope (or running 'git sparse-checkout reapply') we regain these performance benefits as if the repository was in a clean state. Since these ignored files are frequently build output or helper files from IDEs, the users should not need the files now that the tracked files are removed. If the tracked files reappear, then they will have newer timestamps than the build artifacts, so the artifacts will need to be regenerated anyway. Use the sparse-index as a data structure in order to find the sparse directories that can be safely deleted. Re-expand the index to a full one if it was full before. Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
1 parent 1dd73b3 commit f74015a

File tree

3 files changed

+162
-0
lines changed

3 files changed

+162
-0
lines changed

‎Documentation/git-sparse-checkout.txt‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,14 @@ case-insensitive check. This corrects for case mismatched filenames in the
210210
'git sparse-checkout set' command to reflect the expected cone in the working
211211
directory.
212212

213+
The cone mode sparse-checkout patterns will also remove ignored files that
214+
are not within the sparse-checkout definition. This is important behavior
215+
to preserve the performance of the sparse index, but also matches that
216+
cone mode patterns care about directories, not files. If there exist files
217+
that are untracked and not ignored, then Git will not delete files within
218+
that directory other than the tracked files that are now out of scope.
219+
These files should be removed manually to ensure Git can behave optimally.
220+
213221

214222
SUBMODULES
215223
----------

‎builtin/sparse-checkout.c‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,99 @@ static int sparse_checkout_list(int argc, const char **argv)
100100
return 0;
101101
}
102102

103+
static void clean_tracked_sparse_directories(struct repository *r)
104+
{
105+
int i, was_full = 0;
106+
struct strbuf path = STRBUF_INIT;
107+
size_t pathlen;
108+
struct string_list_item *item;
109+
struct string_list sparse_dirs = STRING_LIST_INIT_DUP;
110+
111+
/*
112+
* If we are not using cone mode patterns, then we cannot
113+
* delete directories outside of the sparse cone.
114+
*/
115+
if (!r || !r->index || !r->worktree)
116+
return;
117+
init_sparse_checkout_patterns(r->index);
118+
if (!r->index->sparse_checkout_patterns ||
119+
!r->index->sparse_checkout_patterns->use_cone_patterns)
120+
return;
121+
122+
/*
123+
* Use the sparse index as a data structure to assist finding
124+
* directories that are safe to delete. This conversion to a
125+
* sparse index will not delete directories that contain
126+
* conflicted entries or submodules.
127+
*/
128+
if (!r->index->sparse_index) {
129+
/*
130+
* If something, such as a merge conflict or other concern,
131+
* prevents us from converting to a sparse index, then do
132+
* not try deleting files.
133+
*/
134+
if (convert_to_sparse(r->index, SPARSE_INDEX_IGNORE_CONFIG))
135+
return;
136+
was_full = 1;
137+
}
138+
139+
strbuf_addstr(&path, r->worktree);
140+
strbuf_complete(&path, '/');
141+
pathlen = path.len;
142+
143+
/*
144+
* Collect directories that have gone out of scope but also
145+
* exist on disk, so there is some work to be done. We need to
146+
* store the entries in a list before exploring, since that might
147+
* expand the sparse-index again.
148+
*/
149+
for (i = 0; i < r->index->cache_nr; i++) {
150+
struct cache_entry *ce = r->index->cache[i];
151+
152+
if (S_ISSPARSEDIR(ce->ce_mode) &&
153+
repo_file_exists(r, ce->name))
154+
string_list_append(&sparse_dirs, ce->name);
155+
}
156+
157+
for_each_string_list_item(item, &sparse_dirs) {
158+
struct dir_struct dir = DIR_INIT;
159+
struct pathspec p = { 0 };
160+
struct strvec s = STRVEC_INIT;
161+
162+
strbuf_setlen(&path, pathlen);
163+
strbuf_addstr(&path, item->string);
164+
165+
dir.flags |= DIR_SHOW_IGNORED_TOO;
166+
167+
setup_standard_excludes(&dir);
168+
strvec_push(&s, path.buf);
169+
170+
parse_pathspec(&p, PATHSPEC_GLOB, 0, NULL, s.v);
171+
fill_directory(&dir, r->index, &p);
172+
173+
if (dir.nr) {
174+
warning(_("directory '%s' contains untracked files,"
175+
" but is not in the sparse-checkout cone"),
176+
item->string);
177+
} else if (remove_dir_recursively(&path, 0)) {
178+
/*
179+
* Removal is "best effort". If something blocks
180+
* the deletion, then continue with a warning.
181+
*/
182+
warning(_("failed to remove directory '%s'"),
183+
item->string);
184+
}
185+
186+
dir_clear(&dir);
187+
}
188+
189+
string_list_clear(&sparse_dirs, 0);
190+
strbuf_release(&path);
191+
192+
if (was_full)
193+
ensure_full_index(r->index);
194+
}
195+
103196
static int update_working_directory(struct pattern_list *pl)
104197
{
105198
enum update_sparsity_result result;
@@ -141,6 +234,8 @@ static int update_working_directory(struct pattern_list *pl)
141234
else
142235
rollback_lock_file(&lock_file);
143236

237+
clean_tracked_sparse_directories(r);
238+
144239
r->index->sparse_checkout_patterns = NULL;
145240
return result;
146241
}

‎t/t1091-sparse-checkout-builtin.sh‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -642,4 +642,63 @@ test_expect_success MINGW 'cone mode replaces backslashes with slashes' '
642642
check_files repo/deep a deeper1
643643
'
644644

645+
test_expect_success 'cone mode clears ignored subdirectories' '
646+
rm repo/.git/info/sparse-checkout &&
647+
648+
git -C repo sparse-checkout init --cone &&
649+
git -C repo sparse-checkout set deep/deeper1 &&
650+
651+
cat >repo/.gitignore <<-\EOF &&
652+
obj/
653+
*.o
654+
EOF
655+
656+
git -C repo add .gitignore &&
657+
git -C repo commit -m ".gitignore" &&
658+
659+
mkdir -p repo/obj repo/folder1/obj repo/deep/deeper2/obj &&
660+
for file in folder1/obj/a obj/a folder1/file.o folder1.o \
661+
deep/deeper2/obj/a deep/deeper2/file.o file.o
662+
do
663+
echo ignored >repo/$file || return 1
664+
done &&
665+
666+
git -C repo status --porcelain=v2 >out &&
667+
test_must_be_empty out &&
668+
669+
git -C repo sparse-checkout reapply &&
670+
test_path_is_missing repo/folder1 &&
671+
test_path_is_missing repo/deep/deeper2 &&
672+
test_path_is_dir repo/obj &&
673+
test_path_is_file repo/file.o &&
674+
675+
git -C repo status --porcelain=v2 >out &&
676+
test_must_be_empty out &&
677+
678+
git -C repo sparse-checkout set deep/deeper2 &&
679+
test_path_is_missing repo/deep/deeper1 &&
680+
test_path_is_dir repo/deep/deeper2 &&
681+
test_path_is_dir repo/obj &&
682+
test_path_is_file repo/file.o &&
683+
684+
>repo/deep/deeper2/ignored.o &&
685+
>repo/deep/deeper2/untracked &&
686+
687+
# When an untracked file is in the way, all untracked files
688+
# (even ignored files) are preserved.
689+
git -C repo sparse-checkout set folder1 2>err &&
690+
grep "contains untracked files" err &&
691+
test_path_is_file repo/deep/deeper2/ignored.o &&
692+
test_path_is_file repo/deep/deeper2/untracked &&
693+
694+
# The rest of the cone matches expectation
695+
test_path_is_missing repo/deep/deeper1 &&
696+
test_path_is_dir repo/obj &&
697+
test_path_is_file repo/file.o &&
698+
699+
git -C repo status --porcelain=v2 >out &&
700+
echo "? deep/deeper2/untracked" >expect &&
701+
test_cmp expect out
702+
'
703+
645704
test_done

0 commit comments

Comments
 (0)