From 191faaf72648c4ed080a9e38c1782bc1619a6e87 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Tue, 31 May 2022 09:22:20 -0700 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 Signed-off-by: Junio C Hamano --- 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 -- 2.39.5