Skip to contentSkip to conversation

backfill: auto-detect sparse-checkout from config

PATCH In review Trieu Huynh 3 participants 3 messages Apr 4 – Apr 6

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 backfill: auto-detect sparse-checkout from config

From: Trieu Huynh <[email protected]>

Commit 85127bcdea ("backfill: assume --sparse when sparse-checkout is enabled") intended for 'git backfill' to consult the repository configuration when the user does not pass '--sparse' or '--no-sparse' on the command line. It added the sentinel check:

    if (ctx->sparse < 0)
        ctx->sparse = cfg->apply_sparse_checkout;

However, the ctx->sparse field is initialized to 0 instead of -1, so this guard never triggers. Consequently, the repository config (core.sparseCheckout) is never checked, and the command always performs a full backfill even when sparse-checkout is enabled.

Fix this by initializing ctx->sparse to -1, ensuring the existing fallback logic correctly reads the repository configuration when no explicit flags are provided.

Add a test to verify that 'git backfill' automatically respects sparse-checkout settings when no flags are passed.

---
v2:
- Update commit message to explicitly point to addressing 85127bcdea.
- The code change itself is unchanged.

 builtin/backfill.c  |  2 +-
 t/t5620-backfill.sh | 15 +++++++++++++++
 2 files changed, 16 insertions(+), 1 deletion(-)
builtin/backfill.c +1 -1
index e80fc1b694..54acdfe290 100644
@@ -120,7 +120,7 @@ int cmd_backfill(int argc, const char **argv, const char *prefix, struct reposit
 		.repo = repo,
 		.current_batch = OID_ARRAY_INIT,
 		.min_batch_size = 50000,
-		.sparse = 0,
+		.sparse = -1,
 	};
 	struct option options[] = {
 		OPT_UNSIGNED(0, "min-batch-size", &ctx.min_batch_size,
t/t5620-backfill.sh +15 -0
index 58c81556e7..bed4987124 100755
@@ -119,6 +119,21 @@ test_expect_success 'backfill --sparse' '
 	test_line_count = 0 missing
 '
 
+test_expect_success 'backfill auto-detects sparse-checkout from config' '
+	git clone --sparse --filter=blob:none \
+		--single-branch --branch=main \
+		"file://$(pwd)/srv.bare" backfill-auto-sparse &&
+
+	git -C backfill-auto-sparse rev-list --quiet --objects --missing=print HEAD >missing &&
+	test_line_count = 44 missing &&
+
+	GIT_TRACE2_EVENT="$(pwd)/auto-sparse-trace" git \
+		-C backfill-auto-sparse backfill &&
+
+	test_trace2_data promisor fetch_count 4 <auto-sparse-trace &&
+	test_trace2_data path-walk paths 5 <auto-sparse-trace
+'
+
 test_expect_success 'backfill --sparse without cone mode (positive)' '
 	git clone --no-checkout --filter=blob:none		\
 		--single-branch --branch=main 		\
Signature · 1 line
2.43.0
#1 lore raw
Quoted 7 lines · Trieu Huynh

From: Trieu Huynh <[email protected]>

Commit 85127bcdea ("backfill: assume --sparse when sparse-checkout is enabled") intended for 'git backfill' to consult the repository configuration when the user does not pass '--sparse' or '--no-sparse' on the command line. It added the sentinel check:

Quoted 7 lines
     if (ctx->sparse < 0)
         ctx->sparse = cfg->apply_sparse_checkout;

However, the ctx->sparse field is initialized to 0 instead of -1, so this guard never triggers. Consequently, the repository config (core.sparseCheckout) is never checked, and the command always performs a full backfill even when sparse-checkout is enabled.

Thanks for adding this context. This patch LGTM.

nit: it helps to reply to your previous version [1] so the history of your patch series shows up in a single thread. No need to fix it now because this version should be final. I'm a fan of using GitGitGadget to avoid making these kinds of mistakes, but you can use 'git send-email --in-reply-to=<id>' [2] in the future.

[1] https://lore.kernel.org/git/[email protected]/

[2] https://git-scm.com/docs/git-send-email#Documentation/git-send-email.txt---in-reply-toidentifier

Thanks,
-Stolee

#2 lore raw
Quoted 11 lines · Derrick Stolee
Quoted 10 lines · Trieu Huynh

From: Trieu Huynh <[email protected]>

Commit 85127bcdea ("backfill: assume --sparse when sparse-checkout is enabled") intended for 'git backfill' to consult the repository configuration when the user does not pass '--sparse' or '--no-sparse' on the command line. It added the sentinel check:

     if (ctx->sparse < 0)
         ctx->sparse = cfg->apply_sparse_checkout;
Quoted 6 lines
Quoted 4 lines

However, the ctx->sparse field is initialized to 0 instead of -1, so this guard never triggers. Consequently, the repository config (core.sparseCheckout) is never checked, and the command always performs a full backfill even when sparse-checkout is enabled.

Thanks for adding this context. This patch LGTM.

Yup, thanks, both of you. The original patch without this explanation may not be so obvious but after taking a look at what that commit did, it is very clear what went wrong.