sparse-index: silently return when not using cone-mode patterns

While the sparse-index is only enabled when core.sparseCheckoutCone is also enabled, it is possible for the user to modify the sparse-checkout file manually in a way that does not match cone-mode patterns. In this case, we should refuse to convert an index into a sparse index, since the sparse_checkout_patterns will not be initialized with recursive and parent path hashsets. Also silently return if there are no cache entries, which is a simple case: there are no paths to make sparse! Signed-off-by: Derrick Stolee <dstolee@microsoft.com> Reviewed-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Derrick Stolee committed Sep 8, 2021 at 01:42 UTC e27eab45c758bf194157b819fae4fd0fcce498fb
1 file changed +11 -5
sparse-index.c
+11 -5
@@ -130,7 +130,7 @@ static int index_has_unmerged_entries(struct index_state *istate)
130 int convert_to_sparse(struct index_state *istate)
131 {
132 int test_env;
133 - if (istate->split_index || istate->sparse_index ||
133 + if (istate->split_index || istate->sparse_index || !istate->cache_nr ||
134 !core_apply_sparse_checkout || !core_sparse_checkout_cone)
135 return 0;
136
@@ -158,10 +158,16 @@ int convert_to_sparse(struct index_state *istate)
158 return 0;
159 }
160
161 - if (!istate->sparse_checkout_patterns->use_cone_patterns) {
162 - warning(_("attempting to use sparse-index without cone mode"));
163 - return -1;
164 - }
161 + /*
162 + * We need cone-mode patterns to use sparse-index. If a user edits
163 + * their sparse-checkout file manually, then we can detect during
164 + * parsing that they are not actually using cone-mode patterns and
165 + * hence we need to abort this conversion _without error_. Warnings
166 + * already exist in the pattern parsing to inform the user of their
167 + * bad patterns.
168 + */
169 + if (!istate->sparse_checkout_patterns->use_cone_patterns)
170 + return 0;
171
172 /*
173 * NEEDSWORK: If we have unmerged entries, then stay full.