From mboxrd@z Thu Jan 1 00:00:00 1970 From: "W. Trevor King" Subject: [PATCH v6 2/4] submodule update: add --remote for submodule's upstream changes Date: Sat, 01 Dec 2012 22:17:02 -0500 Message-ID: References: <20121130032719.GE29257@odin.tremily.us> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: QUOTED-PRINTABLE Cc: Junio C Hamano , Heiko Voigt , Jeff King , Phil Hord , Shawn Pearce , Jens Lehmann , Nahor , "W. Trevor King" To: Git X-From: git-owner@vger.kernel.org Sun Dec 02 04:18:40 2012 Return-path: Envelope-to: gcvg-git-2@plane.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Tf04k-00067R-S5 for gcvg-git-2@plane.gmane.org; Sun, 02 Dec 2012 04:18:39 +0100 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754015Ab2LBDST convert rfc822-to-quoted-printable (ORCPT ); Sat, 1 Dec 2012 22:18:19 -0500 Received: from vms173015pub.verizon.net ([206.46.173.15]:59054 "EHLO vms173015pub.verizon.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753996Ab2LBDSQ (ORCPT ); Sat, 1 Dec 2012 22:18:16 -0500 Received: from odin.tremily.us ([unknown] [72.68.87.250]) by vms173015.mailsrvcs.net (Sun Java(tm) System Messaging Server 7u2-7.02 32bit (built Apr 16 2009)) with ESMTPA id <0MED009LHVTZQH50@vms173015.mailsrvcs.net> for git@vger.kernel.org; Sat, 01 Dec 2012 21:18:00 -0600 (CST) Received: from localhost (tyr.tremily.us [192.168.0.5]) by odin.tremily.us (Postfix) with ESMTP id 482886E4038; Sat, 01 Dec 2012 22:17:59 -0500 (EST) X-Mailer: git-send-email 1.8.0.4.gf74b0fc.dirty In-reply-to: In-reply-to: References: Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: =46rom: "W. Trevor King" The current `update` command incorporates the superproject's gitlinked SHA-1 ($sha1) into the submodule HEAD ($subsha1). Depending on the options you use, it may checkout $sha1, rebase the $subsha1 onto $sha1, or merge $sha1 into $subsha1. This helps you keep up with changes in the upstream superproject. However, it's also useful to stay up to date with changes in the upstream subproject. Previous workflows for incorporating such changes include the ungainly: $ git submodule foreach 'git checkout $(git config --file $toplevel/.= gitmodules submodule.$name.branch) && git pull' With this patch, all of the useful functionality for incorporating superproject changes can be reused to incorporate upstream subproject updates. When you specify --remote, the target $sha1 is replaced with a $sha1 of the submodule's origin/master tracking branch. If you want to merge a different tracking branch, you can configure the `submodule..branch` option in `.gitmodules`. You can override the `.gitmodules` configuration setting for a particular superproject by configuring the option in that superproject's default configuration (using the usual configuration hierarchy, e.g. `.git/config`, `~/.gitconfig`, etc.). Previous use of submodule..branch =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Because we're adding a new configuration option, it's a good idea to check if anyone else is already using the option. The foreach-pull example above was described by =C3=86var in commit f030c96d8643fa0a1a9b2bd9c2f36a77721fb61f Author: =C3=86var Arnfj=C3=B6r=C3=B0 Bjarmason Date: Fri May 21 16:10:10 2010 +0000 git-submodule foreach: Add $toplevel variable Gerrit uses the same interpretation for the setting, but because Gerrit has direct access to the subproject repositories, it updates the superproject repositories automatically when a subproject changes. Gerrit also accepts the special value '.', which it expands into the superproject's branch name. Although the --remote functionality is using `submodule..branch` slightly differently, the effect is the same. The foreach-pull example uses the option to record the name of the local branch to checkout before pulls. The tracking branch to be pulled is recorded in `.git/modules//config`, which was initialized by the module clone during `submodule add` or `submodule init`. Because the branch name stored in `submodule..branch` was likely the same as the branch name used during the initial `submodule add`, the same branch will be pulled in each workflow. Implementation details =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D In order to ensure a current tracking branch state, `update --remote` fetches the submodule's remote repository before calculating the SHA-1. However, I didn't change the logic guarding the existing fetch: if test -z "$nofetch" then # Run fetch only if $sha1 isn't present or it # is not reachable from a ref. (clear_local_git_env; cd "$path" && ( (rev=3D$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) && test -z "$rev") || git-fetch)) || die "$(eval_gettext "Unable to fetch in submodule path '\$path'")" fi There will not be a double-fetch, because the new $sha1 determined after the `--remote` triggered fetch should always exist in the repository. If it doesn't, it's because some racy process removed it from the submodule's repository and we *should* be re-fetching. Signed-off-by: W. Trevor King --- Documentation/config.txt | 7 ++++++- Documentation/git-submodule.txt | 25 ++++++++++++++++++++++++- Documentation/gitmodules.txt | 5 +++++ git-submodule.sh | 22 +++++++++++++++++++++- t/t7406-submodule-update.sh | 31 +++++++++++++++++++++++++++++++ 5 files changed, 87 insertions(+), 3 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index 11f320b..6f4663c 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -1998,7 +1998,12 @@ submodule..update:: for a submodule. These variables are initially populated by 'git submodule init'; edit them to override the URL and other values found in the `.gitmodules` file. See - linkgit:git-submodule[1] and linkgit:gitmodules[5] for details. + +submodule..branch:: + The remote branch name for a submodule, used by `git submodule + update --remote`. Set this option to override the value found in + the `.gitmodules` file. See linkgit:git-submodule[1] and + linkgit:gitmodules[5] for details. =20 submodule..fetchRecurseSubmodules:: This option can be used to control recursive fetching of this diff --git a/Documentation/git-submodule.txt b/Documentation/git-submod= ule.txt index b4683bb..72dd52f 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -13,7 +13,7 @@ SYNOPSIS [--reference ] [--] [] 'git submodule' [--quiet] status [--cached] [--recursive] [--] [= =2E..] 'git submodule' [--quiet] init [--] [...] -'git submodule' [--quiet] update [--init] [-N|--no-fetch] [--rebase] +'git submodule' [--quiet] update [--init] [--remote] [-N|--no-fetch] [= --rebase] [--reference ] [--merge] [--recursive] [--] [= =2E..] 'git submodule' [--quiet] summary [--cached|--files] [(-n|--summary-li= mit) ] [commit] [--] [...] @@ -236,6 +236,29 @@ OPTIONS (the default). This limit only applies to modified submodules. The size is always limited to 1 for added/deleted/typechanged submodules. =20 +--remote:: + This option is only valid for the update command. Instead of using + 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..remote`), defaulting to `origin`. + The remote branch used defaults to `master`, but the branch name may + be overridden by setting the `submodule..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. +For example, `submodule update --remote --merge` will merge upstream +submodule changes into the submodules, while `submodule update +--merge` will merge superproject gitlink changes into the submodules. ++ +In order to ensure a current tracking branch state, `update --remote` +fetches the submodule's remote repository before calculating the +SHA-1. This makes `submodule update --remote --merge` similar to +running `git pull` in the submodule. If you don't want to fetch (for +something closer to `git merge`), you should use `submodule update +--remote --no-fetch --merge`. + -N:: --no-fetch:: This option is only valid for the update command. diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.tx= t index 4effd78..4004fa6 100644 --- a/Documentation/gitmodules.txt +++ b/Documentation/gitmodules.txt @@ -47,6 +47,11 @@ submodule..update:: This config option is overridden if 'git submodule update' is given the '--merge', '--rebase' or '--checkout' options. =20 +submodule..branch:: + A remote branch name for tracking updates in the upstream submodule. + If the option is not specified, it defaults to 'master'. See the + `--remote` documentation in linkgit:git-submodule[1] for details. + submodule..fetchRecurseSubmodules:: This option can be used to control recursive fetching of this submodule. If this option is also present in the submodules entry in diff --git a/git-submodule.sh b/git-submodule.sh index 97ce5e4..104b5de 100755 --- a/git-submodule.sh +++ b/git-submodule.sh @@ -8,7 +8,8 @@ dashless=3D$(basename "$0" | sed -e 's/-/ /') USAGE=3D"[--quiet] add [-b branch] [-f|--force] [--reference ] [--] [] or: $dashless [--quiet] status [--cached] [--recursive] [--] [...] or: $dashless [--quiet] init [--] [...] - or: $dashless [--quiet] update [--init] [-N|--no-fetch] [-f|--force= ] [--rebase] [--reference ] [--merge] [--recursive] [--] [<= path>...] + or: $dashless [--quiet] update [--init] [--remote] [-N|--no-fetch] = [-f|--force] [--rebase] [--reference ] [--merge] [--recursi= ve] [--] [...] +ges or: $dashless [--quiet] summary [--cached|--files] [--summary-limit= ] [commit] [--] [...] or: $dashless [--quiet] foreach [--recursive] or: $dashless [--quiet] sync [--] [...]" @@ -26,6 +27,7 @@ cached=3D recursive=3D init=3D files=3D +remote=3D nofetch=3D update=3D prefix=3D @@ -536,6 +538,9 @@ cmd_update() -i|--init) init=3D1 ;; + --remote) + remote=3D1 + ;; -N|--no-fetch) nofetch=3D1 ;; @@ -596,6 +601,7 @@ cmd_update() fi name=3D$(module_name "$sm_path") || exit url=3D$(git config submodule."$name".url) + branch=3D$(get_submodule_config "$name" branch master) if ! test -z "$update" then update_module=3D$update @@ -630,6 +636,20 @@ Maybe you want to use 'update --init'?")" die "$(eval_gettext "Unable to find current revision in submodule p= ath '\$sm_path'")" fi =20 + if test -n "$remote" + then + if test -z "$nofetch" + then + # Fetch remote before determining tracking $sha1 + (clear_local_git_env; cd "$sm_path" && git-fetch) || + die "$(eval_gettext "Unable to fetch in submodule path '\$sm_path'= ")" + fi + remote_name=3D$(get_default_remote) + sha1=3D$(clear_local_git_env; cd "$sm_path" && + git rev-parse --verify "${remote_name}/${branch}") || + die "$(eval_gettext "Unable to find current ${remote_name}/${branch= } revision in submodule path '\$sm_path'")" + fi + if test "$subsha1" !=3D "$sha1" -o -n "$force" then subforce=3D$force diff --git a/t/t7406-submodule-update.sh b/t/t7406-submodule-update.sh index 1542653..a567834 100755 --- a/t/t7406-submodule-update.sh +++ b/t/t7406-submodule-update.sh @@ -135,6 +135,37 @@ test_expect_success 'submodule update --force forc= ibly checks out submodules' ' ) ' =20 +test_expect_success 'submodule update --remote should fetch upstream c= hanges' ' + (cd submodule && + echo line4 >> file && + git add file && + test_tick && + git commit -m "upstream line4" + ) && + (cd super && + git submodule update --remote --force submodule && + cd submodule && + test "$(git log -1 --oneline)" =3D "$(GIT_DIR=3D../../submodule/.git= git log -1 --oneline)" + ) +' + +test_expect_success 'local config should override .gitmodules branch' = ' + (cd submodule && + git checkout -b test-branch && + echo line5 >> file && + git add file && + test_tick && + git commit -m "upstream line5" && + git checkout master + ) && + (cd super && + git config submodule.submodule.branch test-branch && + git submodule update --remote --force submodule && + cd submodule && + test "$(git log -1 --oneline)" =3D "$(GIT_DIR=3D../../submodule/.git= git log -1 --oneline test-branch)" + ) +' + test_expect_success 'submodule update --rebase staying on master' ' (cd super/submodule && git checkout master --=20 1.8.0.4.gf74b0fc.dirty