@matheusbsbs / matheus-bagliano / commits / 08032fa30f

gc: add `--expire-to` option

This commit extends the functionality of `git gc` by adding a new option, `--expire-to=<dir>`. Previously, this feature was implemented in 91badeba32 (builtin/repack.c: implement `--expire-to` for storing pruned objects, 2022-10-24), which allowing users to specify a directory where unreachable and expired cruft packs are stored during garbage collection. However, users had to run `git repack --cruft --expire-to=<dir>` followed by `git prune` to achieve similar results within `git gc`. By introducing `--expire-to=<dir>` directly into `git gc`, we simplify the process for users who wish to manage their repository's cleanup more efficiently. This change involves passing the `--expire-to=<dir>` parameter through to `git repack`, making it easier for users to set up a backup location for cruft packs that will be pruned. Due to the original `git gc --prune=now` deleting all unreachable objects by passing the `-a` parameter to git repack. With the addition of the `--cruft` and `--expire-to` options, it is necessary to modify this default behavior: instead of deleting these unreachable objects, they should be merged into a cruft pack and collected in a specified directory. Therefore, we do not pass `-a` to the repack command but instead pass `--cruft`, `--expire-to`, and `--cruft-expiration=now` to repack. Signed-off-by: ZheNing Hu <adlternative@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

ZheNing Hu committed Jan 24, 2025 at 07:49 UTC 08032fa30fefa3101bec4b774e79f4d091b516a6

3 files changed +47 -2

Documentation/git-gc.txt

@@ -69,6 +69,13 @@ be performed as well.

69 the `--max-cruft-size` option of linkgit:git-repack[1] for

70 more.

72 +--expire-to=<dir>::

73 + When packing unreachable objects into a cruft pack, write a cruft

74 + pack containing pruned objects (if any) to the directory `<dir>`.

75 + This option only has an effect when used together with `--cruft`.

76 + See the `--expire-to` option of linkgit:git-repack[1] for

77 + more information.

78 +

79 --prune=<date>::

80 Prune loose objects older than date (default is 2 weeks ago,

81 overridable by the config variable `gc.pruneExpire`).

builtin/gc.c

+7 -2

@@ -136,6 +136,7 @@ struct gc_config {

136 char *prune_worktrees_expire;

137 char *repack_filter;

138 char *repack_filter_to;

139 + char *repack_expire_to;

140 unsigned long big_pack_threshold;

141 unsigned long max_delta_cache_size;

142 };

@@ -432,7 +433,8 @@ static int keep_one_pack(struct string_list_item *item, void *data UNUSED)

433 static void add_repack_all_option(struct gc_config *cfg,

434 struct string_list *keep_pack)

435 {

435 - if (cfg->prune_expire && !strcmp(cfg->prune_expire, "now"))

436 + if (cfg->prune_expire && !strcmp(cfg->prune_expire, "now")

437 + && !(cfg->cruft_packs && cfg->repack_expire_to))

438 strvec_push(&repack, "-a");

439 else if (cfg->cruft_packs) {

440 strvec_push(&repack, "--cruft");

@@ -441,6 +443,8 @@ static void add_repack_all_option(struct gc_config *cfg,

443 if (cfg->max_cruft_size)

444 strvec_pushf(&repack, "--max-cruft-size=%lu",

445 cfg->max_cruft_size);

446 + if (cfg->repack_expire_to)

447 + strvec_pushf(&repack, "--expire-to=%s", cfg->repack_expire_to);

448 } else {

449 strvec_push(&repack, "-A");

450 if (cfg->prune_expire)

@@ -675,7 +679,6 @@ struct repository *repo UNUSED)

679 const char *prune_expire_sentinel = "sentinel";

680 const char *prune_expire_arg = prune_expire_sentinel;

681 int ret;

678 -

682 struct option builtin_gc_options[] = {

683 OPT__QUIET(&quiet, N_("suppress progress reporting")),

684 { OPTION_STRING, 0, "prune", &prune_expire_arg, N_("date"),

@@ -694,6 +697,8 @@ struct repository *repo UNUSED)

697 PARSE_OPT_NOCOMPLETE),

698 OPT_BOOL(0, "keep-largest-pack", &keep_largest_pack,

699 N_("repack all other packs except the largest pack")),

700 + OPT_STRING(0, "expire-to", &cfg.repack_expire_to, N_("dir"),

701 + N_("pack prefix to store a pack containing pruned objects")),

702 OPT_END()

703 };

704

t/t6500-gc.sh

+33

@@ -339,6 +339,39 @@ test_expect_success 'gc.maxCruftSize sets appropriate repack options' '

339 test_subcommand $cruft_max_size_opts --max-cruft-size=3145728 <trace2.txt

340 '

341

342 +test_expect_success '--expire-to sets repack --expire-to' '

343 + rm -rf expired &&

344 + mkdir expired &&

345 + expire_to="$(pwd)/expired/pack" &&

346 + GIT_TRACE2_EVENT=$(pwd)/trace2.txt git -C cruft--max-size gc --cruft --expire-to="$expire_to" &&

347 + test_subcommand $cruft_max_size_opts --expire-to="$expire_to" <trace2.txt

348 +'

349 +

350 +test_expect_success '--expire-to with --prune=now sets repack --expire-to' '

351 + rm -rf expired &&

352 + mkdir expired &&

353 + expire_to="$(pwd)/expired/pack" &&

354 + GIT_TRACE2_EVENT=$(pwd)/trace2.txt git -C cruft--max-size gc --cruft --prune=now --expire-to="$expire_to" &&

355 + test_subcommand git repack -d -l --cruft --cruft-expiration=now --expire-to="$expire_to" <trace2.txt

356 +'

357 +

358 +

359 +test_expect_success '--expire-to with --no-cruft sets repack -A' '

360 + rm -rf expired &&

361 + mkdir expired &&

362 + expire_to="$(pwd)/expired/pack" &&

363 + GIT_TRACE2_EVENT=$(pwd)/trace2.txt git -C cruft--max-size gc --no-cruft --expire-to="$expire_to" &&

364 + test_subcommand git repack -d -l -A --unpack-unreachable=2.weeks.ago <trace2.txt

365 +'

366 +

367 +test_expect_success '--expire-to with --no-cruft sets repack -a' '

368 + rm -rf expired &&

369 + mkdir expired &&

370 + expire_to="$(pwd)/expired/pack" &&

371 + GIT_TRACE2_EVENT=$(pwd)/trace2.txt git -C cruft--max-size gc --no-cruft --prune=now --expire-to="$expire_to" &&

372 + test_subcommand git repack -d -l -a <trace2.txt

373 +'

374 +

375 run_and_wait_for_gc () {

376 # We read stdout from gc for the side effect of waiting until the

377 # background gc process exits, closing its fd 9. Furthermore, the