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

[PATCH v8 1/3] branch: accept multiple upstream branches for tracking

From
Josh Steadmon <steadmon@google.com>
Date
Dec 21, 2021, 03:30 UTC
Message-ID
<a5265e1c7f4dc1a69e85511d2cc3f659cc46788f.1640039978.git.steadmon@google.com>
In-Reply-To
<cover.1640039978.git.steadmon@google.com>

Add a new static variant of install_branch_config() that accepts multiple remote branch names for tracking. This will be used in an upcoming commit that enables inheriting the tracking configuration from a parent branch.

Currently, all callers of install_branch_config() pass only a single remote. Make install_branch_config() a small wrapper around install_branch_config_multiple_remotes() so that existing callers do not need to be changed.

Signed-off-by: Josh Steadmon <steadmon@google.com>
---
 branch.c          | 143 +++++++++++++++++++++++++++++++++-------------
 t/t3200-branch.sh |   6 +-
 2 files changed, 106 insertions(+), 43 deletions(-)
diff --git a/branch.c b/branch.c
index 7a88a4861e..a41a300f9c 100644
--- a/branch.c
+++ b/branch.c
@@ -49,25 +49,46 @@ static int should_setup_rebase(const char *origin)
 	return 0;
 }
 
-static const char tracking_advice[] =
-N_("\n"
-"After fixing the error cause you may try to fix up\n"
-"the remote tracking information by invoking\n"
-"\"git branch --set-upstream-to=%s%s%s\".");
-
-int install_branch_config(int flag, const char *local, const char *origin, const char *remote)
+/**
+ * Install upstream tracking configuration for a branch; specifically, add
+ * `branch.<name>.remote` and `branch.<name>.merge` entries.
+ *
+ * `flag` contains integer flags for options; currently only
+ * BRANCH_CONFIG_VERBOSE is checked.
+ *
+ * `local` is the name of the branch whose configuration we're installing.
+ *
+ * `origin` is the name of the remote owning the upstream branches. NULL means
+ * the upstream branches are local to this repo.
+ *
+ * `remotes` is a list of refs that are upstream of local
+ */
+static int install_branch_config_multiple_remotes(int flag, const char *local,
+		const char *origin, struct string_list *remotes)
 {
 	const char *shortname = NULL;
 	struct strbuf key = STRBUF_INIT;
+	struct string_list_item *item;
 	int rebasing = should_setup_rebase(origin);
 
-	if (skip_prefix(remote, "refs/heads/", &shortname)
-	    && !strcmp(local, shortname)
-	    && !origin) {
-		warning(_("Not setting branch %s as its own upstream."),
-			local);
-		return 0;
-	}
+	if (!remotes->nr)
+		BUG("must provide at least one remote for branch config");
+	if (rebasing && remotes->nr > 1)
+		die(_("cannot inherit upstream tracking configuration of "
+		      "multiple refs when rebasing is requested"));
+
+	/*
+	 * If the new branch is trying to track itself, something has gone
+	 * wrong. Warn the user and don't proceed any further.
+	 */
+	if (!origin)
+		for_each_string_list_item(item, remotes)
+			if (skip_prefix(item->string, "refs/heads/", &shortname)
+			    && !strcmp(local, shortname)) {
+				warning(_("not setting branch '%s' as its own upstream."),
+					local);
+				return 0;
+			}
 
 	strbuf_addf(&key, "branch.%s.remote", local);
 	if (git_config_set_gently(key.buf, origin ? origin : ".") < 0)
@@ -75,8 +96,17 @@ int install_branch_config(int flag, const char *local, const char *origin, const
 
 	strbuf_reset(&key);
 	strbuf_addf(&key, "branch.%s.merge", local);
-	if (git_config_set_gently(key.buf, remote) < 0)
+	/*
+	 * We want to overwrite any existing config with all the branches in
+	 * "remotes". Override any existing config, then write our branches. If
+	 * more than one is provided, use CONFIG_REGEX_NONE to preserve what
+	 * we've written so far.
+	 */
+	if (git_config_set_gently(key.buf, NULL) < 0)
 		goto out_err;
+	for_each_string_list_item(item, remotes)
+		if (git_config_set_multivar_gently(key.buf, item->string, CONFIG_REGEX_NONE, 0) < 0)
+			goto out_err;
 
 	if (rebasing) {
 		strbuf_reset(&key);
@@ -87,29 +117,40 @@ int install_branch_config(int flag, const char *local, const char *origin, const
 	strbuf_release(&key);
 
 	if (flag & BRANCH_CONFIG_VERBOSE) {
-		if (shortname) {
-			if (origin)
-				printf_ln(rebasing ?
-					  _("Branch '%s' set up to track remote branch '%s' from '%s' by rebasing.") :
-					  _("Branch '%s' set up to track remote branch '%s' from '%s'."),
-					  local, shortname, origin);
-			else
-				printf_ln(rebasing ?
-					  _("Branch '%s' set up to track local branch '%s' by rebasing.") :
-					  _("Branch '%s' set up to track local branch '%s'."),
-					  local, shortname);
+		struct strbuf tmp_ref_name = STRBUF_INIT;
+		struct string_list friendly_ref_names = STRING_LIST_INIT_DUP;
+
+		for_each_string_list_item(item, remotes) {
+			shortname = item->string;
+			skip_prefix(shortname, "refs/heads/", &shortname);
+			if (origin) {
+				strbuf_addf(&tmp_ref_name, "%s/%s",
+					    origin, shortname);
+				string_list_append_nodup(
+					&friendly_ref_names,
+					strbuf_detach(&tmp_ref_name, NULL));
+			} else {
+				string_list_append(
+					&friendly_ref_names, shortname);
+			}
+		}
+
+		if (remotes->nr == 1) {
+			/*
+			 * Rebasing is only allowed in the case of a single
+			 * upstream branch.
+			 */
+			printf_ln(rebasing ?
+				_("branch '%s' set up to track '%s' by rebasing.") :
+				_("branch '%s' set up to track '%s'."),
+				local, friendly_ref_names.items[0].string);
 		} else {
-			if (origin)
-				printf_ln(rebasing ?
-					  _("Branch '%s' set up to track remote ref '%s' by rebasing.") :
-					  _("Branch '%s' set up to track remote ref '%s'."),
-					  local, remote);
-			else
-				printf_ln(rebasing ?
-					  _("Branch '%s' set up to track local ref '%s' by rebasing.") :
-					  _("Branch '%s' set up to track local ref '%s'."),
-					  local, remote);
+			printf_ln(_("branch '%s' set up to track:"), local);
+			for_each_string_list_item(item, &friendly_ref_names)
+				printf_ln("  %s", item->string);
 		}
+
+		string_list_clear(&friendly_ref_names, 0);
 	}
 
 	return 0;
@@ -118,14 +159,36 @@ int install_branch_config(int flag, const char *local, const char *origin, const
 	strbuf_release(&key);
 	error(_("Unable to write upstream branch configuration"));
 
-	advise(_(tracking_advice),
-	       origin ? origin : "",
-	       origin ? "/" : "",
-	       shortname ? shortname : remote);
+	advise(_("\nAfter fixing the error cause you may try to fix up\n"
+		"the remote tracking information by invoking:"));
+	if (remotes->nr == 1)
+		advise("  git branch --set-upstream-to=%s%s%s",
+			origin ? origin : "",
+			origin ? "/" : "",
+			remotes->items[0].string);
+	else {
+		advise("  git config --add branch.\"%s\".remote %s",
+			local, origin ? origin : ".");
+		for_each_string_list_item(item, remotes)
+			advise("  git config --add branch.\"%s\".merge %s",
+				local, item->string);
+	}
 
 	return -1;
 }
 
+int install_branch_config(int flag, const char *local, const char *origin,
+		const char *remote)
+{
+	int ret;
+	struct string_list remotes = STRING_LIST_INIT_DUP;
+
+	string_list_append(&remotes, remote);
+	ret = install_branch_config_multiple_remotes(flag, local, origin, &remotes);
+	string_list_clear(&remotes, 0);
+	return ret;
+}
+
 /*
  * This is called when new_ref is branched off of orig_ref, and tries
  * to infer the settings for branch.<new_ref>.{remote,merge} from the
diff --git a/t/t3200-branch.sh b/t/t3200-branch.sh
index cc4b10236e..4b0ef35913 100755
--- a/t/t3200-branch.sh
+++ b/t/t3200-branch.sh
@@ -950,15 +950,15 @@ test_expect_success 'disabled option --set-upstream fails' '
 	test_must_fail git branch --set-upstream origin/main
 '
 
-test_expect_success '--set-upstream-to notices an error to set branch as own upstream' '
+test_expect_success '--set-upstream-to notices an error to set branch as own upstream' "
 	git branch --set-upstream-to refs/heads/my13 my13 2>actual &&
 	cat >expect <<-\EOF &&
-	warning: Not setting branch my13 as its own upstream.
+	warning: not setting branch 'my13' as its own upstream.
 	EOF
 	test_expect_code 1 git config branch.my13.remote &&
 	test_expect_code 1 git config branch.my13.merge &&
 	test_cmp expect actual
-'
+"
 
 # Keep this test last, as it changes the current branch
 cat >expect <<EOF

-- 
2.34.1.307.g9b7440fafd-goog
Previous: Josh SteadmonNext: Junio C Hamano
Message 75 of 103 in “branch: add "inherit" option for branch.autoSetupMerge”
  1. branch: add "inherit" option for branch.autoSetupMergeJosh Steadmon, Sep 8, 2021
  2. Josh SteadmonSep 8, 2021
  3. branch: add "inherit" option for branch.autoSetupMergeJosh Steadmon, Sep 11, 2021
  4. Junio C HamanoSep 11, 2021
  5. Josh SteadmonOct 17, 2021
  6. Junio C HamanoOct 17, 2021
  7. Josh SteadmonNov 15, 2021
  8. branch: add flags and config to inherit trackingJosh Steadmon, Oct 17, 2021
  9. Ævar Arnfjörð BjarmasonOct 18, 2021
  10. Junio C HamanoOct 18, 2021
  11. Ævar Arnfjörð BjarmasonOct 18, 2021
  12. Josh SteadmonNov 15, 2021
  13. Glen ChooOct 18, 2021
  14. Glen ChooOct 18, 2021
  15. Josh SteadmonNov 15, 2021
  16. branch: add flags and config to inherit trackingJosh Steadmon, Nov 16, 2021
  17. Glen ChooNov 17, 2021
  18. Junio C HamanoNov 18, 2021
  19. Josh SteadmonNov 30, 2021
  20. Ævar Arnfjörð BjarmasonNov 19, 2021
  21. Josh SteadmonNov 30, 2021
  22. Ævar Arnfjörð BjarmasonDec 1, 2021
  23. 0/2 branch: inherit tracking configsJosh Steadmon, Dec 7, 2021
  24. 1/2 branch: accept multiple upstream branches for trackingJosh Steadmon, Dec 7, 2021
  25. Ævar Arnfjörð BjarmasonDec 7, 2021
  26. Josh SteadmonDec 9, 2021
  27. Ævar Arnfjörð BjarmasonDec 10, 2021
  28. Junio C HamanoDec 7, 2021
  29. Josh SteadmonDec 14, 2021
  30. Glen ChooDec 8, 2021
  31. Glen ChooDec 8, 2021
  32. Josh SteadmonDec 9, 2021
  33. Glen ChooDec 9, 2021
  34. Ævar Arnfjörð BjarmasonDec 10, 2021
  35. Glen ChooDec 10, 2021
  36. Ævar Arnfjörð BjarmasonDec 11, 2021
  37. Glen ChooDec 8, 2021
  38. Glen ChooDec 9, 2021
  39. Josh SteadmonDec 9, 2021
  40. Glen ChooDec 9, 2021
  41. 2/2 branch: add flags and config to inherit trackingJosh Steadmon, Dec 7, 2021
  42. Ævar Arnfjörð BjarmasonDec 7, 2021
  43. Glen ChooDec 8, 2021
  44. Josh SteadmonDec 14, 2021
  45. Josh SteadmonDec 14, 2021
  46. Junio C HamanoDec 7, 2021
  47. Josh SteadmonDec 14, 2021
  48. Glen ChooDec 8, 2021
  49. Josh SteadmonDec 14, 2021
  50. Junio C HamanoDec 7, 2021
  51. Glen ChooDec 8, 2021
  52. Johannes SchindelinDec 10, 2021
  53. Josh SteadmonDec 14, 2021
  54. 0/3 branch: inherit tracking configsJosh Steadmon, Dec 14, 2021
  55. 1/3 branch: accept multiple upstream branches for trackingJosh Steadmon, Dec 14, 2021
  56. Junio C HamanoDec 15, 2021
  57. Glen ChooDec 16, 2021
  58. Josh SteadmonDec 17, 2021
  59. Glen ChooDec 20, 2021
  60. Josh SteadmonDec 21, 2021
  61. 2/3 branch: add flags and config to inherit trackingJosh Steadmon, Dec 14, 2021
  62. Glen ChooDec 16, 2021
  63. Josh SteadmonDec 17, 2021
  64. 3/3 config: require lowercase for branch.autosetupmergeJosh Steadmon, Dec 14, 2021
  65. Josh SteadmonDec 15, 2021
  66. Junio C HamanoDec 16, 2021
  67. Glen ChooDec 16, 2021
  68. Junio C HamanoDec 16, 2021
  69. 0/3 branch: inherit tracking configsJosh Steadmon, Dec 17, 2021
  70. 1/3 branch: accept multiple upstream branches for trackingJosh Steadmon, Dec 17, 2021
  71. 2/3 branch: add flags and config to inherit trackingJosh Steadmon, Dec 17, 2021
  72. 3/3 config: require lowercase for branch.*.autosetupmergeJosh Steadmon, Dec 17, 2021
  73. Glen ChooDec 20, 2021
  74. 0/3 branch: inherit tracking configsJosh Steadmon, Dec 21, 2021
  75. 1/3 branch: accept multiple upstream branches for trackingJosh Steadmon, Dec 21, 2021
  76. Junio C HamanoDec 21, 2021
  77. Glen ChooDec 21, 2021
  78. 2/3 branch: add flags and config to inherit trackingJosh Steadmon, Dec 21, 2021
  79. Glen ChooDec 21, 2021
  80. incorrect 'git (checkout|branch) -h' output with new --track modes (was: [PATCH v8 2/3] branch: add flags and config to inherit tracking)Ævar Arnfjörð Bjarmason, Jan 11, 2022
  81. branch,checkout: fix --track usage stringsJosh Steadmon, Jan 18, 2022
  82. Junio C HamanoJan 18, 2022
  83. parse-options: document automatic PARSE_OPT_LITERAL_ARGHELPRené Scharfe, Jan 19, 2022
  84. Ævar Arnfjörð BjarmasonJan 19, 2022
  85. Junio C HamanoJan 19, 2022
  86. René ScharfeJan 20, 2022
  87. Junio C HamanoJan 20, 2022
  88. René ScharfeJan 21, 2022
  89. Junio C HamanoJan 21, 2022
  90. Ævar Arnfjörð BjarmasonJan 20, 2022
  91. Andreas SchwabJan 20, 2022
  92. Ævar Arnfjörð BjarmasonJan 20, 2022
  93. Junio C HamanoJan 20, 2022
  94. Ævar Arnfjörð BjarmasonJan 21, 2022
  95. Junio C HamanoJan 21, 2022
  96. René ScharfeJan 19, 2022
  97. Ævar Arnfjörð BjarmasonJan 20, 2022
  98. branch,checkout: fix --track documentationRené Scharfe, Jan 20, 2022
  99. Ævar Arnfjörð BjarmasonJan 20, 2022
  100. Junio C HamanoJan 20, 2022
  101. 3/3 config: require lowercase for branch.*.autosetupmergeJosh Steadmon, Dec 21, 2021
  102. Glen ChooDec 21, 2021
  103. René ScharfeJan 19, 2022

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.