[PATCH v3 2/3] rebase, cherry-pick, revert: run auto maintenance when done
- From
Thomas Bachem via GitGitGadget <gitgitgadget@gmail.com>
- Date
- Sep 8, 2026, 10:28 UTC
- Message-ID
- <68a728c5f43fdd7772a397954cd9f1a602614856.1788863286.git.gitgitgadget@gmail.com>
- In-Reply-To
- <pull.2217.v3.git.1788863286.gitgitgadget@gmail.com>
From: Thomas Bachem <mail@thomasbachem.com>
"git commit", "git merge", "git fetch" and "git am" run "git maintenance run --auto" when they are done, and so does the apply backend of "git rebase". That repacks the loose objects they wrote once there are enough of them, expires old rerere entries and does whatever other housekeeping is due.
The merge backend of "git rebase", "git cherry-pick" and "git revert" do not. They create their commits in process, so auto maintenance runs only when they spawn a command that runs it on its own. That is the "git commit" for a resolved conflict or an edited message, the "git merge" that "--rebase-merges" spawns for an octopus merge, a strategy other than ort or any strategy option, and whatever an exec runs. A sequence that needs none of these never runs auto maintenance. One that stops for conflicts runs it after each resolution, in the middle of the sequence.
Run it once when the sequence is done, like the apply backend does.
The apply backend leaves that to builtin/rebase.c: "git am" skips auto maintenance in rebasing mode, and finish_rebase() runs it once the patches are applied. Do the same for the sequencer, from builtin/rebase.c and builtin/revert.c, because the sequencer itself has no single place where every sequence ends. A sequence of several commits ends inside pick_commits(). A single cherry-pick or revert never creates the sequencer's state directory and returns to its caller as soon as its commit is made. "--continue" and "--skip" have entry points of their own. Nothing but those two builtins starts or continues a sequence, so that is where we run auto maintenance. run_specific_rebase() runs it for the merge backend once the sequencer has returned successfully and removed its state directory, which it keeps while the rebase is stopped. run_sequencer() runs it for cherry-pick and revert when a pick, a "--continue" or a "--skip" returns successfully.
For the user, a sequence that never stops now runs auto maintenance once when it is done, where it never ran it before. That is the same "git maintenance run --auto --detach" as after "git commit": it detaches into the background by default and does nothing unless one of its tasks is due. The runs from the commands a sequence spawns stay for now. The next commit removes them, so that a sequence runs auto maintenance exactly once.
Assisted-by: Claude Fable 5.1 Signed-off-by: Thomas Bachem <mail@thomasbachem.com> --- builtin/rebase.c | 13 ++++++++++--- builtin/revert.c | 19 ++++++++++++------- t/t3418-rebase-continue.sh | 12 ++++++++++++ t/t3510-cherry-pick-sequence.sh | 23 +++++++++++++++++++++++ 4 files changed, 57 insertions(+), 10 deletions(-)
diff --git a/builtin/rebase.c b/builtin/rebase.c index 10a306310c..535db60181 100644 --- a/builtin/rebase.c +++ b/builtin/rebase.c @@ -762,9 +762,16 @@ static int run_specific_rebase(struct rebase_options *opts) if (opts->dont_finish_rebase) ; /* do nothing */ - else if (opts->type == REBASE_MERGE) - ; /* merge backend cleans up after itself */ - else if (status == 0) { + else if (opts->type == REBASE_MERGE) { + int quiet = !(opts->flags & (REBASE_NO_QUIET|REBASE_VERBOSE)); + + /* + * The sequencer cleans up after itself. Its state directory + * is gone once it is done, and stays while it is stopped. + */ + if (status == 0 && !is_directory(opts->state_dir)) + run_auto_maintenance(the_repository, quiet); + } else if (status == 0) { if (!file_exists(state_dir_path("stopped-sha", opts))) finish_rebase(opts); } else if (status == 2) { diff --git a/builtin/revert.c b/builtin/revert.c index bedc40f368..52100a20cb 100644 --- a/builtin/revert.c +++ b/builtin/revert.c @@ -8,6 +8,7 @@ #include "gettext.h" #include "revision.h" #include "rerere.h" +#include "run-command.h" #include "sequencer.h" #include "branch.h" @@ -116,7 +117,7 @@ static int run_sequencer(int argc, const char **argv, const char *prefix, const char *strategy = &sentinel_value; const char *gpg_sign = &sentinel_value; enum empty_action empty_opt = EMPTY_COMMIT_UNSPECIFIED; - int cmd = 0; + int cmd = 0, ret; struct option base_options[] = { OPT_CMDMODE(0, "quit", &cmd, N_("end revert or cherry-pick sequence"), 'q'), OPT_CMDMODE(0, "continue", &cmd, N_("resume revert or cherry-pick sequence"), 'c'), @@ -264,18 +265,22 @@ static int run_sequencer(int argc, const char **argv, const char *prefix, free(options); if (cmd == 'q') { - int ret = sequencer_remove_state(opts); + ret = sequencer_remove_state(opts); if (!ret) remove_branch_state(the_repository, 0); return ret; } - if (cmd == 'c') - return sequencer_continue(the_repository, opts); if (cmd == 'a') return sequencer_rollback(the_repository, opts); - if (cmd == 's') - return sequencer_skip(the_repository, opts); - return sequencer_pick_revisions(the_repository, opts); + if (cmd == 'c') + ret = sequencer_continue(the_repository, opts); + else if (cmd == 's') + ret = sequencer_skip(the_repository, opts); + else + ret = sequencer_pick_revisions(the_repository, opts); + if (!ret) + run_auto_maintenance(the_repository, opts->quiet); + return ret; } int cmd_revert(int argc, diff --git a/t/t3418-rebase-continue.sh b/t/t3418-rebase-continue.sh index cb5c3a1cb5..025787b5f2 100755 --- a/t/t3418-rebase-continue.sh +++ b/t/t3418-rebase-continue.sh @@ -395,4 +395,16 @@ test_orig_head () { test_orig_head --apply test_orig_head --merge +test_expect_success 'rebase runs auto maintenance once it is done' ' + git checkout -b auto-maintenance topic && + test_must_fail env GIT_TRACE2_EVENT="$(pwd)/stop.txt" \ + git rebase -x false main && + test_subcommand_flex ! git maintenance run --auto <stop.txt && + echo resolved >F2 && + git add F2 && + test_must_fail git rebase --continue && + GIT_TRACE2_EVENT="$(pwd)/end.txt" git rebase --continue && + test_subcommand_flex git maintenance run --auto <end.txt +' + test_done diff --git a/t/t3510-cherry-pick-sequence.sh b/t/t3510-cherry-pick-sequence.sh index 5777dff496..2bea55c3b6 100755 --- a/t/t3510-cherry-pick-sequence.sh +++ b/t/t3510-cherry-pick-sequence.sh @@ -721,4 +721,27 @@ test_expect_success 'commit descriptions in insn sheet are optional' ' test_line_count = 4 commits ' +test_expect_success 'cherry-pick runs auto maintenance once it is done' ' + pristine_detach base && + GIT_TRACE2_EVENT="$(pwd)/single.txt" git cherry-pick picked && + test_subcommand_flex git maintenance run --auto <single.txt && + GIT_TRACE2_EVENT="$(pwd)/sequence.txt" \ + git cherry-pick anotherpick yetanotherpick && + test_subcommand_flex git maintenance run --auto <sequence.txt && + grep "\"child_start\".*\"maintenance\"" sequence.txt >maintenance && + test_line_count = 1 maintenance +' + +test_expect_success 'cherry-pick runs auto maintenance once a stopped sequence is done' ' + pristine_detach initial && + test_must_fail env GIT_TRACE2_EVENT="$(pwd)/stop.txt" \ + git cherry-pick base..anotherpick && + test_subcommand_flex ! git maintenance run --auto <stop.txt && + echo resolved >foo && + git add foo && + test_must_fail git cherry-pick --continue && + GIT_TRACE2_EVENT="$(pwd)/end.txt" git cherry-pick --skip && + test_subcommand_flex git maintenance run --auto <end.txt +' + test_done
-- gitgitgadget