mirror of
https://github.com/git/git
synced 2024-09-29 21:27:13 +00:00
cherry-pick: add --empty
for more robust redundant commit handling
As with git-rebase(1) and git-am(1), git-cherry-pick(1) can result in a commit being made redundant if the content from the picked commit is already present in the target history. However, git-cherry-pick(1) does not have the same options available that git-rebase(1) and git-am(1) have. There are three things that can be done with these redundant commits: drop them, keep them, or have the cherry-pick stop and wait for the user to take an action. git-rebase(1) has the `--empty` option added in commite98c4269c8
(rebase (interactive-backend): fix handling of commits that become empty, 2020-02-15), which handles all three of these scenarios. Similarly, git-am(1) got its own `--empty` in7c096b8d61
(am: support --empty=<option> to handle empty patches, 2021-12-09). git-cherry-pick(1), on the other hand, only supports two of the three possiblities: Keep the redundant commits via `--keep-redundant-commits`, or have the cherry-pick fail by not specifying that option. There is no way to automatically drop redundant commits. In order to bring git-cherry-pick(1) more in-line with git-rebase(1) and git-am(1), this commit adds an `--empty` option to git-cherry-pick(1). It has the same three options (keep, drop, and stop), and largely behaves the same. The notable difference is that for git-cherry-pick(1), the default will be `stop`, which maintains the current behavior when the option is not specified. Like the existing `--keep-redundant-commits`, `--empty=keep` will imply `--allow-empty`. The `--keep-redundant-commits` option will be documented as a deprecated synonym of `--empty=keep`, and will be supported for backwards compatibility for the time being. Signed-off-by: Brian Lyles <brianmlyles@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
bd2f9fd025
commit
ec79d763de
|
@ -131,20 +131,36 @@ effect to your index in a row.
|
|||
even without this option. Note also, that use of this option only
|
||||
keeps commits that were initially empty (i.e. the commit recorded the
|
||||
same tree as its parent). Commits which are made empty due to a
|
||||
previous commit are dropped. To force the inclusion of those commits
|
||||
use `--keep-redundant-commits`.
|
||||
previous commit will cause the cherry-pick to fail. To force the
|
||||
inclusion of those commits, use `--empty=keep`.
|
||||
|
||||
--allow-empty-message::
|
||||
By default, cherry-picking a commit with an empty message will fail.
|
||||
This option overrides that behavior, allowing commits with empty
|
||||
messages to be cherry picked.
|
||||
|
||||
--empty=(drop|keep|stop)::
|
||||
How to handle commits being cherry-picked that are redundant with
|
||||
changes already in the current history.
|
||||
+
|
||||
--
|
||||
`drop`;;
|
||||
The commit will be dropped.
|
||||
`keep`;;
|
||||
The commit will be kept. Implies `--allow-empty`.
|
||||
`stop`;;
|
||||
The cherry-pick will stop when the commit is applied, allowing
|
||||
you to examine the commit. This is the default behavior.
|
||||
--
|
||||
+
|
||||
Note that `--empty=drop` and `--empty=stop` only specify how to handle a
|
||||
commit that was not initially empty, but rather became empty due to a previous
|
||||
commit. Commits that were initially empty will still cause the cherry-pick to
|
||||
fail unless one of `--empty=keep` or `--allow-empty` are specified.
|
||||
+
|
||||
|
||||
--keep-redundant-commits::
|
||||
If a commit being cherry picked duplicates a commit already in the
|
||||
current history, it will become empty. By default these
|
||||
redundant commits cause `cherry-pick` to stop so the user can
|
||||
examine the commit. This option overrides that behavior and
|
||||
creates an empty commit object. Implies `--allow-empty`.
|
||||
Deprecated synonym for `--empty=keep`.
|
||||
|
||||
--strategy=<strategy>::
|
||||
Use the given merge strategy. Should only be used once.
|
||||
|
|
|
@ -43,6 +43,31 @@ static const char * const *revert_or_cherry_pick_usage(struct replay_opts *opts)
|
|||
return opts->action == REPLAY_REVERT ? revert_usage : cherry_pick_usage;
|
||||
}
|
||||
|
||||
enum empty_action {
|
||||
EMPTY_COMMIT_UNSPECIFIED = -1,
|
||||
STOP_ON_EMPTY_COMMIT, /* output errors and stop in the middle of a cherry-pick */
|
||||
DROP_EMPTY_COMMIT, /* skip with a notice message */
|
||||
KEEP_EMPTY_COMMIT, /* keep recording as empty commits */
|
||||
};
|
||||
|
||||
static int parse_opt_empty(const struct option *opt, const char *arg, int unset)
|
||||
{
|
||||
int *opt_value = opt->value;
|
||||
|
||||
BUG_ON_OPT_NEG(unset);
|
||||
|
||||
if (!strcmp(arg, "stop"))
|
||||
*opt_value = STOP_ON_EMPTY_COMMIT;
|
||||
else if (!strcmp(arg, "drop"))
|
||||
*opt_value = DROP_EMPTY_COMMIT;
|
||||
else if (!strcmp(arg, "keep"))
|
||||
*opt_value = KEEP_EMPTY_COMMIT;
|
||||
else
|
||||
return error(_("invalid value for '%s': '%s'"), "--empty", arg);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int option_parse_m(const struct option *opt,
|
||||
const char *arg, int unset)
|
||||
{
|
||||
|
@ -85,6 +110,7 @@ static int run_sequencer(int argc, const char **argv, const char *prefix,
|
|||
const char * const * usage_str = revert_or_cherry_pick_usage(opts);
|
||||
const char *me = action_name(opts);
|
||||
const char *cleanup_arg = NULL;
|
||||
enum empty_action empty_opt = EMPTY_COMMIT_UNSPECIFIED;
|
||||
int cmd = 0;
|
||||
struct option base_options[] = {
|
||||
OPT_CMDMODE(0, "quit", &cmd, N_("end revert or cherry-pick sequence"), 'q'),
|
||||
|
@ -114,7 +140,10 @@ static int run_sequencer(int argc, const char **argv, const char *prefix,
|
|||
OPT_BOOL(0, "ff", &opts->allow_ff, N_("allow fast-forward")),
|
||||
OPT_BOOL(0, "allow-empty", &opts->allow_empty, N_("preserve initially empty commits")),
|
||||
OPT_BOOL(0, "allow-empty-message", &opts->allow_empty_message, N_("allow commits with empty messages")),
|
||||
OPT_BOOL(0, "keep-redundant-commits", &opts->keep_redundant_commits, N_("keep redundant, empty commits")),
|
||||
OPT_BOOL(0, "keep-redundant-commits", &opts->keep_redundant_commits, N_("deprecated: use --empty=keep instead")),
|
||||
OPT_CALLBACK_F(0, "empty", &empty_opt, "(stop|drop|keep)",
|
||||
N_("how to handle commits that become empty"),
|
||||
PARSE_OPT_NONEG, parse_opt_empty),
|
||||
OPT_END(),
|
||||
};
|
||||
options = parse_options_concat(options, cp_extra);
|
||||
|
@ -134,6 +163,11 @@ static int run_sequencer(int argc, const char **argv, const char *prefix,
|
|||
prepare_repo_settings(the_repository);
|
||||
the_repository->settings.command_requires_full_index = 0;
|
||||
|
||||
if (opts->action == REPLAY_PICK) {
|
||||
opts->drop_redundant_commits = (empty_opt == DROP_EMPTY_COMMIT);
|
||||
opts->keep_redundant_commits = opts->keep_redundant_commits || (empty_opt == KEEP_EMPTY_COMMIT);
|
||||
}
|
||||
|
||||
/* implies allow_empty */
|
||||
if (opts->keep_redundant_commits)
|
||||
opts->allow_empty = 1;
|
||||
|
@ -168,6 +202,7 @@ static int run_sequencer(int argc, const char **argv, const char *prefix,
|
|||
"--rerere-autoupdate", opts->allow_rerere_auto == RERERE_AUTOUPDATE,
|
||||
"--no-rerere-autoupdate", opts->allow_rerere_auto == RERERE_NOAUTOUPDATE,
|
||||
"--keep-redundant-commits", opts->keep_redundant_commits,
|
||||
"--empty", empty_opt != EMPTY_COMMIT_UNSPECIFIED,
|
||||
NULL);
|
||||
}
|
||||
|
||||
|
|
|
@ -2932,6 +2932,9 @@ static int populate_opts_cb(const char *key, const char *value,
|
|||
else if (!strcmp(key, "options.allow-empty-message"))
|
||||
opts->allow_empty_message =
|
||||
git_config_bool_or_int(key, value, ctx->kvi, &error_flag);
|
||||
else if (!strcmp(key, "options.drop-redundant-commits"))
|
||||
opts->drop_redundant_commits =
|
||||
git_config_bool_or_int(key, value, ctx->kvi, &error_flag);
|
||||
else if (!strcmp(key, "options.keep-redundant-commits"))
|
||||
opts->keep_redundant_commits =
|
||||
git_config_bool_or_int(key, value, ctx->kvi, &error_flag);
|
||||
|
@ -3476,6 +3479,9 @@ static int save_opts(struct replay_opts *opts)
|
|||
if (opts->allow_empty_message)
|
||||
res |= git_config_set_in_file_gently(opts_file,
|
||||
"options.allow-empty-message", "true");
|
||||
if (opts->drop_redundant_commits)
|
||||
res |= git_config_set_in_file_gently(opts_file,
|
||||
"options.drop-redundant-commits", "true");
|
||||
if (opts->keep_redundant_commits)
|
||||
res |= git_config_set_in_file_gently(opts_file,
|
||||
"options.keep-redundant-commits", "true");
|
||||
|
|
|
@ -84,7 +84,7 @@ test_expect_success 'cherry-pick a commit that becomes no-op (prep)' '
|
|||
git commit -m "add file2 on the side"
|
||||
'
|
||||
|
||||
test_expect_success 'cherry-pick a no-op without --keep-redundant' '
|
||||
test_expect_success 'cherry-pick a no-op with neither --keep-redundant nor --empty' '
|
||||
git reset --hard &&
|
||||
git checkout fork^0 &&
|
||||
test_must_fail git cherry-pick main
|
||||
|
@ -113,4 +113,39 @@ test_expect_success '--keep-redundant-commits is incompatible with operations' '
|
|||
git cherry-pick --abort
|
||||
'
|
||||
|
||||
test_expect_success '--empty is incompatible with operations' '
|
||||
test_must_fail git cherry-pick HEAD 2>output &&
|
||||
test_grep "The previous cherry-pick is now empty" output &&
|
||||
test_must_fail git cherry-pick --empty=stop --continue 2>output &&
|
||||
test_grep "fatal: cherry-pick: --empty cannot be used with --continue" output &&
|
||||
test_must_fail git cherry-pick --empty=stop --skip 2>output &&
|
||||
test_grep "fatal: cherry-pick: --empty cannot be used with --skip" output &&
|
||||
test_must_fail git cherry-pick --empty=stop --abort 2>output &&
|
||||
test_grep "fatal: cherry-pick: --empty cannot be used with --abort" output &&
|
||||
test_must_fail git cherry-pick --empty=stop --quit 2>output &&
|
||||
test_grep "fatal: cherry-pick: --empty cannot be used with --quit" output &&
|
||||
git cherry-pick --abort
|
||||
'
|
||||
|
||||
test_expect_success 'cherry-pick a no-op with --empty=stop' '
|
||||
git reset --hard &&
|
||||
git checkout fork^0 &&
|
||||
test_must_fail git cherry-pick --empty=stop main 2>output &&
|
||||
test_grep "The previous cherry-pick is now empty" output
|
||||
'
|
||||
|
||||
test_expect_success 'cherry-pick a no-op with --empty=drop' '
|
||||
git reset --hard &&
|
||||
git checkout fork^0 &&
|
||||
git cherry-pick --empty=drop main &&
|
||||
test_commit_message HEAD -m "add file2 on the side"
|
||||
'
|
||||
|
||||
test_expect_success 'cherry-pick a no-op with --empty=keep' '
|
||||
git reset --hard &&
|
||||
git checkout fork^0 &&
|
||||
git cherry-pick --empty=keep main &&
|
||||
test_commit_message HEAD -m "add file2 on main"
|
||||
'
|
||||
|
||||
test_done
|
||||
|
|
|
@ -90,6 +90,38 @@ test_expect_success 'cherry-pick persists opts correctly' '
|
|||
test_cmp expect actual
|
||||
'
|
||||
|
||||
test_expect_success 'cherry-pick persists --empty=stop correctly' '
|
||||
pristine_detach yetanotherpick &&
|
||||
# Picking `anotherpick` forces a conflict so that we stop. That
|
||||
# commit is then skipped, after which we pick `yetanotherpick`
|
||||
# while already on `yetanotherpick` to cause an empty commit
|
||||
test_must_fail git cherry-pick --empty=stop anotherpick yetanotherpick &&
|
||||
test_must_fail git cherry-pick --skip 2>msg &&
|
||||
test_grep "The previous cherry-pick is now empty" msg &&
|
||||
rm msg &&
|
||||
git cherry-pick --abort
|
||||
'
|
||||
|
||||
test_expect_success 'cherry-pick persists --empty=drop correctly' '
|
||||
pristine_detach yetanotherpick &&
|
||||
# Picking `anotherpick` forces a conflict so that we stop. That
|
||||
# commit is then skipped, after which we pick `yetanotherpick`
|
||||
# while already on `yetanotherpick` to cause an empty commit
|
||||
test_must_fail git cherry-pick --empty=drop anotherpick yetanotherpick &&
|
||||
git cherry-pick --skip &&
|
||||
test_cmp_rev yetanotherpick HEAD
|
||||
'
|
||||
|
||||
test_expect_success 'cherry-pick persists --empty=keep correctly' '
|
||||
pristine_detach yetanotherpick &&
|
||||
# Picking `anotherpick` forces a conflict so that we stop. That
|
||||
# commit is then skipped, after which we pick `yetanotherpick`
|
||||
# while already on `yetanotherpick` to cause an empty commit
|
||||
test_must_fail git cherry-pick --empty=keep anotherpick yetanotherpick &&
|
||||
git cherry-pick --skip &&
|
||||
test_cmp_rev yetanotherpick HEAD^
|
||||
'
|
||||
|
||||
test_expect_success 'revert persists opts correctly' '
|
||||
pristine_detach initial &&
|
||||
# to make sure that the session to revert a sequence
|
||||
|
|
Loading…
Reference in a new issue