From: Phillip Wood Date: Mon, 18 May 2026 15:27:01 GMT Subject: Re: [PATCH v9 3/5] branch: add --prune-merged Message-ID: <6501a3d5-a5ec-421b-8526-ee7d4ae5ea98@gmail.com> In-Reply-To: Hi Harald On 13/05/2026 20:34, Harald Nordgren via GitGitGadget wrote: > From: Harald Nordgren > > Delete the local branches that --forked would list, but > only those whose tip is reachable from their configured upstream > remote-tracking branch (branch..merge): the work has already > landed on the upstream it tracks, so the local copy is no longer > needed. I think being able to prune branches that have been merged into their upstream is a good idea. However, I find the focus on remotes rather than upstream branches in the UI a bit confusing. While the upstream of a branch is often a remote tracking branch it doesn't have to be. For my personal projects I often do git checkout -b topic master and it would be nice to be able to run git branch --prune-merged master to clean up those topics that have been merged. Similarly I think it is confusing that git checkout -b topic origin starts a branch from the default branch on origin, but if I run git branch --prune-merged origin to clean it up, it will clean up all the branches with an upstream on origin, not just those whose upstream matches origin/HEAD. So I like the idea, but would prefer the arguments to --prune-merged to be upstream branches, not remotes. We could support globs so that git branch --prune-merges 'origin/*' would clean up all the branches whose upstream is on origin if that is useful. Thanks Phillip > A branch whose upstream no longer resolves locally is left alone -- > its disappearance is not, on its own, evidence that the work was > integrated. With --force, skip the reachability check and delete > every branch in the candidate set. The currently checked-out > branch in any worktree is always preserved, as is the local branch > that mirrors 's default branch. > > Reachability is read from whatever the remote-tracking refs say > locally, so the natural workflow is > > git fetch > git branch --prune-merged > > with no implicit cleanup driven by fetch itself. > > Signed-off-by: Harald Nordgren > --- > Documentation/git-branch.adoc | 19 +++++ > builtin/branch.c | 143 +++++++++++++++++++++++++++++----- > t/t3200-branch.sh | 83 ++++++++++++++++++++ > 3 files changed, 226 insertions(+), 19 deletions(-) > > diff --git a/Documentation/git-branch.adoc b/Documentation/git-branch.adoc > index 5773104cd3..375a0a68da 100644 > --- a/Documentation/git-branch.adoc > +++ b/Documentation/git-branch.adoc > @@ -25,6 +25,7 @@ git branch (-c|-C) [] > git branch (-d|-D) [-r] ... > git branch --edit-description [] > git branch --forked ... > +git branch --prune-merged ... > > DESCRIPTION > ----------- > @@ -211,6 +212,24 @@ Each __ may be either the name of a configured remote > `refs/remotes/origin/*` ref) or a specific remote-tracking branch > (e.g. `origin/master`). Multiple __ arguments are unioned. > > +`--prune-merged`:: > + Delete the local branches that `--forked` would list for > + the same __ arguments, but only those whose tip is > + reachable from their configured upstream remote-tracking > + branch (`branch..merge`). In other words: the work on > + the branch has already landed on the upstream it tracks, so > + the local copy is no longer needed. > ++ > +Run `git fetch` first so the upstream remote-tracking branches > +reflect the current state of __; reachability is checked > +against whatever the remote-tracking refs say locally. > ++ > +A branch whose upstream no longer resolves locally is left alone > +(its disappearance is not, on its own, evidence that the work was > +integrated). The currently checked-out branch in any worktree is > +always preserved, as is the local branch that mirrors __'s > +default branch. > + > `-v`:: > `-vv`:: > `--verbose`:: > diff --git a/builtin/branch.c b/builtin/branch.c > index 1941f8a9ad..6fe2ffd7e8 100644 > --- a/builtin/branch.c > +++ b/builtin/branch.c > @@ -21,6 +21,7 @@ > #include "branch.h" > #include "path.h" > #include "string-list.h" > +#include "strvec.h" > #include "column.h" > #include "utf8.h" > #include "ref-filter.h" > @@ -171,8 +172,8 @@ static int branch_merged(int kind, const char *name, > * any of the following code, but during the transition period, > * a gentle reminder is in order. > */ > - if (head_rev != reference_rev) { > - int expect = head_rev ? repo_in_merge_bases(the_repository, rev, head_rev) : 0; > + if (head_rev && head_rev != reference_rev) { > + int expect = repo_in_merge_bases(the_repository, rev, head_rev); > if (expect < 0) > exit(128); > if (expect == merged) > @@ -227,7 +228,9 @@ static void delete_branch_config(const char *branchname) > strbuf_release(&buf); > } > > -static int delete_branches(int argc, const char **argv, int force, int kinds, > +static int delete_branches(int argc, const char **argv, > + int no_head_fallback, > + int force, int kinds, > int quiet, int warn_only, int *n_not_merged) > { > struct commit *head_rev = NULL; > @@ -262,7 +265,7 @@ static int delete_branches(int argc, const char **argv, int force, int kinds, > } > branch_name_pos = strcspn(fmt, "%"); > > - if (!force) > + if (!force && !no_head_fallback) > head_rev = lookup_commit_reference(the_repository, &head_oid); > > for (i = 0; i < argc; i++, strbuf_reset(&bname)) { > @@ -317,8 +320,8 @@ static int delete_branches(int argc, const char **argv, int force, int kinds, > } > > if (!(flags & (REF_ISSYMREF|REF_ISBROKEN)) && > - check_branch_commit(bname.buf, name, &oid, head_rev, kinds, > - force, warn_only, n_not_merged)) { > + check_branch_commit(bname.buf, name, &oid, head_rev, > + kinds, force, warn_only, n_not_merged)) { > if (!warn_only) > ret = 1; > goto next; > @@ -753,36 +756,131 @@ static int collect_forked_branch(const struct reference *ref, void *cb_data) > return 0; > } > > -static int list_forked_branches(int argc, const char **argv) > +static void collect_default_branch_refs(const struct string_list *remote_names, > + struct string_list *out) > +{ > + struct ref_store *refs = get_main_ref_store(the_repository); > + struct string_list_item *item; > + > + for_each_string_list_item(item, remote_names) { > + struct strbuf head = STRBUF_INIT; > + const char *target; > + > + strbuf_addf(&head, "refs/remotes/%s/HEAD", item->string); > + target = refs_resolve_ref_unsafe(refs, head.buf, > + RESOLVE_REF_NO_RECURSE, > + NULL, NULL); > + if (target && starts_with(target, "refs/remotes/")) > + string_list_insert(out, target); > + strbuf_release(&head); > + } > +} > + > +static void collect_forked_set(int argc, const char **argv, > + struct string_list *protected_default_refs, > + struct string_list *out) > { > struct string_list remote_names = STRING_LIST_INIT_NODUP; > struct string_list tracking_refs = STRING_LIST_INIT_DUP; > - struct string_list out = STRING_LIST_INIT_DUP; > - struct string_list_item *item; > struct forked_cb cb = { > .remote_names = &remote_names, > .tracking_refs = &tracking_refs, > - .out = &out, > + .out = out, > }; > > - if (!argc) > - die(_("--forked requires at least one ")); > - > parse_forked_args(argc, argv, &remote_names, &tracking_refs); > > refs_for_each_branch_ref(get_main_ref_store(the_repository), > collect_forked_branch, &cb); > > - string_list_sort(&out); > - for_each_string_list_item(item, &out) > - puts(item->string); > + string_list_sort(out); > + > + if (protected_default_refs) > + collect_default_branch_refs(&remote_names, protected_default_refs); > > string_list_clear(&remote_names, 0); > string_list_clear(&tracking_refs, 0); > +} > + > +static int list_forked_branches(int argc, const char **argv) > +{ > + struct string_list out = STRING_LIST_INIT_DUP; > + struct string_list_item *item; > + > + if (!argc) > + die(_("--forked requires at least one ")); > + > + collect_forked_set(argc, argv, NULL, &out); > + for_each_string_list_item(item, &out) > + puts(item->string); > + > string_list_clear(&out, 0); > return 0; > } > > +static int prune_merged_branches(int argc, const char **argv, int quiet) > +{ > + struct string_list candidates = STRING_LIST_INIT_DUP; > + struct string_list protected_default_refs = STRING_LIST_INIT_DUP; > + struct strvec deletable = STRVEC_INIT; > + struct string_list_item *item; > + int n_not_merged = 0; > + int ret = 0; > + > + if (!argc) > + die(_("--prune-merged requires at least one ")); > + > + collect_forked_set(argc, argv, &protected_default_refs, &candidates); > + > + for_each_string_list_item(item, &candidates) { > + const char *short_name = item->string; > + struct strbuf full = STRBUF_INIT; > + struct branch *branch; > + const char *upstream; > + > + strbuf_addf(&full, "refs/heads/%s", short_name); > + if (branch_checked_out(full.buf)) { > + strbuf_release(&full); > + continue; > + } > + strbuf_release(&full); > + > + branch = branch_get(short_name); > + upstream = branch ? branch_get_upstream(branch, NULL) : NULL; > + if (!upstream || > + !refs_ref_exists(get_main_ref_store(the_repository), > + upstream)) > + continue; > + if (string_list_has_string(&protected_default_refs, upstream)) { > + const char *leaf = strrchr(upstream, '/'); > + if (leaf && !strcmp(leaf + 1, short_name)) > + continue; > + } > + > + strvec_push(&deletable, short_name); > + } > + > + if (deletable.nr) > + ret = delete_branches(deletable.nr, deletable.v, > + 1, 0, > + FILTER_REFS_BRANCHES, quiet, > + 1, &n_not_merged); > + > + if (n_not_merged && !quiet) > + fprintf(stderr, > + Q_("Skipped %d branch that is not fully merged; " > + "delete it with 'git branch -D' if you are sure.\n", > + "Skipped %d branches that are not fully merged; " > + "delete them with 'git branch -D' if you are sure.\n", > + n_not_merged), > + n_not_merged); > + > + strvec_clear(&deletable); > + string_list_clear(&candidates, 0); > + string_list_clear(&protected_default_refs, 0); > + return ret; > +} > + > static GIT_PATH_FUNC(edit_description, "EDIT_DESCRIPTION") > > static int edit_branch_description(const char *branch_name) > @@ -825,6 +923,7 @@ int cmd_branch(int argc, > int delete = 0, rename = 0, copy = 0, list = 0, > unset_upstream = 0, show_current = 0, edit_description = 0; > int forked = 0; > + int prune_merged = 0; > const char *new_upstream = NULL; > int noncreate_actions = 0; > /* possible options */ > @@ -880,6 +979,8 @@ int cmd_branch(int argc, > N_("edit the description for the branch")), > OPT_BOOL(0, "forked", &forked, > N_("list local branches forked from the given s")), > + OPT_BOOL(0, "prune-merged", &prune_merged, > + N_("delete local branches forked from the given s that are merged into their upstream")), > OPT__FORCE(&force, N_("force creation, move/rename, deletion"), PARSE_OPT_NOCOMPLETE), > OPT_MERGED(&filter, N_("print only branches that are merged")), > OPT_NO_MERGED(&filter, N_("print only branches that are not merged")), > @@ -924,7 +1025,8 @@ int cmd_branch(int argc, > 0); > > if (!delete && !rename && !copy && !edit_description && !new_upstream && > - !show_current && !unset_upstream && !forked && argc == 0) > + !show_current && !unset_upstream && !forked && !prune_merged && > + argc == 0) > list = 1; > > if (filter.with_commit || filter.no_commit || > @@ -933,7 +1035,7 @@ int cmd_branch(int argc, > > noncreate_actions = !!delete + !!rename + !!copy + !!new_upstream + > !!show_current + !!list + !!edit_description + > - !!unset_upstream + !!forked; > + !!unset_upstream + !!forked + !!prune_merged; > if (noncreate_actions > 1) > usage_with_options(builtin_branch_usage, options); > > @@ -971,12 +1073,15 @@ int cmd_branch(int argc, > if (delete) { > if (!argc) > die(_("branch name required")); > - ret = delete_branches(argc, argv, delete > 1, filter.kind, > + ret = delete_branches(argc, argv, 0, delete > 1, filter.kind, > quiet, 0, NULL); > goto out; > } else if (forked) { > ret = list_forked_branches(argc, argv); > goto out; > + } else if (prune_merged) { > + ret = prune_merged_branches(argc, argv, quiet); > + goto out; > } else if (show_current) { > print_current_branch_name(); > ret = 0; > diff --git a/t/t3200-branch.sh b/t/t3200-branch.sh > index 24a3ec44ee..94ea493aee 100755 > --- a/t/t3200-branch.sh > +++ b/t/t3200-branch.sh > @@ -1771,4 +1771,87 @@ test_expect_success '--forked requires at least one ' ' > test_grep "at least one " err > ' > > +test_expect_success '--prune-merged: setup' ' > + test_create_repo pm-upstream && > + test_commit -C pm-upstream base && > + git -C pm-upstream checkout -b next && > + test_commit -C pm-upstream one-commit && > + test_commit -C pm-upstream two-commit && > + git -C pm-upstream branch one HEAD~ && > + git -C pm-upstream branch two HEAD && > + git -C pm-upstream branch wip main && > + git -C pm-upstream checkout main > +' > + > +test_expect_success '--prune-merged deletes branches integrated into upstream' ' > + test_when_finished "rm -rf pm-merged" && > + git clone pm-upstream pm-merged && > + git -C pm-merged branch one one-commit && > + git -C pm-merged branch --set-upstream-to=origin/next one && > + git -C pm-merged branch two two-commit && > + git -C pm-merged branch --set-upstream-to=origin/next two && > + > + git -C pm-merged branch --prune-merged origin && > + > + test_must_fail git -C pm-merged rev-parse --verify refs/heads/one && > + test_must_fail git -C pm-merged rev-parse --verify refs/heads/two > +' > + > +test_expect_success '--prune-merged spares branches with un-integrated commits' ' > + test_when_finished "rm -rf pm-unmerged" && > + git clone pm-upstream pm-unmerged && > + git -C pm-unmerged checkout -b wip origin/wip && > + git -C pm-unmerged branch --set-upstream-to=origin/next wip && > + test_commit -C pm-unmerged local-only && > + git -C pm-unmerged checkout - && > + > + git -C pm-unmerged branch --prune-merged origin 2>err && > + test_grep "not fully merged" err && > + test_grep "Skipped 1 branch" err && > + test_grep "git branch -D" err && > + test_grep ! "If you are sure you want to delete it" err && > + git -C pm-unmerged rev-parse --verify refs/heads/wip > +' > + > +test_expect_success '--prune-merged skips branches whose upstream is gone' ' > + test_when_finished "rm -rf pm-upstream-gone" && > + git clone pm-upstream pm-upstream-gone && > + git -C pm-upstream-gone branch one one-commit && > + git -C pm-upstream-gone branch --set-upstream-to=origin/next one && > + > + git -C pm-upstream-gone update-ref -d refs/remotes/origin/next && > + git -C pm-upstream-gone branch --prune-merged origin && > + > + git -C pm-upstream-gone rev-parse --verify refs/heads/one > +' > + > +test_expect_success '--prune-merged never deletes the checked-out branch' ' > + test_when_finished "rm -rf pm-head" && > + git clone pm-upstream pm-head && > + git -C pm-head checkout -b one one-commit && > + git -C pm-head branch --set-upstream-to=origin/next one && > + > + git -C pm-head branch --prune-merged origin && > + > + git -C pm-head rev-parse --verify refs/heads/one > +' > + > +test_expect_success '--prune-merged spares the local default branch' ' > + test_when_finished "rm -rf pm-default" && > + git clone pm-upstream pm-default && > + git -C pm-default checkout --detach && > + git -C pm-default branch --prune-merged origin && > + git -C pm-default rev-parse --verify refs/heads/main > +' > + > +test_expect_success '--prune-merged protects only the default branch by name, not by upstream' ' > + test_when_finished "rm -rf pm-default-alias" && > + git clone pm-upstream pm-default-alias && > + git -C pm-default-alias branch --track trunk origin/main && > + git -C pm-default-alias checkout --detach && > + git -C pm-default-alias branch --prune-merged origin && > + git -C pm-default-alias rev-parse --verify refs/heads/main && > + test_must_fail git -C pm-default-alias rev-parse --verify refs/heads/trunk > +' > + > test_done