cherry-pick/revert: add scissors line on merge conflict

Fix a bug where the scissors line is placed after the Conflicts:
section, in the case where a merge conflict occurs and
commit.cleanup = scissors.

Helped-by: Phillip Wood <phillip.wood@dunelm.org.uk>
Signed-off-by: Denton Liu <liu.denton@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index d64e72462fed7c7c1cd7f0c5543bcd035ce70247..754b16ce0c9da6a137c9f58de86eb44841ae64d6 100644 (file)
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -57,6 +57,13 @@ OPTIONS
        With this option, 'git cherry-pick' will let you edit the commit
        message prior to committing.
 
+--cleanup=<mode>::
+       This option determines how the commit message will be cleaned up before
+       being passed on to the commit machinery. See linkgit:git-commit[1] for more
+       details. In particular, if the '<mode>' is given a value of `scissors`,
+       scissors will be appended to `MERGE_MSG` before being passed on in the case
+       of a conflict.
+
 -x::
        When recording the commit, append a line that says
        "(cherry picked from commit ...)" to the original commit

diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index 6afccb2f1e29fe588c11e979e0d019edc0596b39..0c82ca5bc0e5a380e8fc441fbb34e12c85cffcab 100644 (file)
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -66,6 +66,13 @@ more details.
        With this option, 'git revert' will not start the commit
        message editor.
 
+--cleanup=<mode>::
+       This option determines how the commit message will be cleaned up before
+       being passed on to the commit machinery. See linkgit:git-commit[1] for more
+       details. In particular, if the '<mode>' is given a value of `scissors`,
+       scissors will be appended to `MERGE_MSG` before being passed on in the case
+       of a conflict.
+
 -n::
 --no-commit::
        Usually the command automatically creates some commits with

diff --git a/builtin/merge.c b/builtin/merge.c
index 03b9f7230a1ade2e11a3a44bd7635fabe4ce2fd1..e96f72af8044769df6b4ef42f0525b572b0c39e2 100644 (file)
--- a/builtin/merge.c
+++ b/builtin/merge.c
@@ -927,14 +927,8 @@ static int suggest_conflicts(void)
         * Thus, we will get the cleanup mode which is returned when we _are_
         * using an editor.
         */
-       if (get_cleanup_mode(cleanup_arg, 1) == COMMIT_MSG_CLEANUP_SCISSORS) {
-           fputc('\n', fp);
-           wt_status_add_cut_line(fp);
-           /* comments out the newline from append_conflicts_hint */
-           fputc(comment_line_char, fp);
-       }
-
-       append_conflicts_hint(&the_index, &msgbuf);
+       append_conflicts_hint(&the_index, &msgbuf,
+                             get_cleanup_mode(cleanup_arg, 1));
        fputs(msgbuf.buf, fp);
        strbuf_release(&msgbuf);
        fclose(fp);

diff --git a/builtin/revert.c b/builtin/revert.c
index a47b53ceaff92d4079b4ea73a61ce1552ad66b05..d4dcedbdc683f92d191cc6386f6388b1a918faa8 100644 (file)
--- a/builtin/revert.c
+++ b/builtin/revert.c
@@ -96,11 +96,13 @@ static int run_sequencer(int argc, const char **argv, struct replay_opts *opts)
 {
        const char * const * usage_str = revert_or_cherry_pick_usage(opts);
        const char *me = action_name(opts);
+       const char *cleanup_arg = NULL;
        int cmd = 0;
        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'),
                OPT_CMDMODE(0, "abort", &cmd, N_("cancel revert or cherry-pick sequence"), 'a'),
+               OPT_CLEANUP(&cleanup_arg),
                OPT_BOOL('n', "no-commit", &opts->no_commit, N_("don't automatically commit")),
                OPT_BOOL('e', "edit", &opts->edit, N_("edit the commit message")),
                OPT_NOOP_NOARG('r', NULL),
@@ -137,6 +139,11 @@ static int run_sequencer(int argc, const char **argv, struct replay_opts *opts)
        if (opts->keep_redundant_commits)
                opts->allow_empty = 1;
 
+       if (cleanup_arg) {
+               opts->default_msg_cleanup = get_cleanup_mode(cleanup_arg, 1);
+               opts->explicit_cleanup = 1;
+       }
+
        /* Check for incompatible command line arguments */
        if (cmd) {
                char *this_operation;

diff --git a/sequencer.c b/sequencer.c
index 501d99f791b9bdc77824c21c7be102388d041167..03756485791e83f9eb4288326ec2afbf8cc1ac00 100644 (file)
--- a/sequencer.c
+++ b/sequencer.c
@@ -182,7 +182,7 @@ static int git_sequencer_config(const char *k, const char *v, void *cb)
                        opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_ALL;
                        opts->explicit_cleanup = 1;
                } else if (!strcmp(s, "scissors")) {
-                       opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SPACE;
+                       opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SCISSORS;
                        opts->explicit_cleanup = 1;
                } else {
                        warning(_("invalid commit message cleanup mode '%s'"),
@@ -554,10 +554,16 @@ static const char *describe_cleanup_mode(int cleanup_mode)
 }
 
 void append_conflicts_hint(struct index_state *istate,
-                          struct strbuf *msgbuf)
+       struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode)
 {
        int i;
 
+       if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS) {
+               strbuf_addch(msgbuf, '\n');
+               wt_status_append_cut_line(msgbuf);
+               strbuf_addch(msgbuf, comment_line_char);
+       }
+
        strbuf_addch(msgbuf, '\n');
        strbuf_commented_addf(msgbuf, "Conflicts:\n");
        for (i = 0; i < istate->cache_nr;) {
@@ -625,7 +631,8 @@ static int do_recursive_merge(struct repository *r,
                        _(action_name(opts)));
 
        if (!clean)
-               append_conflicts_hint(r->index, msgbuf);
+               append_conflicts_hint(r->index, msgbuf,
+                                     opts->default_msg_cleanup);
 
        return !clean;
 }
@@ -944,7 +951,6 @@ static int run_git_commit(struct repository *r,
                          unsigned int flags)
 {
        struct child_process cmd = CHILD_PROCESS_INIT;
-       const char *value;
 
        if ((flags & CREATE_ROOT_COMMIT) && !(flags & AMEND_MSG)) {
                struct strbuf msg = STRBUF_INIT, script = STRBUF_INIT;
@@ -1014,7 +1020,7 @@ static int run_git_commit(struct repository *r,
                argv_array_push(&cmd.args, "-e");
        else if (!(flags & CLEANUP_MSG) &&
                 !opts->signoff && !opts->record_origin &&
-                git_config_get_value("commit.cleanup", &value))
+                !opts->explicit_cleanup)
                argv_array_push(&cmd.args, "--cleanup=verbatim");
 
        if ((flags & ALLOW_EMPTY))

diff --git a/sequencer.h b/sequencer.h
index 8295c8406f5c5f88c86afc6dad0708c9827868ab..7023da9b135000ed7376b12791a43713e85e1435 100644 (file)
--- a/sequencer.h
+++ b/sequencer.h
@@ -116,7 +116,8 @@ int rearrange_squash(struct repository *r);
  */
 void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
 
-void append_conflicts_hint(struct index_state *istate, struct strbuf *msgbuf);
+void append_conflicts_hint(struct index_state *istate,
+               struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode);
 enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
        int use_editor);
 

diff --git a/t/t3507-cherry-pick-conflict.sh b/t/t3507-cherry-pick-conflict.sh
index 777fb23d187d6030f94a862d24d24e47eb011ebc..a584b11c9871c82b5b771cd1858b3d34d8ea8b33 100755 (executable)
--- a/t/t3507-cherry-pick-conflict.sh
+++ b/t/t3507-cherry-pick-conflict.sh
@@ -189,6 +189,46 @@ test_expect_success 'failed cherry-pick registers participants in index' '
        test_cmp expected actual
 '
 
+test_expect_success \
+       'cherry-pick conflict, ensure commit.cleanup = scissors places scissors line properly' '
+       pristine_detach initial &&
+       git config commit.cleanup scissors &&
+       cat <<-EOF >expected &&
+               picked
+
+               # ------------------------ >8 ------------------------
+               # Do not modify or remove the line above.
+               # Everything below it will be ignored.
+               #
+               # Conflicts:
+               #       foo
+               EOF
+
+       test_must_fail git cherry-pick picked &&
+
+       test_i18ncmp expected .git/MERGE_MSG
+'
+
+test_expect_success \
+       'cherry-pick conflict, ensure cleanup=scissors places scissors line properly' '
+       pristine_detach initial &&
+       git config --unset commit.cleanup &&
+       cat <<-EOF >expected &&
+               picked
+
+               # ------------------------ >8 ------------------------
+               # Do not modify or remove the line above.
+               # Everything below it will be ignored.
+               #
+               # Conflicts:
+               #       foo
+               EOF
+
+       test_must_fail git cherry-pick --cleanup=scissors picked &&
+
+       test_i18ncmp expected .git/MERGE_MSG
+'
+
 test_expect_success 'failed cherry-pick describes conflict in work tree' '
        pristine_detach initial &&
        cat <<-EOF >expected &&
@@ -335,6 +375,52 @@ test_expect_success 'revert conflict, diff3 -m style' '
        test_cmp expected actual
 '
 
+test_expect_success \
+       'revert conflict, ensure commit.cleanup = scissors places scissors line properly' '
+       pristine_detach initial &&
+       git config commit.cleanup scissors &&
+       cat >expected <<-EOF &&
+               Revert "picked"
+
+               This reverts commit OBJID.
+
+               # ------------------------ >8 ------------------------
+               # Do not modify or remove the line above.
+               # Everything below it will be ignored.
+               #
+               # Conflicts:
+               #       foo
+               EOF
+
+       test_must_fail git revert picked &&
+
+       sed "s/$OID_REGEX/OBJID/" .git/MERGE_MSG >actual &&
+       test_i18ncmp expected actual
+'
+
+test_expect_success \
+       'revert conflict, ensure cleanup=scissors places scissors line properly' '
+       pristine_detach initial &&
+       git config --unset commit.cleanup &&
+       cat >expected <<-EOF &&
+               Revert "picked"
+
+               This reverts commit OBJID.
+
+               # ------------------------ >8 ------------------------
+               # Do not modify or remove the line above.
+               # Everything below it will be ignored.
+               #
+               # Conflicts:
+               #       foo
+               EOF
+
+       test_must_fail git revert --cleanup=scissors picked &&
+
+       sed "s/$OID_REGEX/OBJID/" .git/MERGE_MSG >actual &&
+       test_i18ncmp expected actual
+'
+
 test_expect_success 'failed cherry-pick does not forget -s' '
        pristine_detach initial &&
        test_must_fail git cherry-pick -s picked &&