commit: add support for --fixup <commit> -m"<extra message>"

Add support for supplying the -m option with --fixup. Doing so has errored out ever since --fixup was introduced. Before this, the only way to amend the fixup message while committing was to use --edit and amend it in the editor. The use-case for this feature is one of: * Leaving a quick note to self when creating a --fixup commit when it's not self-evident why the commit should be squashed without a note into another one. * (Ab)using the --fixup feature to "fix up" commits that have already been pushed to a branch that doesn't allow non-fast-forwards, i.e. just noting "this should have been part of that other commit", and if the history ever got rewritten in the future the two should be combined. In such a case you might want to leave a small message, e.g. "forgot this part, which broke XYZ". With this, --fixup <commit> -m"More" -m"Details" will result in a commit message like: !fixup <subject of <commit>> More Details The reason the test being added here seems to squash "More" at the end of the subject line of the commit being fixed up is because the test code is using "%s%b" so the body immediately follows the subject, it's not a bug in this code, and other tests t7500-commit.sh do the same thing. When the --fixup option was initially added the "Option -m cannot be combined" error was expanded from -c, -C and -F to also include --fixup[1] Those options could also support combining with -m, but given what they do I can't think of a good use-case for doing that, so I have not made the more invasive change of splitting up the logic in commit.c to first act on those, and then on -m options. 1. d71b8ba7c9 ("commit: --fixup option for use with rebase --autosquash", 2010-11-02) Helped-by: Eric Sunshine <sunshine@sunshineco.com> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Ævar Arnfjörð Bjarmason committed Dec 22, 2017 at 20:41 UTC 30884c9afcd03aa7d9a0524fde3c96d2e29cf9a9
3 files changed +14 -6
Documentation/git-commit.txt
+1 -2
@@ -145,8 +145,7 @@ OPTIONS
145 If multiple `-m` options are given, their values are
146 concatenated as separate paragraphs.
147 +
148 -The `-m` option is mutually exclusive with `-c`, `-C`, `-F`, and
149 -`--fixup`.
148 +The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.
149
150 -t <file>::
151 --template=<file>::
builtin/commit.c
+5 -3
@@ -701,7 +701,7 @@ static int prepare_to_commit(const char *index_file, const char *prefix,
701 }
702 }
703
704 - if (have_option_m) {
704 + if (have_option_m && !fixup_message) {
705 strbuf_addbuf(&sb, &message);
706 hook_arg1 = "message";
707 } else if (logfile && !strcmp(logfile, "-")) {
@@ -731,6 +731,8 @@ static int prepare_to_commit(const char *index_file, const char *prefix,
731 ctx.output_encoding = get_commit_output_encoding();
732 format_commit_message(commit, "fixup! %s\n\n",
733 &sb, &ctx);
734 + if (have_option_m)
735 + strbuf_addbuf(&sb, &message);
736 hook_arg1 = "message";
737 } else if (!stat(git_path_merge_msg(), &statbuf)) {
738 /*
@@ -1197,8 +1199,8 @@ static int parse_and_validate_options(int argc, const char *argv[],
1199 f++;
1200 if (f > 1)
1201 die(_("Only one of -c/-C/-F/--fixup can be used."));
1200 - if (have_option_m && f > 0)
1201 - die((_("Option -m cannot be combined with -c/-C/-F/--fixup.")));
1202 + if (have_option_m && (edit_message || use_message || logfile))
1203 + die((_("Option -m cannot be combined with -c/-C/-F.")));
1204 if (f || have_option_m)
1205 template_file = NULL;
1206 if (edit_message)
t/t7500-commit.sh
+8 -1
@@ -272,6 +272,14 @@ test_expect_success 'commit --fixup provides correct one-line commit message' '
272 commit_msg_is "fixup! target message subject line"
273 '
274
275 +test_expect_success 'commit --fixup -m"something" -m"extra"' '
276 + commit_for_rebase_autosquash_setup &&
277 + git commit --fixup HEAD~1 -m"something" -m"extra" &&
278 + commit_msg_is "fixup! target message subject linesomething
279 +
280 +extra"
281 +'
282 +
283 test_expect_success 'commit --squash works with -F' '
284 commit_for_rebase_autosquash_setup &&
285 echo "log message from file" >msgfile &&
@@ -325,7 +333,6 @@ test_expect_success 'invalid message options when using --fixup' '
333 test_must_fail git commit --fixup HEAD~1 --squash HEAD~2 &&
334 test_must_fail git commit --fixup HEAD~1 -C HEAD~2 &&
335 test_must_fail git commit --fixup HEAD~1 -c HEAD~2 &&
328 - test_must_fail git commit --fixup HEAD~1 -m "cmdline message" &&
336 test_must_fail git commit --fixup HEAD~1 -F log
337 '
338