update-index: integrate with sparse index

Enable use of the sparse index with `update-index`. Most variations of `update-index` work without explicitly expanding the index or making any other updates in or outside of `update-index.c`. The one usage requiring additional changes is `--cacheinfo`; if a file inside a sparse directory was specified, the index would not be expanded until after the cache tree is invalidated, leading to a mismatch between the index and cache tree. This scenario is handled by rearranging `add_index_entry_with_check`, allowing `index_name_stage_pos` to expand the index *before* attempting to invalidate the relevant cache tree path, avoiding cache tree/index corruption. Signed-off-by: Victoria Dye <vdye@github.com> Reviewed-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Victoria Dye committed Jan 11, 2022 at 18:05 UTC c35e9f5ecd00f0c003dc9120d3c68e95e2ba3bd7
3 files changed +25 -3
builtin/update-index.c
+3
@@ -1077,6 +1077,9 @@ int cmd_update_index(int argc, const char **argv, const char *prefix)
1077
1078 git_config(git_default_config, NULL);
1079
1080 + prepare_repo_settings(r);
1081 + the_repository->settings.command_requires_full_index = 0;
1082 +
1083 /* we will diagnose later if it turns out that we need to update it */
1084 newfd = hold_locked_index(&lock_file, 0);
1085 if (newfd < 0)
read-cache.c
+7 -3
@@ -1339,9 +1339,6 @@ static int add_index_entry_with_check(struct index_state *istate, struct cache_e
1339 int skip_df_check = option & ADD_CACHE_SKIP_DFCHECK;
1340 int new_only = option & ADD_CACHE_NEW_ONLY;
1341
1342 - if (!(option & ADD_CACHE_KEEP_CACHE_TREE))
1343 - cache_tree_invalidate_path(istate, ce->name);
1344 -
1342 /*
1343 * If this entry's path sorts after the last entry in the index,
1344 * we can avoid searching for it.
@@ -1352,6 +1349,13 @@ static int add_index_entry_with_check(struct index_state *istate, struct cache_e
1349 else
1350 pos = index_name_stage_pos(istate, ce->name, ce_namelen(ce), ce_stage(ce), EXPAND_SPARSE);
1351
1352 + /*
1353 + * Cache tree path should be invalidated only after index_name_stage_pos,
1354 + * in case it expands a sparse index.
1355 + */
1356 + if (!(option & ADD_CACHE_KEEP_CACHE_TREE))
1357 + cache_tree_invalidate_path(istate, ce->name);
1358 +
1359 /* existing match? Just replace it. */
1360 if (pos >= 0) {
1361 if (!new_only)
t/t1092-sparse-checkout-compatibility.sh
+15
@@ -1253,6 +1253,21 @@ test_expect_success 'sparse index is not expanded: diff' '
1253 ensure_not_expanded diff --cached
1254 '
1255
1256 +test_expect_success 'sparse index is not expanded: update-index' '
1257 + init_repos &&
1258 +
1259 + deep_a_oid=$(git -C full-checkout rev-parse update-deep:deep/a) &&
1260 + ensure_not_expanded update-index --cacheinfo 100644 $deep_a_oid deep/a &&
1261 +
1262 + echo "test" >sparse-index/README.md &&
1263 + echo "test2" >sparse-index/a &&
1264 + rm -f sparse-index/deep/a &&
1265 +
1266 + ensure_not_expanded update-index --add README.md &&
1267 + ensure_not_expanded update-index a &&
1268 + ensure_not_expanded update-index --remove deep/a
1269 +'
1270 +
1271 test_expect_success 'sparse index is not expanded: blame' '
1272 init_repos &&
1273