merge: allow to pretend a merge is made into a different branch

When a series of patches for a topic-B depends on having topic-A, the workflow to prepare the topic-B branch would look like this: $ git checkout -b topic-B main $ git merge --no-ff --no-edit topic-A $ git am <mbox-for-topic-B When topic-A gets updated, recreating the first merge and rebasing the rest of the topic-B, all on detached HEAD, is a useful technique. After updating topic-A with its new round of patches: $ git checkout topic-B $ prev=$(git rev-parse 'HEAD^{/^Merge branch .topic-A. into}') $ git checkout --detach $prev^1 $ git merge --no-ff --no-edit topic-A $ git rebase --onto HEAD $prev @{-1}^0 $ git checkout -B @{-1} This will (0) check out the current topic-B. (1) find the previous merge of topic-A into topic-B. (2) detach the HEAD to the parent of the previous merge. (3) merge the updated topic-A to it. (4) reapply the patches to rebuild the rest of topic-B. (5) update topic-B with the result. without contaminating the reflog of topic-B too much. topic-B@{1} is the "logically previous" state before topic-A got updated, for example. At (4), comparison (e.g. range-diff) between HEAD and @{-1} is a meaningful way to sanity check the result, and the same can be done at (5) by comparing topic-B and topic-B@{1}. But there is one glitch. The merge into the detached HEAD done in the step (3) above gives us "Merge branch 'topic-A' into HEAD", and does not say "into topic-B". Teach the "--into-name=<branch>" option to "git merge" and its underlying "git fmt-merge-message", to pretend as if we were merging into <branch>, no matter what branch we are actually merging into, when they prepare the merge message. The pretend name honors the usual "into <target>" suppression mechanism, which can be seen in the tests added here. Signed-off-by: Junio C Hamano <gitster@pobox.com>

Junio C Hamano committed Dec 20, 2021 at 14:53 UTC bd2bc94252a47443e19d366f8cc9626d4f92df7a
7 files changed +67 -5
Documentation/git-fmt-merge-msg.txt
+5 -1
@@ -9,7 +9,7 @@ git-fmt-merge-msg - Produce a merge commit message
9 SYNOPSIS
10 --------
11 [verse]
12 -'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log]
12 +'git fmt-merge-msg' [-m <message>] [--into-name <branch>] [--log[=<n>] | --no-log]
13 'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log] -F <file>
14
15 DESCRIPTION
@@ -44,6 +44,10 @@ OPTIONS
44 Use <message> instead of the branch names for the first line
45 of the log message. For use with `--log`.
46
47 +--into-name <branch>::
48 + Prepare the merge message as if merging to the branch `<branch>`,
49 + instead of the name of the real branch to which the merge is made.
50 +
51 -F <file>::
52 --file <file>::
53 Take the list of merged objects from <file> instead of
Documentation/git-merge.txt
+7 -1
@@ -12,7 +12,8 @@ SYNOPSIS
12 'git merge' [-n] [--stat] [--no-commit] [--squash] [--[no-]edit]
13 [--no-verify] [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
14 [--[no-]allow-unrelated-histories]
15 - [--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]
15 + [--[no-]rerere-autoupdate] [-m <msg>] [-F <file>]
16 + [--into-name <branch>] [<commit>...]
17 'git merge' (--continue | --abort | --quit)
18
19 DESCRIPTION
@@ -76,6 +77,11 @@ The 'git fmt-merge-msg' command can be
77 used to give a good default for automated 'git merge'
78 invocations. The automated message can include the branch description.
79
80 +--into-name <branch>::
81 + Prepare the default merge message as if merging to the branch
82 + `<branch>`, instead of the name of the real branch to which
83 + the merge is made.
84 +
85 -F <file>::
86 --file=<file>::
87 Read the commit message to be used for the merge commit (in
builtin/fmt-merge-msg.c
+4
@@ -12,6 +12,7 @@ int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix)
12 {
13 const char *inpath = NULL;
14 const char *message = NULL;
15 + char *into_name = NULL;
16 int shortlog_len = -1;
17 struct option options[] = {
18 { OPTION_INTEGER, 0, "log", &shortlog_len, N_("n"),
@@ -23,6 +24,8 @@ int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix)
24 DEFAULT_MERGE_LOG_LEN },
25 OPT_STRING('m', "message", &message, N_("text"),
26 N_("use <text> as start of message")),
27 + OPT_STRING(0, "into-name", &into_name, N_("name"),
28 + N_("use <name> instead of the real target branch")),
29 OPT_FILENAME('F', "file", &inpath, N_("file to read from")),
30 OPT_END()
31 };
@@ -56,6 +59,7 @@ int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix)
59 opts.add_title = !message;
60 opts.credit_people = 1;
61 opts.shortlog_len = shortlog_len;
62 + opts.into_name = into_name;
63
64 ret = fmt_merge_msg(&input, &output, &opts);
65 if (ret)
builtin/merge.c
+4
@@ -87,6 +87,7 @@ static int signoff;
87 static const char *sign_commit;
88 static int autostash;
89 static int no_verify;
90 +static char *into_name;
91
92 static struct strategy all_strategy[] = {
93 { "recursive", NO_TRIVIAL },
@@ -286,6 +287,8 @@ static struct option builtin_merge_options[] = {
287 { OPTION_LOWLEVEL_CALLBACK, 'F', "file", &merge_msg, N_("path"),
288 N_("read message from file"), PARSE_OPT_NONEG,
289 NULL, 0, option_read_message },
290 + OPT_STRING(0, "into-name", &into_name, N_("name"),
291 + N_("use <name> instead of the real target")),
292 OPT__VERBOSITY(&verbosity),
293 OPT_BOOL(0, "abort", &abort_current_merge,
294 N_("abort the current in-progress merge")),
@@ -1122,6 +1125,7 @@ static void prepare_merge_message(struct strbuf *merge_names, struct strbuf *mer
1125 opts.add_title = !have_message;
1126 opts.shortlog_len = shortlog_len;
1127 opts.credit_people = (0 < option_edit);
1128 + opts.into_name = into_name;
1129
1130 fmt_merge_msg(merge_names, merge_msg, &opts);
1131 if (merge_msg->len)
fmt-merge-msg.c
+5 -2
@@ -649,12 +649,15 @@ int fmt_merge_msg(struct strbuf *in, struct strbuf *out,
649
650 memset(&merge_parents, 0, sizeof(merge_parents));
651
652 - /* get current branch */
652 + /* learn the commit that we merge into and the current branch name */
653 current_branch = current_branch_to_free =
654 resolve_refdup("HEAD", RESOLVE_REF_READING, &head_oid, NULL);
655 if (!current_branch)
656 die("No current branch");
657 - if (starts_with(current_branch, "refs/heads/"))
657 +
658 + if (opts->into_name)
659 + current_branch = opts->into_name;
660 + else if (starts_with(current_branch, "refs/heads/"))
661 current_branch += 11;
662
663 find_merge_parents(&merge_parents, in, &head_oid);
fmt-merge-msg.h
+1
@@ -9,6 +9,7 @@ struct fmt_merge_msg_opts {
9 unsigned add_title:1,
10 credit_people:1;
11 int shortlog_len;
12 + const char *into_name;
13 };
14
15 extern int merge_log_config;
t/t6200-fmt-merge-msg.sh
+41 -1
@@ -573,7 +573,35 @@ test_expect_success 'merge-msg with "merging" an annotated tag' '
573 test_cmp expected .git/MERGE_MSG
574 '
575
576 +test_expect_success 'merge --into-name=<name>' '
577 + test_when_finished "git checkout main" &&
578 + git checkout -B side main &&
579 + git commit --allow-empty -m "One step ahead" &&
580 +
581 + git checkout --detach main &&
582 + git merge --no-ff side &&
583 + git show -s --format="%s" >full.0 &&
584 + head -n1 full.0 >actual &&
585 + # expect that HEAD is shown as-is
586 + grep -e "Merge branch .side. into HEAD$" actual &&
587 +
588 + git reset --hard main &&
589 + git merge --no-ff --into-name=main side &&
590 + git show -s --format="%s" >full.1 &&
591 + head -n1 full.1 >actual &&
592 + # expect that we pretend to be merging to main, that is suppressed
593 + grep -e "Merge branch .side.$" actual &&
594 +
595 + git checkout -b throwaway main &&
596 + git merge --no-ff --into-name=main side &&
597 + git show -s --format="%s" >full.2 &&
598 + head -n1 full.2 >actual &&
599 + # expect that we pretend to be merging to main, that is suppressed
600 + grep -e "Merge branch .side.$" actual
601 +'
602 +
603 test_expect_success 'merge.suppressDest configuration' '
604 + test_when_finished "git checkout main" &&
605 git checkout -B side main &&
606 git commit --allow-empty -m "One step ahead" &&
607 git checkout main &&
@@ -590,7 +618,19 @@ test_expect_success 'merge.suppressDest configuration' '
618 git -c merge.suppressDest="ma?*[rn]" fmt-merge-msg <.git/FETCH_HEAD >full.3 &&
619 head -n1 full.3 >actual &&
620 grep -e "Merge branch .side." actual &&
593 - ! grep -e " into main$" actual
621 + ! grep -e " into main$" actual &&
622 +
623 + git checkout --detach HEAD &&
624 + git -c merge.suppressDest="main" fmt-merge-msg <.git/FETCH_HEAD >full.4 &&
625 + head -n1 full.4 >actual &&
626 + grep -e "Merge branch .side. into HEAD$" actual &&
627 +
628 + git -c merge.suppressDest="main" fmt-merge-msg \
629 + --into-name=main <.git/FETCH_HEAD >full.5 &&
630 + head -n1 full.5 >actual &&
631 + grep -e "Merge branch .side." actual &&
632 + ! grep -e " into main$" actual &&
633 + ! grep -e " into HEAD$" actual
634 '
635
636 test_done