Re: [PATCH v5 3/3] rebase: add a config option for --rebase-merges
- From
Calvin Wan <calvinwan@google.com>
- Date
- Mar 2, 2023, 18:02 UTC
- Message-ID
- <20230302180226.2699247-1-calvinwan@google.com>
- In-Reply-To
- <20230225180325.796624-4-alexhenrie24@gmail.com>
Show 10 quoted lines
> + > +rebase.merges:: > + Whether and how to set the `--rebase-merges` option by default. Can > + be `rebase-cousins`, `no-rebase-cousins`, or a boolean. Setting to > + true is equivalent to `--rebase-merges` without an argument, setting to > + `rebase-cousins` or `no-rebase-cousins` is equivalent to > + `--rebase-merges` with that value as its argument, and setting to false > + is equivalent to `--no-rebase-merges`. Passing `--rebase-merges` on the > + command line without an argument overrides a `rebase.merges=false` > + configuration but does not override other values of `rebase.merge`.
I originally believed that having the boolean values as an option here created unnecessary complexity but I was convinced during Review Club that the tradeoff for a user who just wants to turn this on is fine. I'm just wondering whether this option will possibly have additional values in the future. If so, what would a user expect from setting this config to true?
Small typo at the end s/rebase.merge/rebase.merges
Show 185 quoted lines
> diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
> index c98784a0d2..b02f9cbb8c 100644
> --- a/Documentation/git-rebase.txt
> +++ b/Documentation/git-rebase.txt
> @@ -537,7 +537,8 @@ See also INCOMPATIBLE OPTIONS below.
> by recreating the merge commits. Any resolved merge conflicts or
> manual amendments in these merge commits will have to be
> resolved/re-applied manually. `--no-rebase-merges` can be used to
> - countermand a previous `--rebase-merges`.
> + countermand both the `rebase.merges` config option and a previous
> + `--rebase-merges`.
> +
> By default, or when `no-rebase-cousins` was specified, commits which do not
> have `<upstream>` as direct ancestor will keep their original branch point,
> diff --git a/builtin/rebase.c b/builtin/rebase.c
> index ccc13200b5..ac096f27e1 100644
> --- a/builtin/rebase.c
> +++ b/builtin/rebase.c
> @@ -123,6 +123,7 @@ struct rebase_options {
> int fork_point;
> int update_refs;
> int config_autosquash;
> + int config_rebase_merges;
> int config_update_refs;
> };
>
> @@ -140,6 +141,8 @@ struct rebase_options {
> .allow_empty_message = 1, \
> .autosquash = -1, \
> .config_autosquash = -1, \
> + .rebase_merges = -1, \
> + .config_rebase_merges = -1, \
> .update_refs = -1, \
> .config_update_refs = -1, \
> }
> @@ -771,6 +774,16 @@ static int run_specific_rebase(struct rebase_options *opts)
> return status ? -1 : 0;
> }
>
> +static void parse_rebase_merges_value(struct rebase_options *options, const char *value)
> +{
> + if (!strcmp("no-rebase-cousins", value))
> + options->rebase_cousins = 0;
> + else if (!strcmp("rebase-cousins", value))
> + options->rebase_cousins = 1;
> + else
> + die(_("Unknown rebase-merges mode: %s"), value);
> +}
> +
> static int rebase_config(const char *var, const char *value, void *data)
> {
> struct rebase_options *opts = data;
> @@ -800,6 +813,15 @@ static int rebase_config(const char *var, const char *value, void *data)
> return 0;
> }
>
> + if (!strcmp(var, "rebase.merges")) {
> + opts->config_rebase_merges = git_parse_maybe_bool(value);
> + if (opts->config_rebase_merges < 0) {
> + opts->config_rebase_merges = 1;
> + parse_rebase_merges_value(opts, value);
> + }
> + return 0;
> + }
> +
> if (!strcmp(var, "rebase.updaterefs")) {
> opts->config_update_refs = git_config_bool(var, value);
> return 0;
> @@ -980,6 +1002,27 @@ static int parse_opt_empty(const struct option *opt, const char *arg, int unset)
> return 0;
> }
>
> +static int parse_opt_rebase_merges(const struct option *opt, const char *arg, int unset)
> +{
> + struct rebase_options *options = opt->value;
> +
> + options->rebase_merges = !unset;
> +
> + if (arg) {
> + if (!*arg) {
> + warning(_("--rebase-merges with an empty string "
> + "argument is deprecated and will stop "
> + "working in a future version of Git. Use "
> + "--rebase-merges=no-rebase-cousins "
> + "instead."));
> + arg = "no-rebase-cousins";
> + }
> + parse_rebase_merges_value(options, arg);
> + }
> +
> + return 0;
> +}
> +
> static void NORETURN error_on_missing_default_upstream(void)
> {
> struct branch *current_branch = branch_get(NULL);
> @@ -1035,7 +1078,6 @@ int cmd_rebase(int argc, const char **argv, const char *prefix)
> struct object_id branch_base;
> int ignore_whitespace = 0;
> const char *gpg_sign = NULL;
> - const char *rebase_merges = NULL;
> struct string_list strategy_options = STRING_LIST_INIT_NODUP;
> struct object_id squash_onto;
> char *squash_onto_name = NULL;
> @@ -1137,10 +1179,9 @@ int cmd_rebase(int argc, const char **argv, const char *prefix)
> &options.allow_empty_message,
> N_("allow rebasing commits with empty messages"),
> PARSE_OPT_HIDDEN),
> - {OPTION_STRING, 'r', "rebase-merges", &rebase_merges,
> - N_("mode"),
> + OPT_CALLBACK_F('r', "rebase-merges", &options, N_("mode"),
> N_("try to rebase merges instead of skipping them"),
> - PARSE_OPT_OPTARG, NULL, (intptr_t)"no-rebase-cousins"},
> + PARSE_OPT_OPTARG, parse_opt_rebase_merges),
> OPT_BOOL(0, "fork-point", &options.fork_point,
> N_("use 'merge-base --fork-point' to refine upstream")),
> OPT_STRING('s', "strategy", &options.strategy,
> @@ -1436,21 +1477,6 @@ int cmd_rebase(int argc, const char **argv, const char *prefix)
> if (options.exec.nr)
> imply_merge(&options, "--exec");
>
> - if (rebase_merges) {
> - if (!*rebase_merges)
> - warning(_("--rebase-merges with an empty string "
> - "argument is deprecated and will stop "
> - "working in a future version of Git. Use "
> - "--rebase-merges=no-rebase-cousins "
> - "instead."));
> - else if (!strcmp("rebase-cousins", rebase_merges))
> - options.rebase_cousins = 1;
> - else if (strcmp("no-rebase-cousins", rebase_merges))
> - die(_("Unknown mode: %s"), rebase_merges);
> - options.rebase_merges = 1;
> - imply_merge(&options, "--rebase-merges");
> - }
> -
> if (options.type == REBASE_APPLY) {
> if (ignore_whitespace)
> strvec_push(&options.git_am_opts,
> @@ -1513,13 +1539,15 @@ int cmd_rebase(int argc, const char **argv, const char *prefix)
> break;
>
> if (i >= 0 || options.type == REBASE_APPLY) {
> - if (is_merge(&options))
> - die(_("apply options and merge options "
> - "cannot be used together"));
> - else if (options.autosquash == -1 && options.config_autosquash == 1)
> + if (options.autosquash == -1 && options.config_autosquash == 1)
> die(_("apply options are incompatible with rebase.autosquash. Consider adding --no-autosquash"));
> + else if (options.rebase_merges == -1 && options.config_rebase_merges == 1)
> + die(_("apply options are incompatible with rebase.merges. Consider adding --no-rebase-merges"));
> else if (options.update_refs == -1 && options.config_update_refs == 1)
> die(_("apply options are incompatible with rebase.updateRefs. Consider adding --no-update-refs"));
> + else if (is_merge(&options))
> + die(_("apply options and merge options "
> + "cannot be used together"));
> else
> options.type = REBASE_APPLY;
> }
> @@ -1530,6 +1558,11 @@ int cmd_rebase(int argc, const char **argv, const char *prefix)
> options.update_refs = (options.update_refs >= 0) ? options.update_refs :
> ((options.config_update_refs >= 0) ? options.config_update_refs : 0);
>
> + if (options.rebase_merges == 1)
> + imply_merge(&options, "--rebase-merges");
> + options.rebase_merges = (options.rebase_merges >= 0) ? options.rebase_merges :
> + ((options.config_rebase_merges >= 0) ? options.config_rebase_merges : 0);
> +
> if (options.autosquash == 1)
> imply_merge(&options, "--autosquash");
> options.autosquash = (options.autosquash >= 0) ? options.autosquash :
> diff --git a/t/t3422-rebase-incompatible-options.sh b/t/t3422-rebase-incompatible-options.sh
> index 4711b37a28..af93f13849 100755
> --- a/t/t3422-rebase-incompatible-options.sh
> +++ b/t/t3422-rebase-incompatible-options.sh
> @@ -101,6 +101,12 @@ test_rebase_am_only () {
> grep -e --no-autosquash err
> "
>
> + test_expect_success "$opt incompatible with rebase.merges" "
> + git checkout B^0 &&
> + test_must_fail git -c rebase.merges=true rebase $opt A 2>err &&
> + grep -e --no-rebase-merges err
> + "
> +Missing an additional test here "$opt incompatible with --rebase-merges" to match the test patterns from the other option/config combos.
Show 95 quoted lines
> test_expect_success "$opt incompatible with rebase.updateRefs" "
> git checkout B^0 &&
> test_must_fail git -c rebase.updateRefs=true rebase $opt A 2>err &&
> @@ -113,6 +119,12 @@ test_rebase_am_only () {
> git -c rebase.autosquash=true rebase --no-autosquash $opt A
> "
>
> + test_expect_success "$opt okay with overridden rebase.merges" "
> + test_when_finished \"git reset --hard B^0\" &&
> + git checkout B^0 &&
> + git -c rebase.merges=true rebase --no-rebase-merges $opt A
> + "
> +
> test_expect_success "$opt okay with overridden rebase.updateRefs" "
> test_when_finished \"git reset --hard B^0\" &&
> git checkout B^0 &&
> diff --git a/t/t3430-rebase-merges.sh b/t/t3430-rebase-merges.sh
> index f50fbf1390..a825a77fb4 100755
> --- a/t/t3430-rebase-merges.sh
> +++ b/t/t3430-rebase-merges.sh
> @@ -283,6 +283,69 @@ test_expect_success '--rebase-merges="" is deprecated' '
> grep deprecated actual
> '
>
> +test_expect_success 'rebase.merges=rebase-cousins is equivalent to --rebase-merges=rebase-cousins' '
> + test_config rebase.merges rebase-cousins &&
> + git checkout -b config-rebase-cousins main &&
> + git rebase HEAD^ &&
> + test_cmp_graph HEAD^.. <<-\EOF
> + * Merge the topic branch '\''onebranch'\''
> + |\
> + | * D
> + | * G
> + |/
> + o H
> + EOF
> +'
> +
> +test_expect_success '--no-rebase-merges overrides rebase.merges=no-rebase-cousins' '
> + test_config rebase.merges no-rebase-cousins &&
> + git checkout -b override-config-no-rebase-cousins E &&
> + git rebase --no-rebase-merges C &&
> + test_cmp_graph C.. <<-\EOF
> + * B
> + * D
> + o C
> + EOF
> +'
> +
> +test_expect_success '--rebase-merges=no-rebase-cousins overrides rebase.merges=rebase-cousins' '
> + test_config rebase.merges rebase-cousins &&
> + git checkout -b override-config-rebase-cousins main &&
> + git rebase --rebase-merges=no-rebase-cousins HEAD^ &&
> + test_cmp_graph HEAD^.. <<-\EOF
> + * Merge the topic branch '\''onebranch'\''
> + |\
> + | * D
> + | * G
> + o | H
> + |/
> + o A
> + EOF
> +'
> +
> +test_expect_success '--rebase-merges overrides rebase.merges=false' '
> + test_config rebase.merges false &&
> + git checkout -b override-config-merges-false E &&
> + before="$(git rev-parse --verify HEAD)" &&
> + test_tick &&
> + git rebase --rebase-merges C &&
> + test_cmp_rev HEAD $before
> +'
> +
> +test_expect_success '--rebase-merges does not override rebase.merges=rebase-cousins' '
> + test_config rebase.merges rebase-cousins &&
> + git checkout -b no-override-config-rebase-cousins main &&
> + git rebase --rebase-merges HEAD^ &&
> + test_cmp_graph HEAD^.. <<-\EOF
> + * Merge the topic branch '\''onebranch'\''
> + |\
> + | * D
> + | * G
> + |/
> + o H
> + EOF
> +'
> +
> test_expect_success 'refs/rewritten/* is worktree-local' '
> git worktree add wt &&
> cat >wt/script-from-scratch <<-\EOF &&
> --
> 2.39.2
>
>
>