From: Phillip Wood <phillip.wood123@gmail.com>
To: Denton Liu <liu.denton@gmail.com>,
Git Mailing List <git@vger.kernel.org>
Cc: "Eric Sunshine" <sunshine@sunshineco.com>,
"Junio C Hamano" <gitster@pobox.com>,
"Phillip Wood" <phillip.wood@dunelm.org.uk>,
"Ramsay Jones" <ramsay@ramsayjones.plus.com>,
"SZEDER Gábor" <szeder.dev@gmail.com>
Subject: Re: [PATCH v9 07/11] sequencer.c: remove duplicate code
Date: Tue, 26 Mar 2019 10:44:25 +0000 [thread overview]
Message-ID: <69e3e5b7-58ec-4507-bc5c-c162393368c4@gmail.com> (raw)
In-Reply-To: <492ba73797ac66cc48da2b44cdae2152b41aa481.1553150827.git.liu.denton@gmail.com>
On 21/03/2019 06:53, Denton Liu wrote:
> Since we implemented get_cleanup_mode, we had some duplicate code in
> git_sequencer_config which essentially performed the same operations.
> Refactor git_sequencer_config to take advantage of the logic already in
> get_cleanup_mode.
>
> Note that we had to introduce a separate argument to get_cleanup_mode
> indicating whether to die or not on an invalid value. This is because if
> we are parsing a config, we do not want to die but instead, we only want
> to warn the user, whereas if we are parsing a command-line option, we
> would like to actually die.
>
> Finally, this is almost a no-op refactor but not quite. Previously, in
> the case that an invalid value is presented, default_msg_cleanup would
> not be set.
Looking more closely at the code that's not correct, we set a default
value before in sequencer_init_config() which unfortunately means my
previous concerns about needing different values for rebase were not
correct.
> We change the behaviour so that default_msg_cleanup will now
> take on the value as if "default" were provided as the cleanup_arg.
That is not the default value we want, if the user provides an invalid
value in the config we're better off using --verbatim which is what the
current code does.
While looking at all this I noticed that in run_git_commit() we set up
the cleanup option for to use with
if ((flags & CLEANUP_MSG))
argv_array_push(&cmd.args, "--cleanup=strip");
if ((flags & EDIT_MSG))
argv_array_push(&cmd.args, "-e");
else if (!(flags & CLEANUP_MSG) &&
!opts->signoff && !opts->record_origin &&
git_config_get_value("commit.cleanup", &value))
argv_array_push(&cmd.args, "--cleanup=verbatim");
So we use --strip when editing (we always set CLEANUP_MSG when EDIT_MSG
is set) otherwise if opts->signoff or opts->record_origin is set we use
commit's default cleanup which is --whitespace as we're not editing
unless the user has set something else. In all other cases we use
--verbatim unless the user has something set in their config.
With your changes we need to change
git_config_get_value("commit.cleanup", &value) to something that checks
to see if --cleanup was given on the command line as well. I think the
best way is to add an opts->explict_cleanup flag which will also help
with a bug I introduced when I wrote try_to_commit().
In try_to_commit() we do
cleanup = (flags & CLEANUP_MSG) ? COMMIT_MSG_CLEANUP_ALL :
opts->default_msg_cleanup;
Which does not special case the opts->signoff or opts->record_origin
cases (opts->default_msg_cleanup will be --verbatim unless the user has
set something else) I'm planning to send in a patch for that soonish, it
will involve adding opts->explicit_cleanup which will interact badly
with this series as it is, I'll try and do some fixups to address that.
I have a general question about this series. If I run 'merge
--cleanup=scissors' or 'cherry-pick --cleanup=scissors' and there are
conflicts what happens when if I run 'commit --no-edit' to commit the
conflict resolution - does it know which cleanup mode to use?
Best Wishes
Phillip
> Also, we lowercase some user-facing strings.
>
> Helped-by: Phillip Wood <phillip.wood@dunelm.org.uk>
> Signed-off-by: Denton Liu <liu.denton@gmail.com>
> ---
> builtin/commit.c | 2 +-
> sequencer.c | 22 ++++++++--------------
> sequencer.h | 2 +-
> 3 files changed, 10 insertions(+), 16 deletions(-)
>
> diff --git a/builtin/commit.c b/builtin/commit.c
> index 8277da8474..ba1e6027ba 100644
> --- a/builtin/commit.c
> +++ b/builtin/commit.c
> @@ -1172,7 +1172,7 @@ static int parse_and_validate_options(int argc, const char *argv[],
> die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
> if (argc == 0 && (also || (only && !amend && !allow_empty)))
> die(_("No paths with --include/--only does not make sense."));
> - cleanup_mode = get_cleanup_mode(cleanup_arg, use_editor);
> + cleanup_mode = get_cleanup_mode(cleanup_arg, use_editor, 1);
>
> handle_untracked_files_arg(s);
>
> diff --git a/sequencer.c b/sequencer.c
> index 224c823b43..2cbfb848dd 100644
> --- a/sequencer.c
> +++ b/sequencer.c
> @@ -172,17 +172,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, 0, 0);
>
> free((char *)s);
> return status;
> @@ -512,7 +502,7 @@ static int fast_forward_to(struct repository *r,
> }
>
> enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
> - int use_editor)
> + int use_editor, int die_on_error)
> {
> if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
> return use_editor ? COMMIT_MSG_CLEANUP_ALL :
> @@ -526,8 +516,12 @@ enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
> else if (!strcmp(cleanup_arg, "scissors"))
> return use_editor ? COMMIT_MSG_CLEANUP_SCISSORS :
> COMMIT_MSG_CLEANUP_SPACE;
> - else
> - die(_("Invalid cleanup mode %s"), cleanup_arg);
> + else if (!die_on_error) {
> + warning(_("invalid cleanup mode %s, falling back to default"), cleanup_arg);
> + return use_editor ? COMMIT_MSG_CLEANUP_ALL :
> + COMMIT_MSG_CLEANUP_SPACE;
> + } else
> + die(_("invalid cleanup mode %s"), cleanup_arg);
> }
>
> void append_conflicts_hint(struct index_state *istate,
> diff --git a/sequencer.h b/sequencer.h
> index eb9bd97ef3..e7908f558e 100644
> --- a/sequencer.h
> +++ b/sequencer.h
> @@ -117,7 +117,7 @@ void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
>
> void append_conflicts_hint(struct index_state *istate, struct strbuf *msgbuf);
> enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
> - int use_editor);
> + int use_editor, int die_on_error);
>
> void cleanup_message(struct strbuf *msgbuf,
> enum commit_msg_cleanup_mode cleanup_mode, int verbose);
>
next prev parent reply other threads:[~2019-03-26 10:44 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
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 [this message]
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=69e3e5b7-58ec-4507-bc5c-c162393368c4@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 \
--cc=ramsay@ramsayjones.plus.com \
--cc=sunshine@sunshineco.com \
--cc=szeder.dev@gmail.com \
/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).