From: Phillip Wood Date: Thu, 07 Mar 2019 15:24:16 GMT Subject: Re: [PATCH v3 3/4] cherry-pick/revert: add scissors line on merge conflict Message-ID: In-Reply-To: <14672ce10c90c46b15b62c48d2eea6fe8d85ed86.1551951770.git.liu.denton@gmail.com> Hi Denton On 07/03/2019 09:58, Denton Liu wrote: > 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. > > Note that the removal of the if-else tower in git_sequencer_config may > appear to be a no-op refactor but it actually isn't. First of all, we > now accept "default". More importantly, though, if > commit.cleanup = scissors, the cleanup enum will be set to > COMMIT_MSG_CLEANUP_SCISSORS instead of COMMIT_MSG_CLEANUP_SPACE when we > are reverting or cherry-picking. This allows us to append scissors to > MERGE_MSG in the case of a conflict. > > Signed-off-by: Denton Liu > --- > Documentation/git-cherry-pick.txt | 7 +++ > Documentation/git-revert.txt | 7 +++ > builtin/merge.c | 13 ++--- > builtin/rebase--helper.c | 2 +- > builtin/revert.c | 5 ++ > sequencer.c | 32 +++++------- > sequencer.h | 3 +- > t/t3507-cherry-pick-conflict.sh | 86 +++++++++++++++++++++++++++++++ > 8 files changed, 125 insertions(+), 30 deletions(-) > > diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt > index d35d771fc8..92235bd1c4 100644 > --- 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=:: > + This option determines how the commit message will be cleaned up before > + being passed on. See linkgit:git-commit[1] for more details. In > + addition, if the '' 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 837707a8fd..bd4ad395a9 100644 > --- 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=:: > + This option determines how the commit message will be cleaned up before > + being passed on. See linkgit:git-commit[1] for more details. In > + addition, if the '' 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 92efc3d8fa..d4217ebcf5 100644 > --- a/builtin/merge.c > +++ b/builtin/merge.c > @@ -913,17 +913,10 @@ static int suggest_conflicts(void) > * We can't use cleanup_mode because if we're not using the editor, > * get_cleanup_mode will return COMMIT_MSG_CLEANUP_SPACE instead, even > * though the message is meant to be processed later by git-commit. > - * Thus, we will get the cleanup mode is returned we _are_ using an > - * editor. > + * 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(&msgbuf); > + append_conflicts_hint(&msgbuf, get_cleanup_mode(cleanup_arg, 1)); > fputs(msgbuf.buf, fp); > strbuf_release(&msgbuf); > fclose(fp); > diff --git a/builtin/rebase--helper.c b/builtin/rebase--helper.c > index f7c2a5fdc8..5f1bc9d383 100644 > --- a/builtin/rebase--helper.c > +++ b/builtin/rebase--helper.c > @@ -48,10 +48,10 @@ int cmd_rebase__helper(int argc, const char **argv, const char *prefix) > OPT_END() > }; > > + opts.action = REPLAY_INTERACTIVE_REBASE; > sequencer_init_config(&opts); > git_config_get_bool("rebase.abbreviatecommands", &abbreviate_commands); > > - opts.action = REPLAY_INTERACTIVE_REBASE; > opts.allow_ff = 1; > opts.allow_empty = 1; What are you basing this series on? builtin/rebase--helper.c was removed last September in 34b47315d9 ("rebase -i: move rebase--helper modes to rebase--interactive", 2018-09-27) > diff --git a/builtin/revert.c b/builtin/revert.c > index 9a66720cfc..fe18036be7 100644 > --- a/builtin/revert.c > +++ b/builtin/revert.c > @@ -95,11 +95,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_STRING(0, "cleanup", &cleanup_arg, N_("default"), N_("how to strip spaces and #comments from message")), > 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), > @@ -136,6 +138,9 @@ 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); > + > /* Check for incompatible command line arguments */ > if (cmd) { > char *this_operation; > diff --git a/sequencer.c b/sequencer.c > index 707e72fb39..5c04bae7ac 100644 > --- a/sequencer.c > +++ b/sequencer.c > @@ -153,6 +153,11 @@ static GIT_PATH_FUNC(rebase_path_strategy, "rebase-merge/strategy") > static GIT_PATH_FUNC(rebase_path_strategy_opts, "rebase-merge/strategy_opts") > static GIT_PATH_FUNC(rebase_path_allow_rerere_autoupdate, "rebase-merge/allow_rerere_autoupdate") > > +static inline int is_rebase_i(const struct replay_opts *opts) > +{ > + return opts->action == REPLAY_INTERACTIVE_REBASE; > +} > + This is already in sequencer.c in a different place in recent versions Best Wishes Phillip > static int git_sequencer_config(const char *k, const char *v, void *cb) > { > struct replay_opts *opts = cb; > @@ -165,17 +170,7 @@ static int git_sequencer_config(const char *k, const char *v, void *cb) > if (status) > return status; > > - if (!strcmp(s, "verbatim")) > - opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_NONE; > - else if (!strcmp(s, "whitespace")) > - opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SPACE; > - else if (!strcmp(s, "strip")) > - opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_ALL; > - else if (!strcmp(s, "scissors")) > - opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SPACE; > - else > - warning(_("invalid commit message cleanup mode '%s'"), > - s); > + opts->default_msg_cleanup = get_cleanup_mode(s, !is_rebase_i(opts)); > > free((char *)s); > return status; > @@ -199,11 +194,6 @@ void sequencer_init_config(struct replay_opts *opts) > git_config(git_sequencer_config, opts); > } > > -static inline int is_rebase_i(const struct replay_opts *opts) > -{ > - return opts->action == REPLAY_INTERACTIVE_REBASE; > -} > - > static const char *get_dir(const struct replay_opts *opts) > { > if (is_rebase_i(opts)) > @@ -516,10 +506,16 @@ enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg, > die(_("Invalid cleanup mode %s"), cleanup_arg); > } > > -void append_conflicts_hint(struct strbuf *msgbuf) > +void append_conflicts_hint(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 < active_nr;) { > @@ -586,7 +582,7 @@ static int do_recursive_merge(struct commit *base, struct commit *next, > _(action_name(opts))); > > if (!clean) > - append_conflicts_hint(msgbuf); > + append_conflicts_hint(msgbuf, opts->default_msg_cleanup); > > return !clean; > } > diff --git a/sequencer.h b/sequencer.h > index 5690e0c27e..aa99503dd7 100644 > --- a/sequencer.h > +++ b/sequencer.h > @@ -91,7 +91,8 @@ int rearrange_squash(void); > extern const char sign_off_header[]; > > void append_signoff(struct strbuf *msgbuf, int ignore_footer, unsigned flag); > -void append_conflicts_hint(struct strbuf *msgbuf); > +void append_conflicts_hint(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 74ff925526..c3894ca9d6 100755 > --- 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 && >