git-for-windows/git
1
0
Fork 0
mirror of https://github.com/git-for-windows/git.git synced 2026-06-15 18:49:48 -05:00
Code Issues Packages Projects Releases 335 Wiki Activity

Merge branch 'ec/commit-fixup-options' into seen

Browse Source 
The -m/-F/-c/-C options to supply commit log message from outside the
editor are now supported for all "git commit --fixup" variations.

* ec/commit-fixup-options:
  commit: allow -c/-C for all kinds of --fixup
  commit: allow -m/-F for all kinds of --fixup
This commit is contained in:
Junio C Hamano
2026-06-04 08:14:09 +09:00
parent 6d594e379f f1c098502d
commit 8b32fd4e9c
3 changed files with 133 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
Documentation/git-commit.adoc
View File

@@ -102,21 +102,23 @@ include::diff-context-options.adoc[]
+
The commit created by plain `--fixup=<commit>` has a title
composed of "fixup!" followed by the title of _<commit>_,
and is recognized specially by `git rebase --autosquash`. The `-m`
option may be used to supplement the log message of the created
commit, but the additional commentary will be thrown away once the
"fixup!" commit is squashed into _<commit>_ by
and is recognized specially by `git rebase --autosquash`. The `-m`,
`-F`, `-C`, or `-c` option may be used to supplement the log message
of the created commit, but the additional commentary will be thrown
away once the "fixup!" commit is squashed into _<commit>_ by
`git rebase --autosquash`.
+
The commit created by `--fixup=amend:<commit>` is similar but its
title is instead prefixed with "amend!". The log message of
_<commit>_ is copied into the log message of the "amend!" commit and
opened in an editor so it can be refined. When `git rebase
--autosquash` squashes the "amend!" commit into _<commit>_, the
log message of _<commit>_ is replaced by the refined log message
from the "amend!" commit. It is an error for the "amend!" commit's
log message to be empty unless `--allow-empty-message` is
specified.
opened in an editor so it can be refined. The replacement message may
also be supplied directly using `-m`, `-F`, or `-C`, bypassing the
need to open an editor, or using `-c` to open the editor pre-populated
with the referenced commit's message. When `git rebase
--autosquash` squashes the "amend!" commit into _<commit>_, the log
message of _<commit>_ is replaced by the refined log message from the
"amend!" commit. It is an error for the "amend!" commit's log message
to be empty unless `--allow-empty-message` is specified.
+
`--fixup=reword:<commit>` is shorthand for `--fixup=amend:<commit>
--only`. It creates an "amend!" commit with only a log message

41
builtin/commit.c
View File

@@ -804,18 +804,18 @@ static int prepare_to_commit(const char *index_file, const char *prefix,
if (have_option_m && !fixup_message) {
strbuf_addbuf(&sb, &message);
hook_arg1 = "message";
} else if (logfile && !strcmp(logfile, "-")) {
} else if (logfile && !fixup_message && !strcmp(logfile, "-")) {
if (isatty(0))
fprintf(stderr, _("(reading log message from standard input)\n"));
if (strbuf_read(&sb, 0, 0) < 0)
die_errno(_("could not read log from standard input"));
hook_arg1 = "message";
} else if (logfile) {
} else if (logfile && !fixup_message) {
if (strbuf_read_file(&sb, logfile, 0) < 0)
die_errno(_("could not read log file '%s'"),
logfile);
hook_arg1 = "message";
} else if (use_message) {
} else if (use_message && !fixup_message) {
const char *buffer;
buffer = strstr(use_message_buffer, "\n\n");
if (buffer)
@@ -837,20 +837,26 @@ static int prepare_to_commit(const char *index_file, const char *prefix,
hook_arg1 = "message";
/*
* Only `-m` commit message option is checked here, as
* it supports `--fixup` to append the commit message.
*
* The other commit message options `-c`/`-C`/`-F` are
* incompatible with all the forms of `--fixup` and
* have already errored out while parsing the `git commit`
* options.
* `-m`, `-F`, `-C`, and `-c` provide the message body.
* If none was given and this is an amend, use the target
* commit's body instead.
*/
if (have_option_m && !strcmp(fixup_prefix, "fixup"))
if (have_option_m) {
strbuf_addbuf(&sb, &message);
if (!strcmp(fixup_prefix, "amend")) {
if (have_option_m)
die(_("options '%s' and '%s:%s' cannot be used together"), "-m", "--fixup", fixup_message);
} else if (logfile && !strcmp(logfile, "-")) {
if (isatty(0))
fprintf(stderr, _("(reading log message from standard input)\n"));
if (strbuf_read(&sb, 0, 0) < 0)
die_errno(_("could not read log from standard input"));
} else if (logfile) {
if (strbuf_read_file(&sb, logfile, 0) < 0)
die_errno(_("could not read log file '%s'"), logfile);
} else if (use_message) {
struct commit *c = lookup_commit_reference_by_name(use_message);
if (!c)
die(_("could not lookup commit '%s'"), use_message);
prepare_amend_commit(c, &sb, &ctx);
} else if (!strcmp(fixup_prefix, "amend")) {
prepare_amend_commit(commit, &sb, &ctx);
}
} else if (!stat(git_path_merge_msg(the_repository), &statbuf)) {
@@ -1338,10 +1344,9 @@ static int parse_and_validate_options(int argc, const char *argv[],
}
if (fixup_message && squash_message)
die(_("options '%s' and '%s' cannot be used together"), "--squash", "--fixup");
die_for_incompatible_opt4(!!use_message, "-C",
die_for_incompatible_opt3(!!use_message, "-C",
!!edit_message, "-c",
!!logfile, "-F",
!!fixup_message, "--fixup");
!!logfile, "-F");
die_for_incompatible_opt4(have_option_m, "-m",
!!edit_message, "-c",
!!use_message, "-C",

114
t/t7500-commit-template-squash-signoff.sh
View File

@@ -384,18 +384,24 @@ test_expect_success '--fixup=reword: ignores staged changes' '
test_cmp foo actual
'
test_expect_success '--fixup=reword: error out with -m option' '
test_expect_success 'commit --fixup=reword: works with -m' '
commit_for_rebase_autosquash_setup &&
echo "fatal: options '\''-m'\'' and '\''--fixup:reword'\'' cannot be used together" >expect &&
test_must_fail git commit --fixup=reword:HEAD~ -m "reword commit message" 2>actual &&
test_cmp expect actual
git commit --fixup=reword:HEAD~ -m "reword commit message" &&
test_commit_message HEAD <<-EOF
amend! $(git log -1 --format=%s HEAD~2)
reword commit message
EOF
'
test_expect_success '--fixup=amend: error out with -m option' '
test_expect_success 'commit --fixup=amend: works with -m' '
commit_for_rebase_autosquash_setup &&
echo "fatal: options '\''-m'\'' and '\''--fixup:amend'\'' cannot be used together" >expect &&
test_must_fail git commit --fixup=amend:HEAD~ -m "amend commit message" 2>actual &&
test_cmp expect actual
git commit --fixup=amend:HEAD~ -m "amend commit message" &&
test_commit_message HEAD <<-EOF
amend! $(git log -1 --format=%s HEAD~2)
amend commit message
EOF
'
test_expect_success 'consecutive amend! commits remove amend! line from commit msg body' '
@@ -432,6 +438,13 @@ test_expect_success 'deny to create amend! commit if its commit msg body is empt
test_cmp expected actual
'
test_expect_success 'deny to create amend! commit if -m is empty' '
commit_for_rebase_autosquash_setup &&
echo "Aborting commit due to empty commit message body." >expect &&
test_must_fail git commit --fixup=amend:HEAD~ -m "" 2>actual &&
test_cmp expect actual
'
test_expect_success 'amend! commit allows empty commit msg body with --allow-empty-message' '
commit_for_rebase_autosquash_setup &&
cat >expected <<-EOF &&
@@ -468,10 +481,82 @@ test_expect_success '--fixup=reword: give error with pathsec' '
test_cmp expect actual
'
test_expect_success '--fixup=reword: -F give error message' '
echo "fatal: options '\''-F'\'' and '\''--fixup'\'' cannot be used together" >expect &&
test_must_fail git commit --fixup=reword:HEAD~ -F msg 2>actual &&
test_cmp expect actual
test_expect_success 'commit --fixup works with -F' '
commit_for_rebase_autosquash_setup &&
echo "message" >msgfile &&
git commit --fixup HEAD~ -F msgfile &&
test_commit_message HEAD <<-EOF
fixup! $(git log -1 --format=%s HEAD~2)
message
EOF
'
test_expect_success 'commit --fixup works with -C' '
commit_for_rebase_autosquash_setup &&
git commit --fixup HEAD~ -C HEAD &&
test_commit_message HEAD <<-EOF
fixup! $(git log -1 --format=%s HEAD~2)
$(get_commit_msg HEAD~)
EOF
'
test_expect_success 'commit --fixup=amend: works with -c' '
commit_for_rebase_autosquash_setup &&
test_set_editor : &&
git commit --fixup=amend:HEAD -c HEAD~ &&
test_commit_message HEAD <<-EOF
amend! intermediate commit
target message subject line
target message body line 1
target message body line 2
EOF
'
test_expect_success 'commit --fixup=amend:HEAD with -C HEAD and without have the same message' '
commit_for_rebase_autosquash_setup &&
start=$(git rev-parse HEAD) &&
git commit --fixup=amend:HEAD -C HEAD &&
git commit --fixup=amend:HEAD -C HEAD &&
git log -1 --pretty=%B >with-c &&
git reset --hard "$start" &&
test_set_editor : &&
git commit --fixup=amend:HEAD &&
git commit --fixup=amend:HEAD &&
git log -1 --pretty=%B >without-c &&
test_cmp with-c without-c
'
test_expect_success 'commit --fixup=amend: with -C copies full subject + body of squash commit' '
commit_for_rebase_autosquash_setup &&
git commit --squash HEAD~ -m "inner body" &&
echo "extra" >>foo &&
git add foo &&
git commit --fixup=amend:HEAD -C HEAD &&
test_commit_message HEAD <<-EOF
amend! squash! $(git log -1 --format=%s HEAD~3)
squash! $(git log -1 --format=%s HEAD~3)
inner body
EOF
'
test_expect_success 'commit --fixup=reword: works with -F' '
commit_for_rebase_autosquash_setup &&
echo "message from file" >msgfile &&
git commit --fixup=reword:HEAD~ -F msgfile &&
test_commit_message HEAD <<-EOF
amend! $(git log -1 --format=%s HEAD~2)
$(cat msgfile)
EOF
'
test_expect_success 'commit --squash works with -F' '
@@ -524,10 +609,7 @@ test_expect_success 'invalid message options when using --fixup' '
echo changes >>foo &&
echo "message" >log &&
git add foo &&
test_must_fail git commit --fixup HEAD~1 --squash HEAD~2 &&
test_must_fail git commit --fixup HEAD~1 -C HEAD~2 &&
test_must_fail git commit --fixup HEAD~1 -c HEAD~2 &&
test_must_fail git commit --fixup HEAD~1 -F log
test_must_fail git commit --fixup HEAD~1 --squash HEAD~2
'
cat >expected-template <<EOF