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

Re: [PATCH 6/6] clone, submodule update: check out branches

From
Glen Choo <chooglen@google.com>
Date
Aug 30, 2022, 22:54 UTC
Message-ID
<kl6l8rn5cpg3.fsf@chooglen-macbookpro.roam.corp.google.com>
In-Reply-To
<4e63e180-d275-83c2-d498-47bb0cfd160d@gmail.com>
Philippe Blain <levraiphilippeblain@gmail.com> writes:
Show 16 quoted lines
> Hi Glen,
>
> Le 2022-08-29 à 16:54, Glen Choo via GitGitGadget a écrit :
>> From: Glen Choo <chooglen@google.com>
>> 
>> Teach "git submodule update" to update submodules by creating and
>> checking out the current superproject branch when
>> "submodule.propagateBranches=true". "git clone --recurse-submodules"
>> also learns this trick because it is implemented with "git submodule
>> update --recursive".
>
> OK. Maybe a more descriptive title would then be:
>
> clone, submodule update: create and check out submodule branches
>
> ?

Ah, thanks. Your other wording suggestions upthread are also very helpful.

Show 6 quoted lines
>
> Another thing, 'git pull --recurse-submodules' is also implemented using
> 'git submodule update --recursive'. But I don't think we want 'git pull'
> to start creating new branches in submodules, even with submodule.propagateBranches=true
> (though I haven't thought about it very hard). So maybe adding a word about
> that would be nice.

Good point. I thought that `git pull --recurse-submodules` used the `--merge` strategy (in which case, it wouldn't matter), but looks like it uses the `--checkout` strategy.

I'm quite certain we want to replace this `git pull --recurse-submodules` implementation, aka non recursive `git merge` + `git submodule update`, with a recursive `git merge` (and possibly updating the worktrees with `git checkout --recurse-submodules`). Since this flag is still experimental and incomplete, I think we have the freedom to say that we won't care about this for now, but either way I'll mention this somewhere.

Show 15 quoted lines
>> "git submodule update" tries to create the branch as long as it is not
>> currently checked out, thus it will fail if the submodule has the
>> branch, but it is not checked out. This is fine because the main purpose
>> of "git submodule update" is to clone new submodules (which have no
>> branches, and will never have this problem). "git checkout" with
>> "submodule.propagateBranches" will cover the use case of recursively
>> checking out an existing branch.
>
> I guess you mean "in a future series" for the last sentence ? FWIW I still have
> your RFC from last Febryary about that [1] in my "unread Git mailing list" folder,
> I always seem to lack the time to sit down and read it through, sorry!
> Incidentally, I notice you did not link to it in the cover letter, 
> any reasoon why?
>
> [1] https://lore.kernel.org/git/20220209065236.36494-1-chooglen@google.com/

Ah, yes, I meant "in a future series". I didn't think that the RFC would be very useful to reviewers since the non-RFC version is likely change a lot (I've done a lot of tinkering between then and now), and it didn't gain much traction in the first place anyway.

Show 25 quoted lines
>
> Stepping back a bit, you write "thus it will fail if the submodule has the
> branch, but it is not checked out." If I read your patch correctly, this is
> implicit in that 'git checkout -b super-branch' that is ran by 'run_update_command'
> will error out if the branch already exists, right ? 
>
> Is there anything more we should do in that case ? 
> Should we remind the user, something like
> "you have submodule.propagateBranches set, but the branch 'super-branch' already
> exists in submodule 'that-sub'" ? 
>
> I'm trying to think of a scenario in which this could happen...
>
> Say a user:
> 1. clones a superproject with --recurse-submodules, but without 'submodule.propagateBranches'
> 2. runs 'git checkout -b topic' in the superproject
> 3. runs 'git branch topic' in the submodule
> 4. runs 'git submodule update' with 'submodule.propagateBranches' in the superproject
>
> This fails:
>
> fatal: a branch named 'topic' already exists
> fatal: Unable to checkout 'deadbeef' in submodule path 'sub'
>
> Do we need a more specific message ? I'm not sure.

Hm, you're right, this does seem quite opaque to end users; this means nothing if they don't know that `git submodule update` uses `git checkout -b` under the hood, which they obviously shouldn't need to know.

The main simplifying assumption behind `submodule.propagateBranches` (or at least, this early version of it) is that users won't interact with branches on the submodules directly outside of very specific scenarios, e.g. setting submodule-specific tracking info. So maybe the more comprehensive solution would be to block users from creating branches if the submodule's superproject uses `submodule.propagateBranches`.

Show 32 quoted lines
>> 
>> Signed-off-by: Glen Choo <chooglen@google.com>
>> ---
>>  builtin/submodule--helper.c | 28 ++++++++++++++++++++++++++--
>>  t/t5617-clone-submodules.sh | 34 ++++++++++++++++++++++++++++++++++
>>  t/t7406-submodule-update.sh | 22 ++++++++++++++++++++++
>>  3 files changed, 82 insertions(+), 2 deletions(-)
>> 
>> diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c
>> index cbf6bda4850..7eb2c45900e 100644
>> --- a/builtin/submodule--helper.c
>> +++ b/builtin/submodule--helper.c
>> @@ -1695,6 +1695,9 @@ static int clone_submodule(struct module_clone_data *clone_data)
>>  			strvec_push(&cp.args, clone_data->single_branch ?
>>  				    "--single-branch" :
>>  				    "--no-single-branch");
>> +		if (the_repository->settings.submodule_propagate_branches)
>> +			strvec_push(&cp.args, "--detach");
>> +
>>  
>>  		strvec_push(&cp.args, "--");
>>  		strvec_push(&cp.args, clone_data->url);
>> @@ -1733,6 +1736,9 @@ static int clone_submodule(struct module_clone_data *clone_data)
>>  	if (error_strategy)
>>  		git_config_set_in_file(p, "submodule.alternateErrorStrategy",
>>  				       error_strategy);
>> +	if (the_repository->settings.submodule_propagate_branches)
>> +		git_config_set_in_file(p, "submodule.propagateBranches",
>> +				       "true");
>
> Why do we need to set that in the config of the submodule ? I'm guessing this 
> is so that the new code also works for nested submodules, right ?

As long as the value is set in the superproject, the new code still works. This is meant as a way of setting the user's preferred value in the submodule. Although.. `git clone` doesn't automatically set this value in the superproject - it would have to be read off system/global/cli config, so maybe it's more coherent to acknowledge that the user's preferred value probably isn't in the repo anyway, and maybe I should just drop this.

Show 8 quoted lines
>
> I'm thinking about a user that would alternate between 'submodule.propagateBranches=true' and 'false'.
> Maybe they sometimes have to work on the superproject and the submodule(s), sometimes 
> only in the superproject. If they want to deactivate submodule.propagateBranches, would they have to
> remember to also deactivate it in all submodules, in case of nested submodules ?...  if so,
> this is a little unfortunate. But I _think_ they wouldn't have to, because as long as 
> it's false in the superproject config, then we won't get into the new code at all when running
> in the top level superproject...

Hm, would a user want to alternate in the first place? Maybe? e.g. with `git checkout topic`, "true" would check out the submodule worktree at the branch (including any WIP you have) but "false" would give you the worktree specified by the superproject. Both are useful.

The way it's written now, "submodule.propagateBranches" is only passed to submodule processes if it is "true", so it can be overrided by submodule config if superproject says "false" but submodule says "true". I should fix that..

Show 63 quoted lines
>>  	free(sm_alternate);
>>  	free(error_strategy);
>> @@ -1792,6 +1798,7 @@ static int module_clone(int argc, const char **argv, const char *prefix)
>>  	memset(&filter_options, 0, sizeof(filter_options));
>>  	argc = parse_options(argc, argv, prefix, module_clone_options,
>>  			     git_submodule_helper_usage, 0);
>> +	prepare_repo_settings(the_repository);
>>  
>>  	clone_data.dissociate = !!dissociate;
>>  	clone_data.quiet = !!quiet;
>> @@ -1872,6 +1879,7 @@ struct submodule_update_clone {
>>  struct update_data {
>>  	const char *prefix;
>>  	const char *displaypath;
>> +	const char *super_branch;
>>  	enum submodule_update_type update_default;
>>  	struct object_id suboid;
>>  	struct string_list references;
>> @@ -2206,6 +2214,8 @@ static int run_update_command(struct update_data *ud, int subforce)
>>  		strvec_pushl(&cp.args, "checkout", "-q", NULL);
>>  		if (subforce)
>>  			strvec_push(&cp.args, "-f");
>> +		if (ud->super_branch)
>> +			strvec_pushl(&cp.args, "-b", ud->super_branch, NULL);
>>  		break;
>>  	case SM_UPDATE_REBASE:
>>  		cp.git_cmd = 1;
>> @@ -2456,6 +2466,7 @@ static void update_data_to_args(struct update_data *update_data, struct strvec *
>>  static int update_submodule(struct update_data *update_data)
>>  {
>>  	int submodule_up_to_date;
>> +	const char *submodule_head = NULL;
>>  
>>  	ensure_core_worktree(update_data->sm_path);
>>  
>> @@ -2469,7 +2480,7 @@ static int update_submodule(struct update_data *update_data)
>>  	if (update_data->just_cloned)
>>  		oidcpy(&update_data->suboid, null_oid());
>>  	else if (resolve_gitlink_ref(update_data->sm_path, "HEAD",
>> -				     &update_data->suboid, NULL))
>> +				     &update_data->suboid, &submodule_head))
>>  		die(_("Unable to find current revision in submodule path '%s'"),
>>  			update_data->displaypath);
>>  
>> @@ -2493,7 +2504,13 @@ static int update_submodule(struct update_data *update_data)
>>  		free(remote_ref);
>>  	}
>>  
>> -	submodule_up_to_date = oideq(&update_data->oid, &update_data->suboid);
>> +	if (update_data->super_branch &&
>> +	    submodule_head &&
>> +	    !skip_prefix(submodule_head, "refs/heads/", &submodule_head))
>> +		submodule_up_to_date = !strcmp(update_data->super_branch, submodule_head);
>
> I'm not sure I understand this logic. We want to change the 'submodule_up_to_date' boolean,
> so that we compare branch names instead of oid's, and we do that only if:
>
> 1. we are running with 'propagateBranches=true' (so update_data->super_branch will be set to the superproject's branch)
> 2. a ref is checked out in the submodule (so submodule_head will hold its name)
> 3. it's not a branch (so skip_prefix will return 0, and !skip_prefix will be 1). 
>    In that case it must be simply "HEAD", i.e. the submodule's HEAD is detached.
>
> Why do we need (2. + 3.) ?

Oops I got skip_prefix() backwards, 3. should read "if a branch is checked out". I'll add a test case for this (I could've sworn I had one at some point).

Show 6 quoted lines
>
> If branch 'foo' is currently checked out in the superproject, and
> branch 'bar' is currently checked out in the submodule, and someone
> runs 'git -c propagateBranches=true submodule update', wouldn't they expect
> that 'bar' be checked out in the submodule ? Maybe not, but the commit message
> and the tests should be more explicit about the expected behaviour in this case, I think.

Yeah, I'll call it out. I think this case is better addressed by having `git checkout topic --recurse-submodules` automatically create "topic" in the submodules that don't have it. This is one of the reasons why the `git checkout` RFC isn't so relevant any more ;).

Show 19 quoted lines
>> +	else
>> +		submodule_up_to_date = oideq(&update_data->oid, &update_data->suboid);
>> +
>>  	if (!submodule_up_to_date || update_data->force)
>>  		if (run_update_procedure(update_data))
>>  			return 1;
>> @@ -2551,6 +2568,12 @@ static int update_submodules(struct update_data *update_data)
>>  		goto cleanup;
>>  	}
>>  
>> +	if (the_repository->settings.submodule_propagate_branches) {
>> +		struct branch *current_branch = branch_get(NULL);
>> +		if (current_branch)
>> +			update_data->super_branch = current_branch->name;
>
> OK, so this condition means that super_branch won't get set if we are not
> currently on a branch, i.e. we are in detached HEAD. This makes sense as there
> would be no branch to propagate. Do we need a test for this ? maybe a case where
> we clone with '--recurse-submodules --branch some-tag' ?
Good point, I'll add a test for this.
Show 104 quoted lines
>> +	}
>> +
>>  	for (i = 0; i < suc.update_clone_nr; i++) {
>>  		struct update_clone_data ucd = suc.update_clone[i];
>>  
>> @@ -2634,6 +2657,7 @@ static int module_update(int argc, const char **argv, const char *prefix)
>>  	memset(&filter_options, 0, sizeof(filter_options));
>>  	argc = parse_options(argc, argv, prefix, module_update_options,
>>  			     git_submodule_helper_usage, 0);
>> +	prepare_repo_settings(the_repository);
>>  
>>  	if (opt.require_init)
>>  		opt.init = 1;
>> diff --git a/t/t5617-clone-submodules.sh b/t/t5617-clone-submodules.sh
>> index b5c66cb18cb..215fb02e9fb 100755
>> --- a/t/t5617-clone-submodules.sh
>> +++ b/t/t5617-clone-submodules.sh
>> @@ -12,10 +12,17 @@ pwd=$(pwd)
>>  test_expect_success 'setup' '
>>  	git checkout -b main &&
>>  	test_commit commit1 &&
>> +	mkdir subsub &&
>> +	(
>> +		cd subsub &&
>> +		git init &&
>> +		test_commit subsubcommit1
>> +	) &&
>>  	mkdir sub &&
>>  	(
>>  		cd sub &&
>>  		git init &&
>> +		git submodule add "file://$pwd/subsub" subsub &&
>>  		test_commit subcommit1 &&
>>  		git tag sub_when_added_to_super &&
>>  		git branch other
>> @@ -106,4 +113,31 @@ test_expect_success '--no-also-filter-submodules overrides clone.filterSubmodule
>>  	test_cmp_config -C super_clone3/sub false --default false remote.origin.promisor
>>  '
>>  
>> +test_expect_success 'submodule.propagateBranches checks out branches at correct commits' '
>> +	git -C sub checkout -b not-main &&
>> +	git -C subsub checkout -b not-main &&
>> +	git clone --recurse-submodules \
>> +		-c submodule.propagateBranches=true \
>> +		"file://$pwd/." super_clone4 &&
>> +
>> +	# Assert that each repo is pointing to "main"
>> +	for REPO in "super_clone4" "super_clone4/sub" "super_clone4/sub/subsub"
>> +	do
>> +	    HEAD_BRANCH=$(git -C $REPO symbolic-ref HEAD) &&
>> +	    test $HEAD_BRANCH = "refs/heads/main" || return 1
>> +	done &&
>> +
>> +	# Assert that the submodule branches are pointing to the right revs
>> +	EXPECT_SUB_OID="$(git -C super_clone4 rev-parse :sub)" &&
>> +	ACTUAL_SUB_OID="$(git -C super_clone4/sub rev-parse refs/heads/main)" &&
>> +	test $EXPECT_SUB_OID = $ACTUAL_SUB_OID &&
>> +	EXPECT_SUBSUB_OID="$(git -C super_clone4/sub rev-parse :subsub)" &&
>> +	ACTUAL_SUBSUB_OID="$(git -C super_clone4/sub/subsub rev-parse refs/heads/main)" &&
>> +	test $EXPECT_SUBSUB_OID = $ACTUAL_SUBSUB_OID &&
>> +
>> +	# Assert that the submodules do not have branches from their upstream
>> +	test_must_fail git -C super_clone4/sub rev-parse not-main &&
>> +	test_must_fail git -C super_clone4/sub/subsub rev-parse not-main
>> +'
>> +
>>  test_done
>> diff --git a/t/t7406-submodule-update.sh b/t/t7406-submodule-update.sh
>> index 6cc07460dd2..00a6fec8912 100755
>> --- a/t/t7406-submodule-update.sh
>> +++ b/t/t7406-submodule-update.sh
>> @@ -1178,4 +1178,26 @@ test_expect_success 'submodule update --recursive skip submodules with strategy=
>>  	test_cmp expect.err actual.err
>>  '
>>  
>> +test_expect_success 'submodule update with submodule.propagateBranches checks out branches' '
>> +	test_when_finished "rm -fr top-cloned" &&
>> +	cp -r top-clean top-cloned &&
>> +
>> +	# Create a new upstream submodule
>> +	git init middle2 &&
>> +	test_commit -C middle2 "middle2" &&
>> +	git -C top submodule add ../middle2 middle2 &&
>> +	git -C top commit -m "add middle2" &&
>> +
>> +	git -C top-cloned checkout -b "new-branch" &&
>> +	git -C top-cloned pull origin main &&
>> +	test_config -C top-cloned submodule.propagateBranches true &&
>> +	git -C top-cloned submodule update --recursive &&
>> +
>> +	for REPO in "top-cloned/middle2" "top-cloned/middle" "top-cloned/middle/bottom"
>> +	do
>> +	    HEAD_BRANCH=$(git -C $REPO symbolic-ref HEAD) &&
>> +	    test $HEAD_BRANCH = "refs/heads/new-branch" || return 1
>> +	done
>> +'
>> +
>>  test_done
>> 
>
> These tests look good, but maybe more tests would be needed in 
> the light of my comments above... 
>
> Thanks again for working on improving submodules!
Thanks for lending your time and attention :)
>
> Cheers,
>
> Philippe.
Previous: Philippe BlainNext: Jonathan Tan
Message 13 of 56 in “clone, submodule update: check out submodule branches”
  1. 0/6 clone, submodule update: check out submodule branchesGlen Choo via GitGitGadget, Aug 29, 2022
  2. 1/6 clone: teach --detach optionGlen Choo via GitGitGadget, Aug 29, 2022
  3. Philippe BlainAug 30, 2022
  4. 2/6 repo-settings: add submodule_propagate_branchesGlen Choo via GitGitGadget, Aug 29, 2022
  5. Philippe BlainAug 30, 2022
  6. 3/6 t5617: drop references to remote-tracking branchesGlen Choo via GitGitGadget, Aug 29, 2022
  7. Philippe BlainAug 30, 2022
  8. 4/6 submodule: return target of submodule symrefGlen Choo via GitGitGadget, Aug 29, 2022
  9. Jonathan TanSep 1, 2022
  10. Glen ChooSep 1, 2022
  11. 6/6 clone, submodule update: check out branchesGlen Choo via GitGitGadget, Aug 29, 2022
  12. Philippe BlainAug 30, 2022
  13. Glen ChooAug 30, 2022
  14. Jonathan TanSep 1, 2022
  15. 5/6 submodule--helper: refactor up-to-date criterionGlen Choo via GitGitGadget, Aug 29, 2022
  16. 0/7 clone, submodule update: check out submodule branchesGlen Choo via GitGitGadget, Oct 20, 2022
  17. 1/7 clone: teach --detach optionGlen Choo via GitGitGadget, Oct 20, 2022
  18. 2/7 repo-settings: add submodule_propagate_branchesGlen Choo via GitGitGadget, Oct 20, 2022
  19. Jonathan TanOct 25, 2022
  20. 3/7 submodule--helper clone: create named branchGlen Choo via GitGitGadget, Oct 20, 2022
  21. Jonathan TanOct 25, 2022
  22. 4/7 t5617: drop references to remote-tracking branchesGlen Choo via GitGitGadget, Oct 20, 2022
  23. 5/7 submodule: return target of submodule symrefGlen Choo via GitGitGadget, Oct 20, 2022
  24. 6/7 submodule update: refactor update targetsGlen Choo via GitGitGadget, Oct 20, 2022
  25. 7/7 clone, submodule update: create and check out branchesGlen Choo via GitGitGadget, Oct 20, 2022
  26. Jonathan TanOct 25, 2022
  27. Glen ChooOct 25, 2022
  28. Junio C HamanoOct 20, 2022
  29. Glen ChooOct 20, 2022
  30. Junio C HamanoOct 21, 2022
  31. 0/8 clone, submodule update: check out submodule branchesGlen Choo via GitGitGadget, Oct 28, 2022
  32. 1/8 clone: teach --detach optionGlen Choo via GitGitGadget, Oct 28, 2022
  33. Junio C HamanoOct 28, 2022
  34. Junio C HamanoOct 28, 2022
  35. Glen ChooOct 28, 2022
  36. Taylor BlauOct 30, 2022
  37. Glen ChooOct 31, 2022
  38. Philippe BlainNov 8, 2022
  39. 2/8 repo-settings: add submodule_propagate_branchesGlen Choo via GitGitGadget, Oct 28, 2022
  40. 3/8 submodule--helper clone: create named branchGlen Choo via GitGitGadget, Oct 28, 2022
  41. 5/8 submodule: return target of submodule symrefGlen Choo via GitGitGadget, Oct 28, 2022
  42. Junio C HamanoOct 28, 2022
  43. Glen ChooOct 28, 2022
  44. 4/8 t5617: drop references to remote-tracking branchesGlen Choo via GitGitGadget, Oct 28, 2022
  45. 8/8 clone, submodule update: create and check out branchesGlen Choo via GitGitGadget, Oct 28, 2022
  46. Philippe BlainNov 8, 2022
  47. Jonathan TanNov 15, 2022
  48. Glen ChooNov 22, 2022
  49. Jonathan TanNov 23, 2022
  50. Junio C HamanoNov 23, 2022
  51. 6/8 submodule update: refactor update targetsGlen Choo via GitGitGadget, Oct 28, 2022
  52. 7/8 submodule--helper: remove update_data.suboidGlen Choo via GitGitGadget, Oct 28, 2022
  53. Jonathan TanNov 14, 2022
  54. Taylor BlauOct 30, 2022
  55. Philippe BlainNov 8, 2022
  56. Glen ChooNov 8, 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.