From: Phillip Wood <phillip.wood123@gmail.com>
To: Denton Liu <liu.denton@gmail.com>,
Git Mailing List <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH v7 8/8] cherry-pick/revert: add scissors line on merge conflict
Date: Tue, 12 Mar 2019 11:11:13 +0000 [thread overview]
Message-ID: <646a1d6a-5e40-5ff1-4702-a41addd4b315@gmail.com> (raw)
In-Reply-To: <5b30d939674542b2cfeeeef8341ab25c7d6c0543.1552275703.git.liu.denton@gmail.com>
Hi Denton
I've got a couple of small comments, but this looks fine to me
On 11/03/2019 03:42, 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.
>
> Signed-off-by: Denton Liu <liu.denton@gmail.com>
> ---
> Documentation/git-cherry-pick.txt | 7 +++
> Documentation/git-revert.txt | 7 +++
> builtin/merge.c | 9 +---
> builtin/rebase--interactive.c | 2 +-
> builtin/revert.c | 5 ++
> sequencer.c | 22 +++++---
> sequencer.h | 3 +-
> t/t3507-cherry-pick-conflict.sh | 86 +++++++++++++++++++++++++++++++
> 8 files changed, 123 insertions(+), 18 deletions(-)
>
> diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
> index b8cfeec67e..b4ff8e136d 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=<mode>::
> + 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 '<mode>' is given a value of `scissors`, scissors will
> + be appended to MERGE_MSG before being passed on in the case of a
> + conflict.
I'm not sure what you mean by before being passed on.
> -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=<mode>::
> + 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 '<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 b620d4bfcb..671d6a19a4 100644
> --- a/builtin/merge.c
> +++ b/builtin/merge.c
> @@ -923,14 +923,7 @@ 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, 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, 1));
> fputs(msgbuf.buf, fp);
> strbuf_release(&msgbuf);
> fclose(fp);
> diff --git a/builtin/rebase--interactive.c b/builtin/rebase--interactive.c
> index 888390f911..cf2151b271 100644
> --- a/builtin/rebase--interactive.c
> +++ b/builtin/rebase--interactive.c
> @@ -199,10 +199,10 @@ int cmd_rebase__interactive(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;
>
> diff --git a/builtin/revert.c b/builtin/revert.c
> index a47b53ceaf..e8168e0214 100644
> --- 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_STRING(0, "cleanup", &cleanup_arg, N_("default"), N_("how to strip spaces and #comments from message")),
This line is rather long. As you're adding --cleanup to several commands
it might be an idea to add an OPT_CLEANUP macro to parse-options.h. That
would ensure the help is consistent across all the commands and save
repeating the option declaration.
Best Wishes
Phillip
> 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,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, 1);
> +
> /* Check for incompatible command line arguments */
> if (cmd) {
> char *this_operation;
> diff --git a/sequencer.c b/sequencer.c
> index 5d94e2c865..496554a474 100644
> --- a/sequencer.c
> +++ b/sequencer.c
> @@ -176,6 +176,11 @@ struct cleanup_config_mapping cleanup_config_mappings[] = {
> { NULL, 0, 0 }
> };
>
> +static inline int is_rebase_i(const struct replay_opts *opts)
> +{
> + return opts->action == REPLAY_INTERACTIVE_REBASE;
> +}
> +
> static int git_sequencer_config(const char *k, const char *v, void *cb)
> {
> struct replay_opts *opts = cb;
> @@ -188,7 +193,7 @@ static int git_sequencer_config(const char *k, const char *v, void *cb)
> if (status)
> return status;
>
> - opts->default_msg_cleanup = get_cleanup_mode(s, 0, 0);
> + opts->default_msg_cleanup = get_cleanup_mode(s, !is_rebase_i(opts), 0);
>
> free((char *)s);
> return status;
> @@ -212,11 +217,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))
> @@ -557,10 +557,16 @@ const char *get_config_from_cleanup(enum commit_msg_cleanup_mode 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;) {
> @@ -628,7 +634,7 @@ 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;
> }
> diff --git a/sequencer.h b/sequencer.h
> index e3c1f44807..95ff9db508 100644
> --- a/sequencer.h
> +++ b/sequencer.h
> @@ -115,7 +115,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, int die_on_error);
> const char *get_config_from_cleanup(enum commit_msg_cleanup_mode cleanup_mode);
> 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 &&
>
next prev parent reply other threads:[~2019-03-12 11:11 UTC|newest]
Thread overview: 105+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-11-14 5:24 [RFC PATCH 0/2] Fix scissors bug during merge conflict Denton Liu
2018-11-14 5:24 ` [RFC PATCH 1/2] commit: don't add scissors line if one exists Denton Liu
2018-11-14 8:06 ` Junio C Hamano
2018-11-14 18:06 ` Denton Liu
2018-11-16 3:32 ` Junio C Hamano
2018-11-14 5:25 ` [RFC PATCH 2/2] merge: add scissors line on merge conflict Denton Liu
2018-11-14 7:52 ` [RFC PATCH 0/2] Fix scissors bug during " Junio C Hamano
2018-11-14 8:10 ` Denton Liu
2018-11-16 15:19 ` [PATCH v2 " Denton Liu
2018-11-16 15:20 ` [PATCH v2 2/2] merge: add scissors line on " Denton Liu
2018-11-17 23:32 ` [PATCH v3 0/1] Fix scissors bug during " Denton Liu
2018-11-17 23:32 ` [PATCH v3 1/1] merge: add scissors line on " Denton Liu
2018-11-18 14:18 ` SZEDER Gábor
2018-11-18 6:54 ` [PATCH v3 0/1] Fix scissors bug during " Junio C Hamano
2018-11-21 3:13 ` [PATCH v4 0/2] " Denton Liu
2018-11-21 3:13 ` [PATCH v4 1/2] t7600: clean up 'merge --squash c3 with c7' test Denton Liu
2018-11-21 3:13 ` [PATCH v4 2/2] merge: add scissors line on merge conflict Denton Liu
2018-11-21 9:38 ` [PATCH v4 0/2] Fix scissors bug during " Junio C Hamano
2018-11-22 1:10 ` Denton Liu
2018-11-24 2:05 ` Junio C Hamano
2018-12-25 13:55 ` [PATCH v5 0/4] Add git-merge --cleanup support Denton Liu
2018-12-25 13:55 ` [PATCH v5 1/4] commit: extract cleanup_mode functions to sequencer Denton Liu
2018-12-25 13:56 ` [PATCH v5 2/4] t7600: clean up 'merge --squash c3 with c7' test Denton Liu
2018-12-25 13:56 ` [PATCH v5 3/4] merge: cleanup messages like commit Denton Liu
2018-12-25 13:56 ` [PATCH v5 4/4] merge: add scissors line on merge conflict Denton Liu
2019-01-23 5:06 ` [PATCH v6 0/4] Add git-merge --cleanup support Denton Liu
2019-01-23 5:06 ` [PATCH v6 1/4] commit: extract cleanup_mode functions to sequencer Denton Liu
2019-01-23 5:06 ` [PATCH v6 2/4] t7600: clean up 'merge --squash c3 with c7' test Denton Liu
2019-01-23 5:06 ` [PATCH v6 3/4] merge: cleanup messages like commit Denton Liu
2019-01-23 5:06 ` [PATCH v6 4/4] merge: add scissors line on merge conflict Denton Liu
2019-03-11 3:42 ` [PATCH v7 0/8] Fix scissors bug during conflict Denton Liu
2019-03-11 3:42 ` [PATCH v7 1/8] t7600: clean up 'merge --squash c3 with c7' test Denton Liu
2019-03-12 1:03 ` Junio C Hamano
2019-03-11 3:42 ` [PATCH v7 2/8] t3507: cleanup space after redirection operators Denton Liu
2019-03-11 3:42 ` [PATCH v7 3/8] commit: extract cleanup_mode functions to sequencer Denton Liu
2019-03-11 3:42 ` [PATCH v7 4/8] sequencer.c: remove duplicate code Denton Liu
2019-03-11 16:45 ` Phillip Wood
2019-03-11 3:42 ` [PATCH v7 5/8] merge: cleanup messages like commit Denton Liu
2019-03-11 5:49 ` Eric Sunshine
2019-03-11 10:14 ` Phillip Wood
2019-03-11 17:00 ` Eric Sunshine
2019-03-11 16:58 ` Phillip Wood
2019-03-12 5:50 ` Junio C Hamano
2019-03-11 3:42 ` [PATCH v7 6/8] merge: add scissors line on merge conflict Denton Liu
2019-03-11 5:55 ` Eric Sunshine
2019-03-11 3:42 ` [PATCH v7 7/8] sequencer.c: define get_config_from_cleanup Denton Liu
2019-03-11 6:19 ` Eric Sunshine
2019-03-12 6:29 ` Junio C Hamano
2019-03-11 3:42 ` [PATCH v7 8/8] cherry-pick/revert: add scissors line on merge conflict Denton Liu
2019-03-12 11:11 ` Phillip Wood [this message]
2019-03-11 6:44 ` [PATCH v7 0/8] Fix scissors bug during conflict Junio C Hamano
2019-03-17 10:15 ` [PATCH v8 00/11] " Denton Liu
2019-03-17 10:15 ` [PATCH v8 01/11] t7600: clean up style Denton Liu
2019-03-17 10:15 ` [PATCH v8 02/11] t3507: cleanup space after redirection operators Denton Liu
2019-03-17 10:15 ` [PATCH v8 03/11] t7604: refactor out Git commands upstream of pipe Denton Liu
2019-03-17 10:16 ` [PATCH v8 04/11] t7502: clean up test style Denton Liu
2019-03-17 10:16 ` [PATCH v8 05/11] commit: extract cleanup_mode functions to sequencer Denton Liu
2019-03-17 10:16 ` [PATCH v8 06/11] parse-options.h: extract common --cleanup option Denton Liu
2019-03-17 10:16 ` [PATCH v8 07/11] sequencer.c: remove duplicate code Denton Liu
2019-03-17 10:16 ` [PATCH v8 08/11] merge: cleanup messages like commit Denton Liu
2019-03-19 11:13 ` Phillip Wood
2019-03-20 6:32 ` Denton Liu
2019-03-17 10:16 ` [PATCH v8 09/11] merge: add scissors line on merge conflict Denton Liu
2019-03-17 10:16 ` [PATCH v8 10/11] sequencer.c: define describe_cleanup_mode Denton Liu
2019-03-18 20:04 ` Eric Sunshine
2019-03-18 20:30 ` Denton Liu
2019-03-18 20:32 ` Eric Sunshine
2019-03-19 0:55 ` Ramsay Jones
2019-03-17 10:16 ` [PATCH v8 11/11] cherry-pick/revert: add scissors line on merge conflict Denton Liu
2019-03-17 13:05 ` [PATCH v8 00/11] Fix scissors bug during conflict SZEDER Gábor
2019-03-18 3:02 ` Denton Liu
2019-03-18 6:35 ` Junio C Hamano
2019-03-18 8:03 ` Denton Liu
2019-03-18 8:25 ` Junio C Hamano
2019-03-21 6:53 ` [PATCH v9 " Denton Liu
2019-03-21 6:53 ` [PATCH v9 01/11] t7600: clean up style Denton Liu
2019-03-21 6:53 ` [PATCH v9 02/11] t3507: " Denton Liu
2019-03-21 6:53 ` [PATCH v9 03/11] t7604: " Denton Liu
2019-03-21 6:53 ` [PATCH v9 04/11] t7502: " Denton Liu
2019-03-21 6:53 ` [PATCH v9 05/11] commit: extract cleanup_mode functions to sequencer Denton Liu
2019-03-21 6:53 ` [PATCH v9 06/11] parse-options.h: extract common --cleanup option Denton Liu
2019-03-21 6:53 ` [PATCH v9 07/11] sequencer.c: remove duplicate code Denton Liu
2019-03-26 10:44 ` Phillip Wood
2019-03-21 6:53 ` [PATCH v9 08/11] merge: cleanup messages like commit Denton Liu
2019-03-21 6:53 ` [PATCH v9 09/11] merge: add scissors line on merge conflict Denton Liu
2019-03-21 6:54 ` [PATCH v9 10/11] sequencer.c: define describe_cleanup_mode Denton Liu
2019-03-21 6:54 ` [PATCH v9 11/11] cherry-pick/revert: add scissors line on merge conflict Denton Liu
2019-04-17 10:23 ` [PATCH v10 00/10] Fix scissors bug during conflict Phillip Wood
2019-04-17 10:23 ` [PATCH v10 01/10] t7600: clean up style Phillip Wood
2019-04-17 10:23 ` [PATCH v10 02/10] t3507: " Phillip Wood
2019-04-17 10:23 ` [PATCH v10 03/10] t7604: " Phillip Wood
2019-04-17 10:23 ` [PATCH v10 04/10] t7502: " Phillip Wood
2019-04-17 10:23 ` [PATCH v10 05/10] commit: extract cleanup_mode functions to sequencer Phillip Wood
2019-04-17 10:23 ` [PATCH v10 06/10] parse-options.h: extract common --cleanup option Phillip Wood
2019-04-17 10:23 ` [PATCH v10 07/10] merge: cleanup messages like commit Phillip Wood
2019-04-17 10:23 ` [PATCH v10 08/10] merge: add scissors line on merge conflict Phillip Wood
2019-04-17 10:23 ` [PATCH v10 09/10] sequencer.c: save and restore cleanup mode Phillip Wood
2019-04-17 17:02 ` Denton Liu
2019-04-17 19:53 ` Phillip Wood
2019-04-18 17:21 ` Denton Liu
2019-04-17 10:23 ` [PATCH v10 10/10] cherry-pick/revert: add scissors line on merge conflict Phillip Wood
2019-04-18 5:19 ` [PATCH v10 00/10] Fix scissors bug during conflict Junio C Hamano
2019-04-18 9:14 ` Phillip Wood
[not found] ` <cover.1542380865.git.liu.denton@gmail.com>
2018-11-16 15:19 ` [PATCH v2 1/2] commit: don't add scissors line if one exists in MERGE_MSG Denton Liu
2018-11-17 8:06 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=646a1d6a-5e40-5ff1-4702-a41addd4b315@gmail.com \
--to=phillip.wood123@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=liu.denton@gmail.com \
--cc=phillip.wood@dunelm.org.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).