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

[RFC PATCH 26/35] pull: add pull.mode

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
Jul 5, 2021, 12:32 UTC
Message-ID
<20210705123209.1808663-27-felipe.contreras@gmail.com>
In-Reply-To
<20210705123209.1808663-1-felipe.contreras@gmail.com>

The evolution of pull options has somewhat served most users, however, they have been found lacking for a very needed trio: merge / rebase / fast-forward-only.

To avoid some of the problems of git pull Linus Torvalds suggested a configuration pull.merge [1], however, instead of having pull.merge and pull.rebase, we can have pull.mode which works for both.

Additionally this would allow us to have a saner per-branch configuration: branch.<name>.pullMode.

This patch adds a pull.mode option with two possible values (for now); merge and rebase. If set, it overrides what the user has specified in pull.rebase, and it's updated with either --merge, or --rebase.

[1] https://lore.kernel.org/git/CA+55aFz2Uvq4vmyjJPao5tS-uuVvKm6mbP7Uz8sdq1VMxMGJCw@mail.gmail.com/
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/config/pull.txt |  5 +++
 builtin/pull.c                | 68 ++++++++++++++++++++++++++++++++---
 rebase.c                      | 10 ++++++
 rebase.h                      |  9 +++++
 t/t5520-pull.sh               | 42 ++++++++++++++++++++++
 t/t7601-merge-pull-config.sh  | 14 ++++++++
 6 files changed, 143 insertions(+), 5 deletions(-)
diff --git a/Documentation/config/pull.txt b/Documentation/config/pull.txt
index 5404830609..646431a02d 100644
--- a/Documentation/config/pull.txt
+++ b/Documentation/config/pull.txt
@@ -29,6 +29,11 @@ mode.
 it unless you understand the implications (see linkgit:git-rebase[1]
 for details).
 
+pull.mode::
+	When "git pull" is run, this determines if it would either merge or
+	rebase the fetched branch. The possible values are 'merge',
+	and 'rebase'.
+
 pull.octopus::
 	The default merge strategy to use when pulling multiple branches
 	at once.
diff --git a/builtin/pull.c b/builtin/pull.c
index 2c2f0822d5..124575c32c 100644
--- a/builtin/pull.c
+++ b/builtin/pull.c
@@ -27,6 +27,8 @@
 #include "commit-reach.h"
 #include "sequencer.h"
 
+static enum pull_mode_type mode;
+
 /**
  * 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
@@ -49,6 +51,14 @@ static enum rebase_type parse_config_rebase(const char *key, const char *value,
 	return REBASE_INVALID;
 }
 
+static enum pull_mode_type parse_config_pull_mode(const char *key, const char *value)
+{
+	enum pull_mode_type v = pull_mode_parse_value(value);
+	if (v == PULL_MODE_INVALID)
+		die(_("Invalid value for %s: %s"), key, value);
+	return v;
+}
+
 /**
  * Callback for --rebase, which parses arg with parse_config_rebase().
  */
@@ -60,9 +70,21 @@ static int parse_opt_rebase(const struct option *opt, const char *arg, int unset
 		*value = parse_config_rebase("--rebase", arg, 0);
 	else
 		*value = unset ? REBASE_FALSE : REBASE_TRUE;
+
+	if (*value > 0)
+		mode = *value >= REBASE_TRUE ? PULL_MODE_REBASE : PULL_MODE_MERGE;
+
 	return *value == REBASE_INVALID ? -1 : 0;
 }
 
+static int parse_opt_merge(const struct option *opt, const char *arg, int unset)
+{
+	enum rebase_type *value = opt->value;
+	mode = PULL_MODE_MERGE;
+	*value = REBASE_FALSE;
+	return 0;
+}
+
 static const char * const pull_usage[] = {
 	N_("git pull [<options>] [<repository> [<refspec>...]]"),
 	NULL
@@ -129,8 +151,9 @@ static struct option pull_options[] = {
 		"(false|true|merges|preserve|interactive)",
 		N_("incorporate changes by rebasing rather than merging"),
 		PARSE_OPT_OPTARG, parse_opt_rebase),
-	OPT_SET_INT('m', "merge", &opt_rebase,
-		N_("incorporate changes by merging"), REBASE_FALSE),
+	OPT_CALLBACK_F('m', "merge", &opt_rebase, NULL,
+		N_("incorporate changes by merging"),
+		PARSE_OPT_NOARG | PARSE_OPT_NONEG, parse_opt_merge),
 	OPT_PASSTHRU('n', NULL, &opt_diffstat, NULL,
 		N_("do not show a diffstat at the end of the merge"),
 		PARSE_OPT_NOARG | PARSE_OPT_NONEG),
@@ -349,6 +372,16 @@ static enum rebase_type config_get_rebase(void)
 	return REBASE_DEFAULT;
 }
 
+static enum pull_mode_type config_get_pull_mode(const char *repo)
+{
+	const char *value;
+
+	if (!git_config_get_value("pull.mode", &value))
+		return parse_config_pull_mode("pull.mode", value);
+
+	return PULL_MODE_DEFAULT;
+}
+
 /**
  * Read config variables.
  */
@@ -931,9 +964,9 @@ static void show_advice_pull_non_ff(void)
 		 "discouraged. You can squelch this message by running one of the following\n"
 		 "commands sometime before your next pull:\n"
 		 "\n"
-		 "  git config pull.rebase false  # merge (the default strategy)\n"
-		 "  git config pull.rebase true   # rebase\n"
-		 "  git config pull.ff only       # fast-forward only\n"
+		 "  git config pull.mode merge  # the default strategy\n"
+		 "  git config pull.mode rebase\n"
+		 "  git config pull.ff only     # fast-forward only\n"
 		 "\n"
 		 "You can replace \"git config\" with \"git config --global\" to set a default\n"
 		 "preference for all repositories. You can also pass --rebase, --merge,\n"
@@ -968,6 +1001,31 @@ int cmd_pull(int argc, const char **argv, const char *prefix)
 
 	parse_repo_refspecs(argc, argv, &repo, &refspecs);
 
+	/*
+	 * If the user has not specified --merge or --rebase, fetch pull.mode to override
+	 * pull.rename.
+	 */
+	if (!mode) {
+		mode = config_get_pull_mode(repo);
+
+		switch (mode) {
+		case PULL_MODE_MERGE:
+			opt_rebase = REBASE_FALSE;
+			break;
+		case PULL_MODE_REBASE:
+			/* Do not oeverride other rebase modes */
+			if (opt_rebase < REBASE_TRUE)
+				opt_rebase = REBASE_TRUE;
+			break;
+		case PULL_MODE_DEFAULT:
+			if (opt_rebase > 0)
+				mode = opt_rebase >= REBASE_TRUE ? PULL_MODE_REBASE : PULL_MODE_MERGE;
+			break;
+		default:
+			break;
+		}
+	}
+
 	if (read_cache_unmerged())
 		die_resolve_conflict("pull");
 
diff --git a/rebase.c b/rebase.c
index f8137d859b..bdfca49886 100644
--- a/rebase.c
+++ b/rebase.c
@@ -33,3 +33,13 @@ enum rebase_type rebase_parse_value(const char *value)
 
 	return REBASE_INVALID;
 }
+
+enum pull_mode_type pull_mode_parse_value(const char *value)
+{
+	if (!strcmp(value, "merge") || !strcmp(value, "m"))
+		return PULL_MODE_MERGE;
+	else if (!strcmp(value, "rebase") || !strcmp(value, "r"))
+		return PULL_MODE_REBASE;
+
+	return PULL_MODE_INVALID;
+}
diff --git a/rebase.h b/rebase.h
index 34d4acfd74..5ab8f4ddd5 100644
--- a/rebase.h
+++ b/rebase.h
@@ -13,4 +13,13 @@ enum rebase_type {
 
 enum rebase_type rebase_parse_value(const char *value);
 
+enum pull_mode_type {
+	PULL_MODE_INVALID = -1,
+	PULL_MODE_DEFAULT = 0,
+	PULL_MODE_MERGE,
+	PULL_MODE_REBASE
+};
+
+enum pull_mode_type pull_mode_parse_value(const char *value);
+
 #endif /* REBASE */
diff --git a/t/t5520-pull.sh b/t/t5520-pull.sh
index e2c0c51022..663c15fcd7 100755
--- a/t/t5520-pull.sh
+++ b/t/t5520-pull.sh
@@ -452,6 +452,16 @@ test_expect_success 'pull.rebase' '
 	test_cmp expect actual
 '
 
+test_expect_success 'pull.mode rebase' '
+	git reset --hard before-rebase &&
+	test_config pull.mode rebase &&
+	git pull . copy &&
+	test_cmp_rev HEAD^ copy &&
+	echo new >expect &&
+	git show HEAD:file2 >actual &&
+	test_cmp expect actual
+'
+
 test_expect_success 'pull --autostash & pull.rebase=true' '
 	test_config pull.rebase true &&
 	test_pull_autostash 1 --autostash
@@ -526,6 +536,17 @@ test_expect_success 'pull.rebase=false create a new merge commit' '
 	test_cmp expect actual
 '
 
+test_expect_success 'pull.mode=merge create a new merge commit' '
+	git reset --hard before-preserve-rebase &&
+	test_config pull.mode merge &&
+	git pull . copy &&
+	test_cmp_rev HEAD^1 before-preserve-rebase &&
+	test_cmp_rev HEAD^2 copy &&
+	echo file3 >expect &&
+	git show HEAD:file3.t >actual &&
+	test_cmp expect actual
+'
+
 test_expect_success 'pull.rebase=true flattens keep-merge' '
 	git reset --hard before-preserve-rebase &&
 	test_config pull.rebase true &&
@@ -555,6 +576,16 @@ test_expect_success REBASE_P \
 	test_cmp_rev HEAD^2 keep-merge
 '
 
+test_expect_success REBASE_P \
+	'pull.rebase=preserve rebases and merges keep-merge with pull.mode' '
+	git reset --hard before-preserve-rebase &&
+	test_config pull.mode rebase &&
+	test_config pull.rebase preserve &&
+	git pull . copy &&
+	test_cmp_rev HEAD^^ copy &&
+	test_cmp_rev HEAD^2 keep-merge
+'
+
 test_expect_success 'pull.rebase=interactive' '
 	write_script "$TRASH_DIRECTORY/fake-editor" <<-\EOF &&
 	echo I was here >fake.out &&
@@ -596,6 +627,17 @@ test_expect_success '--rebase=false create a new merge commit' '
 	test_cmp expect actual
 '
 
+test_expect_success '--rebase=false create a new merge commit with pull.mode' '
+	git reset --hard before-preserve-rebase &&
+	test_config pull.mode rebase &&
+	git pull --rebase=false . copy &&
+	test_cmp_rev HEAD^1 before-preserve-rebase &&
+	test_cmp_rev HEAD^2 copy &&
+	echo file3 >expect &&
+	git show HEAD:file3.t >actual &&
+	test_cmp expect actual
+'
+
 test_expect_success '--rebase=true rebases and flattens keep-merge' '
 	git reset --hard before-preserve-rebase &&
 	test_config pull.rebase preserve &&
diff --git a/t/t7601-merge-pull-config.sh b/t/t7601-merge-pull-config.sh
index 7c4607191a..47fd2e2d05 100755
--- a/t/t7601-merge-pull-config.sh
+++ b/t/t7601-merge-pull-config.sh
@@ -33,6 +33,13 @@ test_expect_success 'pull.rebase not set' '
 	test_i18ngrep ! "Pulling without specifying how to reconcile" err
 '
 
+test_expect_success 'pull.mode set' '
+	git reset --hard c0 &&
+	test_config pull.mode merge &&
+	git pull . c1 2>err &&
+	test_i18ngrep ! "Pulling without specifying how to reconcile" err
+'
+
 test_expect_success 'pull.rebase not set and pull.ff=true' '
 	git reset --hard c0 &&
 	test_config pull.ff true &&
@@ -92,6 +99,13 @@ test_expect_success 'pull.rebase not set (not-fast-forward)' '
 	test_i18ngrep "Pulling without specifying how to reconcile" decoded
 '
 
+test_expect_success 'pull.mode set' '
+	git reset --hard c2 &&
+	test_config pull.mode merge &&
+	git pull . c1 2>err &&
+	test_i18ngrep ! "Pulling without specifying how to reconcile" err
+'
+
 test_expect_success 'pull.rebase not set and pull.ff=true (not-fast-forward)' '
 	git reset --hard c2 &&
 	test_config pull.ff true &&

-- 
2.32.0.36.g70aac2b1aa
Previous: Felipe ContrerasNext: Felipe Contreras
Message 44 of 53 in “git update: fix broken git pull”
  1. 00/35 git update: fix broken git pullFelipe Contreras, Jul 5, 2021
  2. 01/35 merge: improve fatal fast-forward messageFelipe Contreras, Jul 5, 2021
  3. Ævar Arnfjörð BjarmasonJul 6, 2021
  4. Felipe ContrerasJul 6, 2021
  5. Randall S. BeckerJul 6, 2021
  6. Junio C HamanoJul 6, 2021
  7. Felipe ContrerasJul 6, 2021
  8. Randall S. BeckerJul 6, 2021
  9. Junio C HamanoJul 6, 2021
  10. Randall S. BeckerJul 6, 2021
  11. Felipe ContrerasJul 6, 2021
  12. Randall S. BeckerJul 6, 2021
  13. Felipe ContrerasJul 6, 2021
  14. 02/35 merge: split cmd_merge()Felipe Contreras, Jul 5, 2021
  15. 03/35 fast-forward: add new builtinFelipe Contreras, Jul 5, 2021
  16. 04/35 doc: fast-forward: explain what it isFelipe Contreras, Jul 5, 2021
  17. 05/35 fast-forward: add advice for novicesFelipe Contreras, Jul 5, 2021
  18. Ævar Arnfjörð BjarmasonJul 6, 2021
  19. Felipe ContrerasJul 6, 2021
  20. 06/35 fast-forward: make the advise configurableFelipe Contreras, Jul 5, 2021
  21. 07/35 fast-forward: add help about merge vs. rebaseFelipe Contreras, Jul 5, 2021
  22. 08/35 update: new built-inFelipe Contreras, Jul 5, 2021
  23. 09/35 update: add options and usage skeletonFelipe Contreras, Jul 5, 2021
  24. 10/35 update: add --ff optionFelipe Contreras, Jul 5, 2021
  25. Ævar Arnfjörð BjarmasonJul 6, 2021
  26. Felipe ContrerasJul 6, 2021
  27. 11/35 update: add --merge modeFelipe Contreras, Jul 5, 2021
  28. Ævar Arnfjörð BjarmasonJul 6, 2021
  29. Felipe ContrerasJul 6, 2021
  30. 12/35 commit: support for multiple MERGE_MODEFelipe Contreras, Jul 5, 2021
  31. 13/35 merge: add --reverse-parents optionFelipe Contreras, Jul 5, 2021
  32. 14/35 update: reverse the order of parentsFelipe Contreras, Jul 5, 2021
  33. 15/35 update: fake a reverse order of parents in messageFelipe Contreras, Jul 5, 2021
  34. 16/35 update: add --rebase modeFelipe Contreras, Jul 5, 2021
  35. 17/35 update: add mode configuationFelipe Contreras, Jul 5, 2021
  36. 18/35 update: add per-branch mode configurationFelipe Contreras, Jul 5, 2021
  37. 19/35 pull: cleanup autostash checkFelipe Contreras, Jul 5, 2021
  38. 20/35 pull: trivial cleanupFelipe Contreras, Jul 5, 2021
  39. 21/35 pull: trivial whitespace style fixFelipe Contreras, Jul 5, 2021
  40. 22/35 pull: introduce --merge optionFelipe Contreras, Jul 5, 2021
  41. 23/35 rebase: add REBASE_DEFAULTFelipe Contreras, Jul 5, 2021
  42. 24/35 pull: move configuration fetchesFelipe Contreras, Jul 5, 2021
  43. 25/35 pull: show warning with --ff optionsFelipe Contreras, Jul 5, 2021
  44. 26/35 pull: add pull.modeFelipe Contreras, Jul 5, 2021
  45. 27/35 pull: add per-branch mode configurationFelipe Contreras, Jul 5, 2021
  46. 28/35 pull: add pull.mode=fast-forwardFelipe Contreras, Jul 5, 2021
  47. 29/35 pull: reorganize mode conditionalsFelipe Contreras, Jul 5, 2021
  48. 30/35 pull: add diverging advice on fast-forward modeFelipe Contreras, Jul 5, 2021
  49. 31/35 pull: improve --rebase and pull.rebase interactionFelipe Contreras, Jul 5, 2021
  50. 32/35 pull: improve default warningFelipe Contreras, Jul 5, 2021
  51. 33/35 pull: advice of future changesFelipe Contreras, Jul 5, 2021
  52. 34/35 FUTURE: pull: enable ff-only mode by defaultFelipe Contreras, Jul 5, 2021
  53. 35/35 !fixup FUTURE: pull: enable ff-only mode by defaultFelipe Contreras, Jul 5, 2021

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.