@matheusbsbs / matheus-bagliano / commits / 7ca4fc8819

sparse-index: update do_read_index to ensure correct sparsity

Unless `command_requires_full_index` forces index expansion, ensure in-core index sparsity matches config settings on read by calling `ensure_correct_sparsity`. This makes the behavior of the in-core index more consistent between different methods of updating sparsity: manually changing the `index.sparse` config setting vs. executing `git sparse-checkout --[no-]sparse-index init` Although index sparsity is normally updated with `git sparse-checkout init`, ensuring correct sparsity after a manual `index.sparse` change has some practical benefits: 1. It allows for command-by-command sparsity toggling with `-c index.sparse=<true|false>`, e.g. when troubleshooting issues with the sparse index. 2. It prevents users from experiencing abnormal slowness after setting `index.sparse` to `true` due to use of a full index in all commands until the on-disk index is updated. Helped-by: Junio C Hamano <gitster@pobox.com> Co-authored-by: Derrick Stolee <dstolee@microsoft.com> 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 Nov 23, 2021 at 00:20 UTC 7ca4fc8819e60bbeb21a8684af182d321b338c47

2 files changed +39

read-cache.c

@@ -2337,9 +2337,17 @@ int do_read_index(struct index_state *istate, const char *path, int must_exist)

2337

2338 if (!istate->repo)

2339 istate->repo = the_repository;

2340 +

2341 + /*

2342 + * If the command explicitly requires a full index, force it

2343 + * to be full. Otherwise, correct the sparsity based on repository

2344 + * settings and other properties of the index (if necessary).

2345 + */

2346 prepare_repo_settings(istate->repo);

2347 if (istate->repo->settings.command_requires_full_index)

2348 ensure_full_index(istate);

2349 + else

2350 + ensure_correct_sparsity(istate);

2351

2352 return istate->cache_nr;

2353

t/t1092-sparse-checkout-compatibility.sh

+31

@@ -694,6 +694,37 @@ test_expect_success 'sparse-index is expanded and converted back' '

694 test_region index ensure_full_index trace2.txt

695 '

696

697 +test_expect_success 'index.sparse disabled inline uses full index' '

698 + init_repos &&

699 +

700 + # When index.sparse is disabled inline with `git status`, the

701 + # index is expanded at the beginning of the execution then never

702 + # converted back to sparse. It is then written to disk as a full index.

703 + rm -f trace2.txt &&

704 + GIT_TRACE2_EVENT="$(pwd)/trace2.txt" GIT_TRACE2_EVENT_NESTING=10 \

705 + git -C sparse-index -c index.sparse=false status &&

706 + ! test_region index convert_to_sparse trace2.txt &&

707 + test_region index ensure_full_index trace2.txt &&

708 +

709 + # Since index.sparse is set to true at a repo level, the index

710 + # is converted from full to sparse when read, then never expanded

711 + # over the course of `git status`. It is written to disk as a sparse

712 + # index.

713 + rm -f trace2.txt &&

714 + GIT_TRACE2_EVENT="$(pwd)/trace2.txt" GIT_TRACE2_EVENT_NESTING=10 \

715 + git -C sparse-index status &&

716 + test_region index convert_to_sparse trace2.txt &&

717 + ! test_region index ensure_full_index trace2.txt &&

718 +

719 + # Now that the index has been written to disk as sparse, it is not

720 + # converted to sparse (or expanded to full) when read by `git status`.

721 + rm -f trace2.txt &&

722 + GIT_TRACE2_EVENT="$(pwd)/trace2.txt" GIT_TRACE2_EVENT_NESTING=10 \

723 + git -C sparse-index status &&

724 + ! test_region index convert_to_sparse trace2.txt &&

725 + ! test_region index ensure_full_index trace2.txt

726 +'

727 +

728 ensure_not_expanded () {

729 rm -f trace2.txt &&

730 echo >>sparse-index/untracked.txt &&