]> git.ipfire.org Git - thirdparty/git.git/commitdiff
pull --rebase/remote rename: document and honor single-letter abbreviations rebase...
authorBert Wesarg <bert.wesarg@googlemail.com>
Mon, 27 Jan 2020 07:04:27 +0000 (08:04 +0100)
committerJunio C Hamano <gitster@pobox.com>
Mon, 10 Feb 2020 18:52:10 +0000 (10:52 -0800)
When 46af44b07d (pull --rebase=<type>: allow single-letter abbreviations
for the type, 2018-08-04) landed in Git, it had the side effect that
not only 'pull --rebase=<type>' accepted the single-letter abbreviations
but also the 'pull.rebase' and 'branch.<name>.rebase' configurations.

However, 'git remote rename' did not honor these single-letter
abbreviations when reading the 'branch.*.rebase' configurations.

We now document the single-letter abbreviations and both code places
share a common function to parse the values of 'git pull --rebase=*',
'pull.rebase', and 'branches.*.rebase'.

The only functional change is the handling of the `branch_info::rebase`
value. Before it was an unsigned enum, thus the truth value could be
checked with `branch_info::rebase != 0`. But `enum rebase_type` is
signed, thus the truth value must now be checked with
`branch_info::rebase >= REBASE_TRUE`

Signed-off-by: Bert Wesarg <bert.wesarg@googlemail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/branch.txt
Documentation/config/pull.txt
Makefile
builtin/pull.c
builtin/remote.c
rebase.c [new file with mode: 0644]
rebase.h [new file with mode: 0644]

index a592d522a744f99cd2c8f94400bca1203bfe2886..cc5f3249fc58a39da1580b49ad0145c44ec1544f 100644 (file)
@@ -81,15 +81,16 @@ branch.<name>.rebase::
        "git pull" is run. See "pull.rebase" for doing this in a non
        branch-specific manner.
 +
-When `merges`, pass the `--rebase-merges` option to 'git rebase'
+When `merges` (or just 'm'), pass the `--rebase-merges` option to 'git rebase'
 so that the local merge commits are included in the rebase (see
 linkgit:git-rebase[1] for details).
 +
-When `preserve` (deprecated in favor of `merges`), also pass
+When `preserve` (or just 'p', deprecated in favor of `merges`), also pass
 `--preserve-merges` along to 'git rebase' so that locally committed merge
 commits will not be flattened by running 'git pull'.
 +
-When the value is `interactive`, the rebase is run in interactive mode.
+When the value is `interactive` (or just 'i'), the rebase is run in interactive
+mode.
 +
 *NOTE*: this is a possibly dangerous operation; do *not* use
 it unless you understand the implications (see linkgit:git-rebase[1]
index b87cab31b39c4469fc2528c04bd19b6b96912dd7..5404830609569d78dbcd597847c86e4302123b75 100644 (file)
@@ -14,15 +14,16 @@ pull.rebase::
        pull" is run. See "branch.<name>.rebase" for setting this on a
        per-branch basis.
 +
-When `merges`, pass the `--rebase-merges` option to 'git rebase'
+When `merges` (or just 'm'), pass the `--rebase-merges` option to 'git rebase'
 so that the local merge commits are included in the rebase (see
 linkgit:git-rebase[1] for details).
 +
-When `preserve` (deprecated in favor of `merges`), also pass
+When `preserve` (or just 'p', deprecated in favor of `merges`), also pass
 `--preserve-merges` along to 'git rebase' so that locally committed merge
 commits will not be flattened by running 'git pull'.
 +
-When the value is `interactive`, the rebase is run in interactive mode.
+When the value is `interactive` (or just 'i'), the rebase is run in interactive
+mode.
 +
 *NOTE*: this is a possibly dangerous operation; do *not* use
 it unless you understand the implications (see linkgit:git-rebase[1]
index 09f98b777cae1dc9226f13c182011adacfd8b2fc..96ced97bffd5ec4a14516e76a4b09adb2c569aac 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -954,6 +954,7 @@ LIB_OBJS += quote.o
 LIB_OBJS += range-diff.o
 LIB_OBJS += reachable.o
 LIB_OBJS += read-cache.o
+LIB_OBJS += rebase.o
 LIB_OBJS += rebase-interactive.o
 LIB_OBJS += reflog-walk.o
 LIB_OBJS += refs.o
index d25ff13a60f2d08efdc160c359364ab94a5b19ae..888181c07ce49babc904bbdb431665fa31dfae9a 100644 (file)
@@ -15,6 +15,7 @@
 #include "sha1-array.h"
 #include "remote.h"
 #include "dir.h"
+#include "rebase.h"
 #include "refs.h"
 #include "refspec.h"
 #include "revision.h"
 #include "commit-reach.h"
 #include "sequencer.h"
 
-enum rebase_type {
-       REBASE_INVALID = -1,
-       REBASE_FALSE = 0,
-       REBASE_TRUE,
-       REBASE_PRESERVE,
-       REBASE_MERGES,
-       REBASE_INTERACTIVE
-};
-
 /**
  * Parses the value of --rebase. If value is a false value, returns
  * REBASE_FALSE. If value is a true value, returns REBASE_TRUE. If value is
@@ -45,22 +37,9 @@ enum rebase_type {
 static enum rebase_type parse_config_rebase(const char *key, const char *value,
                int fatal)
 {
-       int v = git_parse_maybe_bool(value);
-
-       if (!v)
-               return REBASE_FALSE;
-       else if (v > 0)
-               return REBASE_TRUE;
-       else if (!strcmp(value, "preserve") || !strcmp(value, "p"))
-               return REBASE_PRESERVE;
-       else if (!strcmp(value, "merges") || !strcmp(value, "m"))
-               return REBASE_MERGES;
-       else if (!strcmp(value, "interactive") || !strcmp(value, "i"))
-               return REBASE_INTERACTIVE;
-       /*
-        * Please update _git_config() in git-completion.bash when you
-        * add new rebase modes.
-        */
+       enum rebase_type v = rebase_parse_value(value);
+       if (v != REBASE_INVALID)
+               return v;
 
        if (fatal)
                die(_("Invalid value for %s: %s"), key, value);
index 96bbe828fe20b138d3949ad7080621380c1fe00d..6802765e736ad727573793fe12fd703a8b88a38f 100644 (file)
@@ -6,6 +6,7 @@
 #include "string-list.h"
 #include "strbuf.h"
 #include "run-command.h"
+#include "rebase.h"
 #include "refs.h"
 #include "refspec.h"
 #include "object-store.h"
@@ -248,9 +249,7 @@ static int add(int argc, const char **argv)
 struct branch_info {
        char *remote_name;
        struct string_list merge;
-       enum {
-               NO_REBASE, NORMAL_REBASE, INTERACTIVE_REBASE, REBASE_MERGES
-       } rebase;
+       enum rebase_type rebase;
 };
 
 static struct string_list branch_list = STRING_LIST_INIT_NODUP;
@@ -305,17 +304,12 @@ static int config_read_branches(const char *key, const char *value, void *cb)
                                space = strchr(value, ' ');
                        }
                        string_list_append(&info->merge, xstrdup(value));
-               } else {
-                       int v = git_parse_maybe_bool(value);
-                       if (v >= 0)
-                               info->rebase = v;
-                       else if (!strcmp(value, "preserve"))
-                               info->rebase = NORMAL_REBASE;
-                       else if (!strcmp(value, "merges"))
-                               info->rebase = REBASE_MERGES;
-                       else if (!strcmp(value, "interactive"))
-                               info->rebase = INTERACTIVE_REBASE;
-               }
+               } else
+                       /*
+                        * Consider invalid values as false and check the
+                        * truth value with >= REBASE_TRUE.
+                        */
+                       info->rebase = rebase_parse_value(value);
        }
        return 0;
 }
@@ -943,7 +937,7 @@ static int add_local_to_show_info(struct string_list_item *branch_item, void *cb
                return 0;
        if ((n = strlen(branch_item->string)) > show_info->width)
                show_info->width = n;
-       if (branch_info->rebase)
+       if (branch_info->rebase >= REBASE_TRUE)
                show_info->any_rebase = 1;
 
        item = string_list_insert(show_info->list, branch_item->string);
@@ -960,16 +954,16 @@ static int show_local_info_item(struct string_list_item *item, void *cb_data)
        int width = show_info->width + 4;
        int i;
 
-       if (branch_info->rebase && branch_info->merge.nr > 1) {
+       if (branch_info->rebase >= REBASE_TRUE && branch_info->merge.nr > 1) {
                error(_("invalid branch.%s.merge; cannot rebase onto > 1 branch"),
                        item->string);
                return 0;
        }
 
        printf("    %-*s ", show_info->width, item->string);
-       if (branch_info->rebase) {
+       if (branch_info->rebase >= REBASE_TRUE) {
                const char *msg;
-               if (branch_info->rebase == INTERACTIVE_REBASE)
+               if (branch_info->rebase == REBASE_INTERACTIVE)
                        msg = _("rebases interactively onto remote %s");
                else if (branch_info->rebase == REBASE_MERGES)
                        msg = _("rebases interactively (with merges) onto "
diff --git a/rebase.c b/rebase.c
new file mode 100644 (file)
index 0000000..f8137d8
--- /dev/null
+++ b/rebase.c
@@ -0,0 +1,35 @@
+#include "rebase.h"
+#include "config.h"
+
+/*
+ * Parses textual value for pull.rebase, branch.<name>.rebase, etc.
+ * Unrecognised value yields REBASE_INVALID, which traditionally is
+ * treated the same way as REBASE_FALSE.
+ *
+ * The callers that care if (any) rebase is requested should say
+ *   if (REBASE_TRUE <= rebase_parse_value(string))
+ *
+ * The callers that want to differenciate an unrecognised value and
+ * false can do so by treating _INVALID and _FALSE differently.
+ */
+enum rebase_type rebase_parse_value(const char *value)
+{
+       int v = git_parse_maybe_bool(value);
+
+       if (!v)
+               return REBASE_FALSE;
+       else if (v > 0)
+               return REBASE_TRUE;
+       else if (!strcmp(value, "preserve") || !strcmp(value, "p"))
+               return REBASE_PRESERVE;
+       else if (!strcmp(value, "merges") || !strcmp(value, "m"))
+               return REBASE_MERGES;
+       else if (!strcmp(value, "interactive") || !strcmp(value, "i"))
+               return REBASE_INTERACTIVE;
+       /*
+        * Please update _git_config() in git-completion.bash when you
+        * add new rebase modes.
+        */
+
+       return REBASE_INVALID;
+}
diff --git a/rebase.h b/rebase.h
new file mode 100644 (file)
index 0000000..cc723d4
--- /dev/null
+++ b/rebase.h
@@ -0,0 +1,15 @@
+#ifndef REBASE_H
+#define REBASE_H
+
+enum rebase_type {
+       REBASE_INVALID = -1,
+       REBASE_FALSE = 0,
+       REBASE_TRUE,
+       REBASE_PRESERVE,
+       REBASE_MERGES,
+       REBASE_INTERACTIVE
+};
+
+enum rebase_type rebase_parse_value(const char *value);
+
+#endif /* REBASE */