git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v3] revert: optionally refer to commit in the "reference" format

From
PWPhillip Wood <phillip.wood123@gmail.com>
Date
Jun 1, 2022, 15:03 UTC
Message-ID
<c0635170-5a52-c426-8231-d7291a79fa2c@gmail.com>
In-Reply-To
<xmqqfskpuh2w.fsf@gitster.g>
Hi Junio
On 01/06/2022 05:45, Junio C Hamano wrote:
Show 11 quoted lines
> Phillip Wood <phillip.wood123@gmail.com> writes:
> 
>> I think the changes to the template message are good. We're still
>> adding "--reference" as a valid option to cherry-pick though which I
>> don't think is a good idea (though in the future we may want to allow
>> "cherry-pick -x --reference")
> 
> I love when people notice mistakes that the original author and
> other people missed, many eyes making all bugs shallow.
> 
> I am inclined to apply the following on top.  How does it look?
It looks good to me.
Best Wishes
Phillip
Show 95 quoted lines
> Thanks.
> 
> ----- >8 --------- >8 --------- >8 --------- >8 -----
> Subject: [PATCH] revert: --reference should apply only to 'revert', not 'cherry-pick'
> 
> As 'revert' and 'cherry-pick' share a lot of code, it is easy to
> modify the behaviour of one command and inadvertently affect the
> other.  An earlier change to teach the '--reference' option and the
> 'revert.reference' configuration variable to the former was not
> careful enough and 'cherry-pick --reference' wasn't rejected as an
> error.
> 
> It is possible to think 'cherry-pick -x' might benefit from the
> '--reference' option, but it is fundamentally different from
> 'revert' in at least two ways to make it questionable:
> 
>   - 'revert' names a commit that is ancestor of the resulting commit,
>     so an abbreviated object name with human readable title is
>     sufficient to identify the named commit uniquely without using
>     the full object name.  On the other hand, 'cherry-pick'
>     usually [*] picks a commit that is not an ancestor.  It might be
>     even picking a private commit that never becomes part of the
>     public history.
> 
>   - The whole commit message of 'cherry-pick' is a copy of the
>     original commit, and there is nothing gained to repeat only the
>     title part on 'cherry-picked from' message.
> 
> [*] well, you could revert and then you can pick the original that
>      was reverted to get back to where you were, but then you can
>      revert the revert to do the same thing.
> 
> Helped-by: Phillip Wood <phillip.wood@dunelm.org.uk>
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>   builtin/revert.c              | 9 +++++++--
>   sequencer.c                   | 2 +-
>   t/t3501-revert-cherry-pick.sh | 6 ++++++
>   3 files changed, 14 insertions(+), 3 deletions(-)
> 
> diff --git a/builtin/revert.c b/builtin/revert.c
> index ada51e46b9..f84c253f4c 100644
> --- a/builtin/revert.c
> +++ b/builtin/revert.c
> @@ -116,8 +116,6 @@ static int run_sequencer(int argc, const char **argv, struct replay_opts *opts)
>   			N_("option for merge strategy"), option_parse_x),
>   		{ OPTION_STRING, 'S', "gpg-sign", &opts->gpg_sign, N_("key-id"),
>   		  N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
> -		OPT_BOOL(0, "reference", &opts->commit_use_reference,
> -			 N_("use the 'reference' format to refer to commits")),
>   		OPT_END()
>   	};
>   	struct option *options = base_options;
> @@ -132,6 +130,13 @@ static int run_sequencer(int argc, const char **argv, struct replay_opts *opts)
>   			OPT_END(),
>   		};
>   		options = parse_options_concat(options, cp_extra);
> +	} else if (opts->action == REPLAY_REVERT) {
> +		struct option cp_extra[] = {
> +			OPT_BOOL(0, "reference", &opts->commit_use_reference,
> +				 N_("use the 'reference' format to refer to commits")),
> +			OPT_END(),
> +		};
> +		options = parse_options_concat(options, cp_extra);
>   	}
>   
>   	argc = parse_options(argc, argv, NULL, options, usage_str,
> diff --git a/sequencer.c b/sequencer.c
> index 96fec6ef6d..4b66a1f79c 100644
> --- a/sequencer.c
> +++ b/sequencer.c
> @@ -221,7 +221,7 @@ static int git_sequencer_config(const char *k, const char *v, void *cb)
>   		return ret;
>   	}
>   
> -	if (!strcmp(k, "revert.reference"))
> +	if (opts->action == REPLAY_REVERT && !strcmp(k, "revert.reference"))
>   		opts->commit_use_reference = git_config_bool(k, v);
>   
>   	status = git_gpg_config(k, v, NULL);
> diff --git a/t/t3501-revert-cherry-pick.sh b/t/t3501-revert-cherry-pick.sh
> index a386ae9e88..fb4466599b 100755
> --- a/t/t3501-revert-cherry-pick.sh
> +++ b/t/t3501-revert-cherry-pick.sh
> @@ -205,4 +205,10 @@ test_expect_success 'identification of reverted commit (revert.reference)' '
>   	test_cmp expect actual
>   '
>   
> +test_expect_success 'cherry-pick is unaware of --reference (for now)' '
> +	test_when_finished "git reset --hard" &&
> +	test_must_fail git cherry-pick --reference HEAD 2>actual &&
> +	grep "^usage: git cherry-pick" actual
> +'
> +
>   test_done
Previous: Junio C HamanoNext: Ævar Arnfjörð Bjarmason
Message 8 of 20 in “revert: optionally refer to commit in the "reference" format”
  1. revert: optionally refer to commit in the "reference" formatJunio C Hamano, May 22, 2022
  2. Johannes SchindelinMay 23, 2022
  3. Junio C HamanoMay 23, 2022
  4. revert: optionally refer to commit in the "reference" formatJunio C Hamano, May 27, 2022
  5. Johannes SchindelinMay 30, 2022
  6. Phillip WoodMay 31, 2022
  7. Junio C HamanoJun 1, 2022
  8. Phillip WoodJun 1, 2022
  9. Ævar Arnfjörð BjarmasonJun 1, 2022
  10. Junio C HamanoJun 1, 2022
  11. Side effects in Git's test suite, was Re: [PATCH] revert: optionally refer to commit in the "reference" formatJohannes Schindelin, May 30, 2022
  12. Ævar Arnfjörð BjarmasonMay 31, 2022
  13. Ævar Arnfjörð BjarmasonMay 23, 2022
  14. Junio C HamanoMay 23, 2022
  15. Ævar Arnfjörð BjarmasonMay 24, 2022
  16. Junio C HamanoMay 24, 2022
  17. Phillip WoodMay 26, 2022
  18. Junio C HamanoMay 26, 2022
  19. René ScharfeJun 26, 2022
  20. Junio C HamanoJun 27, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.