@matheusbsbs / matheus-bagliano / commits / 35682ada44

checkout-index: integrate with sparse index

Add repository settings to allow usage of the sparse index. When using the `--all` option, sparse directories are ignored by default due to the `skip-worktree` flag, so there is no need to expand the index. If `--ignore-skip-worktree-bits` is specified, the index is expanded in order to check out all files. When checking out individual files, existing behavior in a full index is to exit with an error if a directory is specified (as the directory name will not match an index entry). However, it is possible in a sparse index to match a directory name to a sparse directory index entry, but checking out that sparse directory still results in an error on checkout. To reduce some potential confusion for users, `checkout_file(...)` explicitly exits with an informative error if provided with a sparse directory name. The test corresponding to this scenario verifies the error message, which now differs between sparse index and non-sparse index checkouts. 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 35682ada44554e136677649ac3da8c92342cdae2

2 files changed +36 -3

builtin/checkout-index.c

+26 -2

@@ -67,6 +67,7 @@ static int checkout_file(const char *name, const char *prefix)

67 int namelen = strlen(name);

68 int pos = cache_name_pos(name, namelen);

69 int has_same_name = 0;

70 + int is_file = 0;

71 int is_skipped = 1;

72 int did_checkout = 0;

73 int errs = 0;

@@ -81,6 +82,9 @@ static int checkout_file(const char *name, const char *prefix)

82 break;

83 has_same_name = 1;

84 pos++;

85 + if (S_ISSPARSEDIR(ce->ce_mode))

86 + break;

87 + is_file = 1;

88 if (!ignore_skip_worktree && ce_skip_worktree(ce))

89 break;

90 is_skipped = 0;

@@ -112,6 +116,8 @@ static int checkout_file(const char *name, const char *prefix)

116 fprintf(stderr, "git checkout-index: %s ", name);

117 if (!has_same_name)

118 fprintf(stderr, "is not in the cache");

119 + else if (!is_file)

120 + fprintf(stderr, "is a sparse directory");

121 else if (is_skipped)

122 fprintf(stderr, "has skip-worktree enabled; "

123 "use '--ignore-skip-worktree-bits' to checkout");

@@ -130,10 +136,25 @@ static int checkout_all(const char *prefix, int prefix_length)

136 int i, errs = 0;

137 struct cache_entry *last_ce = NULL;

138

133 - /* TODO: audit for interaction with sparse-index. */

134 - ensure_full_index(&the_index);

139 for (i = 0; i < active_nr ; i++) {

140 struct cache_entry *ce = active_cache[i];

141 +

142 + if (S_ISSPARSEDIR(ce->ce_mode)) {

143 + if (!ce_skip_worktree(ce))

144 + BUG("sparse directory '%s' does not have skip-worktree set", ce->name);

145 +

146 + /*

147 + * If the current entry is a sparse directory and skip-worktree

148 + * entries are being checked out, expand the index and continue

149 + * the loop on the current index position (now pointing to the

150 + * first entry inside the expanded sparse directory).

151 + */

152 + if (ignore_skip_worktree) {

153 + ensure_full_index(&the_index);

154 + ce = active_cache[i];

155 + }

156 + }

157 +

158 if (!ignore_skip_worktree && ce_skip_worktree(ce))

159 continue;

160 if (ce_stage(ce) != checkout_stage

@@ -225,6 +246,9 @@ int cmd_checkout_index(int argc, const char **argv, const char *prefix)

246 git_config(git_default_config, NULL);

247 prefix_length = prefix ? strlen(prefix) : 0;

248

249 + prepare_repo_settings(the_repository);

250 + the_repository->settings.command_requires_full_index = 0;

251 +

252 if (read_cache() < 0) {

253 die("invalid cache");

254 }

t/t1092-sparse-checkout-compatibility.sh

+10 -1

@@ -801,7 +801,14 @@ test_expect_success 'checkout-index with folders' '

801 test_all_match test_must_fail git checkout-index -f -- deep/ &&

802

803 # Outside checkout definition

804 - test_all_match test_must_fail git checkout-index -f -- folder1/

804 + # Note: although all tests fail (as expected), the messaging differs. For

805 + # non-sparse index checkouts, the error is that the "file" does not appear

806 + # in the index; for sparse checkouts, the error is explicitly that the

807 + # entry is a sparse directory.

808 + run_on_all test_must_fail git checkout-index -f -- folder1/ &&

809 + test_cmp full-checkout-err sparse-checkout-err &&

810 + ! test_cmp full-checkout-err sparse-index-err &&

811 + grep "is a sparse directory" sparse-index-err

812 '

813

814 test_expect_success 'checkout-index --all' '

@@ -972,6 +979,8 @@ test_expect_success 'sparse-index is not expanded' '

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

980 ensure_not_expanded add . &&

981

982 + ensure_not_expanded checkout-index -f a &&

983 + ensure_not_expanded checkout-index -f --all &&

984 for ref in update-deep update-folder1 update-folder2 update-deep

985 do

986 echo >>sparse-index/README.md &&