From: "Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: don@goodman-wilson.com, stolee@gmail.com, peff@peff.net,
sandals@crustytoothpaste.net, "Matt Rogers" <mattr94@gmail.com>,
"Eric Sunshine" <sunshine@sunshineco.com>,
"Taylor Blau" <me@ttaylorr.com>,
"Phillip Wood" <phillip.wood123@gmail.com>,
"Alban Gruin" <alban.gruin@gmail.com>,
"Johannes Sixt" <j6t@kdbg.org>,
"Denton Liu" <liu.denton@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Philippe Blain" <levraiphilippeblain@gmail.com>,
"Johannes Schindelin" <johannes.schindelin@gmx.de>,
"Johannes Schindelin" <johannes.schindelin@gmx.de>
Subject: [PATCH v4 3/9] submodule: fall back to remote's HEAD for missing remote.<name>.branch
Date: Wed, 24 Jun 2020 14:46:30 +0000 [thread overview]
Message-ID: <54563642dbf96fcb36993c2c2d36ebefaf220cce.1593009996.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.656.v4.git.1593009996.gitgitgadget@gmail.com>
From: Johannes Schindelin <johannes.schindelin@gmx.de>
When `remote.<name>.branch` is not configured, `git submodule update`
currently falls back to using the branch name `master`. A much better
idea, however, is to use the remote `HEAD`: on all Git servers running
reasonably recent Git versions, the symref `HEAD` points to the main
branch.
Note: t7419 demonstrates that there _might_ be use cases out there that
_expect_ `git submodule update --remote` to update submodules to the
remote `master` branch even if the remote `HEAD` points to another
branch. Arguably, this patch makes the behavior more intuitive, but
there is a slight possibility that this might cause regressions in
obscure setups.
Even so, it should be okay to fix this behavior without anything like a
longer transition period:
- The `git submodule update --remote` command is not really common.
- Current Git's behavior when running this command is outright
confusing, unless the remote repository's current branch _is_ `master`
(in which case the proposed behavior matches the old behavior).
- If a user encounters a regression due to the changed behavior, the fix
is actually trivial: setting `submodule.<name>.branch` to `master`
will reinstate the old behavior.
Helped-by: Philippe Blain <levraiphilippeblain@gmail.com>
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
Documentation/git-submodule.txt | 12 ++++++------
Documentation/gitmodules.txt | 6 +++---
builtin/submodule--helper.c | 2 +-
t/t7406-submodule-update.sh | 16 ++++++++++++++++
t/t7419-submodule-set-branch.sh | 7 +++++--
5 files changed, 31 insertions(+), 12 deletions(-)
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index c9ed2bf3d5..7e5f995f77 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -183,7 +183,7 @@ set-branch (-d|--default) [--] <path>::
Sets the default remote tracking branch for the submodule. The
`--branch` option allows the remote branch to be specified. The
`--default` option removes the submodule.<name>.branch configuration
- key, which causes the tracking branch to default to 'master'.
+ key, which causes the tracking branch to default to the remote 'HEAD'.
set-url [--] <path> <newurl>::
Sets the URL of the specified submodule to <newurl>. Then, it will
@@ -284,7 +284,7 @@ OPTIONS
`.gitmodules` for `update --remote`. A special value of `.` is used to
indicate that the name of the branch in the submodule should be the
same name as the current branch in the current repository. If the
- option is not specified, it defaults to 'master'.
+ option is not specified, it defaults to the remote 'HEAD'.
-f::
--force::
@@ -322,10 +322,10 @@ OPTIONS
the superproject's recorded SHA-1 to update the submodule, use the
status of the submodule's remote-tracking branch. The remote used
is branch's remote (`branch.<name>.remote`), defaulting to `origin`.
- The remote branch used defaults to `master`, but the branch name may
- be overridden by setting the `submodule.<name>.branch` option in
- either `.gitmodules` or `.git/config` (with `.git/config` taking
- precedence).
+ The remote branch used defaults to the remote `HEAD`, but the branch
+ name may be overridden by setting the `submodule.<name>.branch`
+ option in either `.gitmodules` or `.git/config` (with `.git/config`
+ taking precedence).
+
This works for any of the supported update procedures (`--checkout`,
`--rebase`, etc.). The only change is the source of the target SHA-1.
diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt
index 67275fd187..539b4e1997 100644
--- a/Documentation/gitmodules.txt
+++ b/Documentation/gitmodules.txt
@@ -49,9 +49,9 @@ submodule.<name>.update::
submodule.<name>.branch::
A remote branch name for tracking updates in the upstream submodule.
- If the option is not specified, it defaults to 'master'. A special
- value of `.` is used to indicate that the name of the branch in the
- submodule should be the same name as the current branch in the
+ If the option is not specified, it defaults to the remote 'HEAD'.
+ A special value of `.` is used to indicate that the name of the branch
+ in the submodule should be the same name as the current branch in the
current repository. See the `--remote` documentation in
linkgit:git-submodule[1] for details.
diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c
index 46c03d2a12..f55f7b7704 100644
--- a/builtin/submodule--helper.c
+++ b/builtin/submodule--helper.c
@@ -1981,7 +1981,7 @@ static const char *remote_submodule_branch(const char *path)
free(key);
if (!branch)
- return "master";
+ return "HEAD";
if (!strcmp(branch, ".")) {
const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
diff --git a/t/t7406-submodule-update.sh b/t/t7406-submodule-update.sh
index 4fb447a143..aa19ff3a2e 100755
--- a/t/t7406-submodule-update.sh
+++ b/t/t7406-submodule-update.sh
@@ -70,6 +70,22 @@ test_expect_success 'setup a submodule tree' '
)
'
+test_expect_success 'update --remote falls back to using HEAD' '
+ test_create_repo main-branch-submodule &&
+ test_commit -C main-branch-submodule initial &&
+
+ test_create_repo main-branch &&
+ git -C main-branch submodule add ../main-branch-submodule &&
+ git -C main-branch commit -m add-submodule &&
+
+ git -C main-branch-submodule switch -c hello &&
+ test_commit -C main-branch-submodule world &&
+
+ git clone --recursive main-branch main-branch-clone &&
+ git -C main-branch-clone submodule update --remote main-branch-submodule &&
+ test_path_exists main-branch-clone/main-branch-submodule/world.t
+'
+
test_expect_success 'submodule update detaching the HEAD ' '
(cd super/submodule &&
git reset --hard HEAD~1
diff --git a/t/t7419-submodule-set-branch.sh b/t/t7419-submodule-set-branch.sh
index fd25f786a3..3b925c302f 100755
--- a/t/t7419-submodule-set-branch.sh
+++ b/t/t7419-submodule-set-branch.sh
@@ -52,12 +52,13 @@ test_expect_success 'test submodule set-branch --branch' '
'
test_expect_success 'test submodule set-branch --default' '
+ test_commit -C submodule c &&
(cd super &&
git submodule set-branch --default submodule &&
! grep branch .gitmodules &&
git submodule update --remote &&
cat <<-\EOF >expect &&
- a
+ c
EOF
git -C submodule show -s --pretty=%s >actual &&
test_cmp expect actual
@@ -65,6 +66,7 @@ test_expect_success 'test submodule set-branch --default' '
'
test_expect_success 'test submodule set-branch -b' '
+ test_commit -C submodule b &&
(cd super &&
git submodule set-branch -b topic submodule &&
grep "branch = topic" .gitmodules &&
@@ -78,12 +80,13 @@ test_expect_success 'test submodule set-branch -b' '
'
test_expect_success 'test submodule set-branch -d' '
+ test_commit -C submodule d &&
(cd super &&
git submodule set-branch -d submodule &&
! grep branch .gitmodules &&
git submodule update --remote &&
cat <<-\EOF >expect &&
- a
+ d
EOF
git -C submodule show -s --pretty=%s >actual &&
test_cmp expect actual
--
gitgitgadget
next prev parent reply other threads:[~2020-06-24 14:47 UTC|newest]
Thread overview: 180+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-10 21:19 [PATCH 0/9] Allow overriding the default name of the default branch Johannes Schindelin via GitGitGadget
2020-06-10 21:19 ` [PATCH 1/9] init: allow overriding the default branch name for new repositories Don Goodman-Wilson via GitGitGadget
2020-06-10 23:22 ` brian m. carlson
2020-06-11 0:16 ` Eric Sunshine
2020-06-11 14:09 ` Johannes Schindelin
2020-06-11 15:28 ` Junio C Hamano
2020-06-16 12:45 ` Jeff King
2020-06-16 12:47 ` Jeff King
2020-06-18 13:08 ` Johannes Schindelin
2020-06-23 20:32 ` Johannes Schindelin
2020-06-11 9:35 ` Phillip Wood
2020-06-12 11:55 ` Johannes Schindelin
2020-06-12 16:51 ` Junio C Hamano
2020-06-14 22:00 ` Johannes Schindelin
2020-06-15 10:00 ` Phillip Wood
2020-06-11 10:23 ` Alban Gruin
2020-06-11 23:14 ` Junio C Hamano
2020-06-11 23:46 ` brian m. carlson
2020-06-12 12:45 ` Johannes Schindelin
2020-06-13 18:01 ` Alban Gruin
2020-06-14 8:57 ` Johannes Schindelin
2020-06-16 12:25 ` Jeff King
2020-06-18 10:17 ` Johannes Schindelin
2020-06-10 21:19 ` [PATCH 2/9] remote: respect `core.defaultBranchName` Johannes Schindelin via GitGitGadget
2020-06-16 12:35 ` Jeff King
2020-06-18 10:21 ` Johannes Schindelin
2020-06-18 11:50 ` Jeff King
2020-06-23 21:15 ` Johannes Schindelin
2020-06-10 21:19 ` [PATCH 3/9] send-pack/transport-helper: " Johannes Schindelin via GitGitGadget
2020-06-10 21:19 ` [PATCH 4/9] testsvn: " Johannes Schindelin via GitGitGadget
2020-06-10 21:19 ` [PATCH 5/9] submodule: use the (possibly overridden) default branch name Johannes Schindelin via GitGitGadget
2020-06-15 10:46 ` Denton Liu
2020-06-10 21:19 ` [PATCH 6/9] clone: learn about the possibly-configured " Johannes Schindelin via GitGitGadget
2020-06-10 22:58 ` Junio C Hamano
2020-06-10 21:19 ` [PATCH 7/9] fmt-merge-msg: " Johannes Schindelin via GitGitGadget
2020-06-10 22:59 ` Junio C Hamano
2020-06-10 21:19 ` [PATCH 8/9] fast-export: respect the possibly-overridden " Johannes Schindelin via GitGitGadget
2020-06-10 21:54 ` Matt Rogers
2020-06-10 23:25 ` Junio C Hamano
2020-06-10 23:39 ` brian m. carlson
2020-06-11 0:20 ` Matt Rogers
2020-06-11 5:26 ` Junio C Hamano
2020-06-11 14:05 ` Johannes Schindelin
2020-06-11 15:05 ` Re* " Junio C Hamano
2020-06-11 16:44 ` Junio C Hamano
2020-06-11 18:18 ` Junio C Hamano
2020-06-12 12:07 ` Johannes Schindelin
2020-06-12 12:32 ` Junio C Hamano
2020-06-12 12:03 ` Johannes Schindelin
2020-06-12 12:50 ` Junio C Hamano
2020-06-12 12:53 ` Johannes Schindelin
2020-06-12 13:18 ` Johannes Schindelin
2020-06-12 15:19 ` Junio C Hamano
2020-06-12 15:22 ` Junio C Hamano
2020-06-13 5:00 ` Johannes Schindelin
2020-06-12 15:14 ` Junio C Hamano
2020-06-13 11:49 ` Johannes Sixt
2020-06-13 16:25 ` Junio C Hamano
2020-06-13 14:47 ` Johannes Schindelin
2020-06-13 18:49 ` Junio C Hamano
2020-06-14 8:55 ` Johannes Schindelin
2020-06-17 20:06 ` Junio C Hamano
2020-06-23 21:11 ` Johannes Schindelin
2020-06-23 21:32 ` Junio C Hamano
2020-06-13 14:44 ` Johannes Schindelin
2020-06-11 13:57 ` Johannes Schindelin
2020-06-11 18:19 ` Junio C Hamano
2020-06-12 12:07 ` Johannes Schindelin
2020-06-10 21:19 ` [PATCH 9/9] Document how the default branch name can be overridden Johannes Schindelin via GitGitGadget
2020-06-11 0:18 ` Junio C Hamano
2020-06-10 23:11 ` [PATCH 0/9] Allow overriding the default name of the default branch Junio C Hamano
2020-06-11 5:42 ` Junio C Hamano
2020-06-11 13:44 ` Johannes Schindelin
2020-06-11 14:44 ` Junio C Hamano
2020-06-10 23:41 ` brian m. carlson
2020-06-11 1:07 ` Taylor Blau
2020-06-11 14:33 ` Johannes Schindelin
2020-06-15 10:03 ` Pratyush Yadav
2020-06-14 22:26 ` Johannes Schindelin
2020-06-16 0:19 ` Denton Liu
2020-06-23 20:10 ` Johannes Schindelin
2020-06-15 23:10 ` brian m. carlson
2020-06-15 12:50 ` [PATCH v2 00/12] " Johannes Schindelin via GitGitGadget
2020-06-15 12:50 ` [PATCH v2 01/12] fast-export: do anonymize the primary branch name Junio C Hamano via GitGitGadget
2020-06-16 12:58 ` Jeff King
2020-06-17 18:16 ` Junio C Hamano
2020-06-17 21:23 ` Jeff King
2020-06-18 2:06 ` Elijah Newren
2020-06-18 6:30 ` Junio C Hamano
2020-06-18 7:13 ` Elijah Newren
2020-06-18 11:45 ` Jeff King
2020-06-15 12:50 ` [PATCH v2 02/12] fmt-merge-msg: introduce a way to override the main " Johannes Schindelin via GitGitGadget
2020-06-15 15:00 ` Phillip Wood
2020-06-23 12:31 ` Johannes Schindelin
2020-06-15 17:05 ` Junio C Hamano
2020-06-23 19:19 ` Johannes Schindelin
2020-06-16 8:46 ` Ævar Arnfjörð Bjarmason
2020-06-17 18:21 ` Junio C Hamano
2020-06-16 13:04 ` Jeff King
2020-06-17 18:23 ` Junio C Hamano
2020-06-18 13:15 ` Johannes Schindelin
2020-06-17 20:56 ` Johannes Sixt
2020-06-17 21:16 ` Junio C Hamano
2020-06-23 21:12 ` Johannes Schindelin
2020-06-15 12:50 ` [PATCH v2 03/12] send-pack/transport-helper: respect `core.mainBranch` Johannes Schindelin via GitGitGadget
2020-06-15 12:50 ` [PATCH v2 04/12] git_main_branch_name(): optionally report the full ref name Johannes Schindelin via GitGitGadget
2020-06-15 15:04 ` Phillip Wood
2020-06-23 19:17 ` Johannes Schindelin
2020-06-15 12:50 ` [PATCH v2 05/12] fast-export: handle overridden main branch names correctly Johannes Schindelin via GitGitGadget
2020-06-15 15:05 ` Phillip Wood
2020-06-16 13:10 ` Jeff King
2020-06-16 15:49 ` Phillip Wood
2020-06-18 10:08 ` Johannes Schindelin
2020-06-15 17:09 ` Junio C Hamano
2020-06-23 19:22 ` Johannes Schindelin
2020-06-15 12:50 ` [PATCH v2 06/12] branch -m: adjust `core.mainBranch` if necessary Johannes Schindelin via GitGitGadget
2020-06-15 12:50 ` [PATCH v2 07/12] init: allow specifying the main branch name for the new repository Johannes Schindelin via GitGitGadget
2020-06-15 12:50 ` [PATCH v2 08/12] init: allow overriding the default main branch name via the config Don Goodman-Wilson via GitGitGadget
2020-06-15 12:50 ` [PATCH v2 09/12] clone: handle overridden main branch names Johannes Schindelin via GitGitGadget
2020-06-16 13:22 ` Jeff King
2020-06-23 20:58 ` Johannes Schindelin
2020-06-15 12:50 ` [PATCH v2 10/12] remote: learn about the possibly-overridden default main branch name Johannes Schindelin via GitGitGadget
2020-06-15 12:50 ` [PATCH v2 11/12] submodule: use the correct default for the " Johannes Schindelin via GitGitGadget
2020-06-16 13:46 ` Jeff King
2020-06-23 21:03 ` Johannes Schindelin
2020-06-23 21:14 ` Jeff King
2020-06-15 12:50 ` [PATCH v2 12/12] testsvn: respect `init.defaultBranch` Johannes Schindelin via GitGitGadget
2020-06-16 13:51 ` Jeff King
2020-06-23 21:07 ` Johannes Schindelin
2020-06-23 22:33 ` [PATCH v3 0/8] Allow overriding the default name of the default branch Johannes Schindelin via GitGitGadget
2020-06-23 22:33 ` [PATCH v3 1/8] fmt-merge-msg: stop treating `master` specially Johannes Schindelin via GitGitGadget
2020-06-24 16:16 ` Junio C Hamano
2020-06-25 13:07 ` Johannes Schindelin
2020-06-23 22:33 ` [PATCH v3 2/8] send-pack/transport-helper: avoid mentioning a particular branch Johannes Schindelin via GitGitGadget
2020-06-24 0:36 ` Junio C Hamano
2020-06-24 12:44 ` Johannes Schindelin
2020-06-24 15:44 ` Junio C Hamano
2020-06-25 13:05 ` Johannes Schindelin
2020-06-23 22:33 ` [PATCH v3 3/8] submodule: use a better fall-back for missing remote.<name>.branch Johannes Schindelin via GitGitGadget
2020-06-24 2:18 ` Philippe Blain
2020-06-24 12:51 ` Johannes Schindelin
2020-06-23 22:33 ` [PATCH v3 4/8] init: allow specifying the initial branch name for the new repository Johannes Schindelin via GitGitGadget
2020-06-24 0:58 ` Junio C Hamano
2020-06-24 12:55 ` Johannes Schindelin
2020-06-23 22:33 ` [PATCH v3 5/8] init: allow setting the default for the initial branch name via the config Don Goodman-Wilson via GitGitGadget
2020-06-24 1:05 ` Junio C Hamano
2020-06-24 12:56 ` Johannes Schindelin
2020-06-24 16:25 ` Junio C Hamano
2020-06-23 22:33 ` [PATCH v3 6/8] clone: use configured default branch name when appropriate Johannes Schindelin via GitGitGadget
2020-06-23 22:33 ` [PATCH v3 7/8] remote: use the " Johannes Schindelin via GitGitGadget
2020-06-24 1:10 ` Junio C Hamano
2020-06-24 13:00 ` Johannes Schindelin
2020-06-23 22:33 ` [PATCH v3 8/8] testsvn: respect `init.defaultBranch` Johannes Schindelin via GitGitGadget
2020-06-24 14:46 ` [PATCH v4 0/9] Allow overriding the default name of the default branch Johannes Schindelin via GitGitGadget
2020-06-24 14:46 ` [PATCH v4 1/9] fmt-merge-msg: stop treating `master` specially Johannes Schindelin via GitGitGadget
2020-06-29 16:20 ` Đoàn Trần Công Danh
2020-06-29 13:27 ` Johannes Schindelin
2020-06-30 15:05 ` Đoàn Trần Công Danh
2020-07-01 10:39 ` Johannes Schindelin
2020-07-01 19:54 ` Junio C Hamano
2020-06-24 14:46 ` [PATCH v4 2/9] send-pack/transport-helper: avoid mentioning a particular branch Johannes Schindelin via GitGitGadget
2020-06-24 14:46 ` Johannes Schindelin via GitGitGadget [this message]
2020-06-24 16:17 ` [PATCH v4 3/9] submodule: fall back to remote's HEAD for missing remote.<name>.branch Junio C Hamano
2020-06-24 14:46 ` [PATCH v4 4/9] docs: add missing diamond brackets Johannes Schindelin via GitGitGadget
2020-06-24 14:46 ` [PATCH v4 5/9] init: allow specifying the initial branch name for the new repository Johannes Schindelin via GitGitGadget
2020-06-24 14:46 ` [PATCH v4 6/9] init: allow setting the default for the initial branch name via the config Don Goodman-Wilson via GitGitGadget
2020-06-24 14:46 ` [PATCH v4 7/9] clone: use configured default branch name when appropriate Johannes Schindelin via GitGitGadget
2020-06-24 14:46 ` [PATCH v4 8/9] remote: use the " Johannes Schindelin via GitGitGadget
2020-06-24 14:46 ` [PATCH v4 9/9] testsvn: respect `init.defaultBranch` Johannes Schindelin via GitGitGadget
2020-06-24 16:26 ` [PATCH v4 0/9] Allow overriding the default name of the default branch Junio C Hamano
2020-06-25 13:03 ` Johannes Schindelin
2020-06-29 22:41 ` brian m. carlson
2020-07-12 13:03 ` Edward Thomson
2020-07-12 8:19 ` Johannes Schindelin
[not found] ` <CA+WKDT1GMNTY5N862-7ui70D6-b1u6fuUkvctEYo+57aJGbjmw@mail.gmail.com>
2020-07-14 14:55 ` Johannes Schindelin
2020-06-16 9:47 ` [PATCH " Ævar Arnfjörð Bjarmason
2020-06-16 14:09 ` Jeff King
2020-06-16 14:24 ` Jeff King
2020-06-23 20:28 ` Johannes Schindelin
2020-06-17 20:28 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=54563642dbf96fcb36993c2c2d36ebefaf220cce.1593009996.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=alban.gruin@gmail.com \
--cc=avarab@gmail.com \
--cc=don@goodman-wilson.com \
--cc=git@vger.kernel.org \
--cc=j6t@kdbg.org \
--cc=johannes.schindelin@gmx.de \
--cc=levraiphilippeblain@gmail.com \
--cc=liu.denton@gmail.com \
--cc=mattr94@gmail.com \
--cc=me@ttaylorr.com \
--cc=peff@peff.net \
--cc=phillip.wood123@gmail.com \
--cc=sandals@crustytoothpaste.net \
--cc=stolee@gmail.com \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).