mbox series

[v6,0/3] branch: inherit tracking configs

Message ID cover.1639524556.git.steadmon@google.com (mailing list archive)
Headers show
Series branch: inherit tracking configs | expand

Message

Josh Steadmon Dec. 14, 2021, 11:44 p.m. UTC
Changes since V5:
* Greatly simplified BRANCH_CONFIG_VERBOSE output to not require nearly
  so many conditionals.
* Note that rebasing is not compatible with inheriting multiple upstream
  branches.
* Moved the change to case-sensitivity for branch.autosetupmerge to its
  own commit.
* Improve advice on failed tracking setup when multiple branches are
  involved.
* Make better use of string_list API.
* Make better use of config API.
* More straight-forward use of the `struct tracking` API.
* Numerous style fixes.

Changes since V4:
* Add new patch (1/2) to refactor branch.c:install_branch_config() to
  accept multiple upstream refs
* When multiple upstream branches are set in the parent branch, inherit
  them all, instead of just the first
* Break out error string arguments for easier translation
* Don't ignore case for values of branch.autosetupmerge
* Move reference to git-pull out of usage string for --track into
  git-branch.txt
* Use test_config instead of `git config` in t2027
* Style fixes: add single-quotes around warning string arguments, remove
  unnecessary braces

Changes since V3:
* Use branch_get() instead of git_config_get_string() to look up branch
  configuration.
* Remove unnecessary string formatting in new error message in
  parse-options-cb.c.

Josh Steadmon (3):
  branch: accept multiple upstream branches for tracking
  branch: add flags and config to inherit tracking
  config: require lowercase for branch.*.autosetupmerge

 Documentation/config/branch.txt |   3 +-
 Documentation/git-branch.txt    |  24 +++--
 Documentation/git-checkout.txt  |   2 +-
 Documentation/git-switch.txt    |   2 +-
 branch.c                        | 184 ++++++++++++++++++++++++--------
 branch.h                        |   3 +-
 builtin/branch.c                |   6 +-
 builtin/checkout.c              |   6 +-
 config.c                        |   5 +-
 parse-options-cb.c              |  16 +++
 parse-options.h                 |   2 +
 t/t2017-checkout-orphan.sh      |  11 +-
 t/t2027-checkout-track.sh       |  23 ++++
 t/t2060-switch.sh               |  28 +++++
 t/t3200-branch.sh               |  39 ++++++-
 t/t7201-co.sh                   |  17 +++
 16 files changed, 305 insertions(+), 66 deletions(-)

Range-diff against v5:
1:  ba7d557725 < -:  ---------- branch: accept multiple upstream branches for tracking
-:  ---------- > 1:  43d6f83fed branch: accept multiple upstream branches for tracking
2:  c7e4af9a36 ! 2:  57e57e6e6a branch: add flags and config to inherit tracking
    @@ branch.c: static int find_tracked_branch(struct remote *remote, void *priv)
      		}
      		tracking->spec.src = NULL;
      	}
    -@@ branch.c: int install_branch_config(int flag, const char *local, const char *origin, const
    - 	string_list_clear(&remotes, 0);
    +@@ branch.c: int install_branch_config(int flag, const char *local, const char *origin,
    + 	return ret;
      }
      
     +static int inherit_tracking(struct tracking *tracking, const char *orig_ref)
    @@ branch.c: int install_branch_config(int flag, const char *local, const char *ori
     +	tracking->remote = xstrdup(branch->remote_name);
     +	for (i = 0; i < branch->merge_nr; i++)
     +		string_list_append(tracking->srcs, branch->merge_name[i]);
    -+	tracking->matches = 1;
     +	return 0;
     +}
     +
    @@ branch.c: static void setup_tracking(const char *new_ref, const char *orig_ref,
      		return;
      
      	if (!tracking.matches)
    +@@ branch.c: static void setup_tracking(const char *new_ref, const char *orig_ref,
    + 		case BRANCH_TRACK_ALWAYS:
    + 		case BRANCH_TRACK_EXPLICIT:
    + 		case BRANCH_TRACK_OVERRIDE:
    ++		case BRANCH_TRACK_INHERIT:
    + 			break;
    + 		default:
    + 			return;
     @@ branch.c: static void setup_tracking(const char *new_ref, const char *orig_ref,
      		die(_("Not tracking: ambiguous information for ref %s"),
      		    orig_ref);
      
     -	if (install_branch_config(config_flags, new_ref, tracking.remote,
     -			      tracking.src ? tracking.src : orig_ref) < 0)
    -+	if (tracking.srcs->nr < 1)
    ++	if (tracking.srcs->nr < 1 && track != BRANCH_TRACK_INHERIT)
     +		string_list_append(tracking.srcs, orig_ref);
     +	if (install_branch_config_multiple_remotes(config_flags, new_ref, tracking.remote,
     +			      tracking.srcs) < 0)
    @@ branch.h: enum branch_track {
      	BRANCH_TRACK_EXPLICIT,
     -	BRANCH_TRACK_OVERRIDE
     +	BRANCH_TRACK_OVERRIDE,
    -+	BRANCH_TRACK_INHERIT
    ++	BRANCH_TRACK_INHERIT,
      };
      
      extern enum branch_track git_branch_track;
    @@ builtin/checkout.c: static struct option *add_common_switch_branch_options(
      		OPT_STRING(0, "orphan", &opts->new_orphan_branch, N_("new-branch"), N_("new unparented branch")),
     
      ## config.c ##
    -@@ config.c: static int git_default_i18n_config(const char *var, const char *value)
    - static int git_default_branch_config(const char *var, const char *value)
    - {
    - 	if (!strcmp(var, "branch.autosetupmerge")) {
    --		if (value && !strcasecmp(value, "always")) {
    -+		if (value && !strcmp(value, "always")) {
    +@@ config.c: static int git_default_branch_config(const char *var, const char *value)
    + 		if (value && !strcasecmp(value, "always")) {
      			git_branch_track = BRANCH_TRACK_ALWAYS;
      			return 0;
     +		} else if (value && !strcmp(value, "inherit")) {
    @@ parse-options-cb.c: int parse_opt_passthru_argv(const struct option *opt, const
      	return 0;
      }
     +
    -+int parse_opt_tracking_mode(const struct option *opt, const char *arg, int unset) {
    ++int parse_opt_tracking_mode(const struct option *opt, const char *arg, int unset)
    ++{
     +	if (unset)
     +		*(enum branch_track *)opt->value = BRANCH_TRACK_NEVER;
     +	else if (!arg || !strcmp(arg, "direct"))
    @@ parse-options.h: enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx
     
      ## t/t2017-checkout-orphan.sh ##
     @@ t/t2017-checkout-orphan.sh: test_expect_success '--orphan ignores branch.autosetupmerge' '
    + 	git checkout main &&
    + 	git config branch.autosetupmerge always &&
      	git checkout --orphan gamma &&
    - 	test -z "$(git config branch.gamma.merge)" &&
    +-	test -z "$(git config branch.gamma.merge)" &&
    ++	test_cmp_config "" --default "" branch.gamma.merge &&
      	test refs/heads/gamma = "$(git symbolic-ref HEAD)" &&
     +	test_must_fail git rev-parse --verify HEAD^ &&
     +	git checkout main &&
     +	git config branch.autosetupmerge inherit &&
     +	git checkout --orphan eta &&
    -+	test -z "$(git config branch.eta.merge)" &&
    -+	test -z "$(git config branch.eta.remote)" &&
    -+	test refs/heads/eta = "$(git symbolic-ref HEAD)" &&
    ++	test_cmp_config "" --default "" branch.eta.merge &&
    ++	test_cmp_config "" --default "" branch.eta.remote &&
    ++	echo refs/heads/eta >expected &&
    ++	git symbolic-ref HEAD >actual &&
    ++	test_cmp expected actual &&
      	test_must_fail git rev-parse --verify HEAD^
      '
      
    @@ t/t2060-switch.sh: test_expect_success 'not switching when something is in progr
     +test_expect_success 'tracking info copied with autoSetupMerge=inherit' '
     +	# default config does not copy tracking info
     +	git switch -c foo-no-inherit foo &&
    -+	test -z "$(git config branch.foo-no-inherit.remote)" &&
    -+	test -z "$(git config branch.foo-no-inherit.merge)" &&
    ++	test_cmp_config "" --default "" branch.foo-no-inherit.remote &&
    ++	test_cmp_config "" --default "" branch.foo-no-inherit.merge &&
     +	# with --track=inherit, we copy tracking info from foo
     +	git switch --track=inherit -c foo2 foo &&
     +	test_cmp_config origin branch.foo2.remote &&
    @@ t/t2060-switch.sh: test_expect_success 'not switching when something is in progr
     +	test_cmp_config refs/heads/foo branch.foo5.merge &&
     +	# no tracking info to inherit from main
     +	git switch -c main2 main &&
    -+	test -z "$(git config branch.main2.remote)" &&
    -+	test -z "$(git config branch.main2.merge)"
    ++	test_cmp_config "" --default "" branch.main2.remote &&
    ++	test_cmp_config "" --default "" branch.main2.merge
     +'
     +
      test_done
    @@ t/t3200-branch.sh: test_expect_success 'invalid sort parameter in configuration'
     +	test_unconfig branch.autoSetupMerge &&
     +	# default config does not copy tracking info
     +	git branch foo-no-inherit my1 &&
    -+	test -z "$(git config branch.foo-no-inherit.remote)" &&
    -+	test -z "$(git config branch.foo-no-inherit.merge)" &&
    ++	test_cmp_config "" --default "" branch.foo-no-inherit.remote &&
    ++	test_cmp_config "" --default "" branch.foo-no-inherit.merge &&
     +	# with autoSetupMerge=inherit, we copy tracking info from my1
     +	test_config branch.autoSetupMerge inherit &&
     +	git branch foo3 my1 &&
    @@ t/t3200-branch.sh: test_expect_success 'invalid sort parameter in configuration'
     +	test_cmp_config refs/heads/main branch.foo3.merge &&
     +	# no tracking info to inherit from main
     +	git branch main2 main &&
    -+	test -z "$(git config branch.main2.remote)" &&
    -+	test -z "$(git config branch.main2.merge)"
    ++	test_cmp_config "" --default "" branch.main2.remote &&
    ++	test_cmp_config "" --default "" branch.main2.merge
     +'
     +
     +test_expect_success '--track overrides branch.autoSetupMerge' '
    @@ t/t3200-branch.sh: test_expect_success 'invalid sort parameter in configuration'
     +	test_cmp_config . branch.foo4.remote &&
     +	test_cmp_config refs/heads/my1 branch.foo4.merge &&
     +	git branch --no-track foo5 my1 &&
    -+	test -z "$(git config branch.foo5.remote)" &&
    -+	test -z "$(git config branch.foo5.merge)"
    ++	test_cmp_config "" --default "" branch.foo5.remote &&
    ++	test_cmp_config "" --default "" branch.foo5.merge
     +'
     +
      test_done
    @@ t/t7201-co.sh: test_expect_success 'custom merge driver with checkout -m' '
     +	git reset --hard main &&
     +	# default config does not copy tracking info
     +	git checkout -b foo-no-inherit koala/bear &&
    -+	test -z "$(git config branch.foo-no-inherit.remote)" &&
    -+	test -z "$(git config branch.foo-no-inherit.merge)" &&
    ++	test_cmp_config "" --default "" branch.foo-no-inherit.remote &&
    ++	test_cmp_config "" --default "" branch.foo-no-inherit.merge &&
     +	# with autoSetupMerge=inherit, we copy tracking info from koala/bear
     +	test_config branch.autoSetupMerge inherit &&
     +	git checkout -b foo koala/bear &&
    @@ t/t7201-co.sh: test_expect_success 'custom merge driver with checkout -m' '
     +	test_cmp_config refs/heads/koala/bear branch.foo.merge &&
     +	# no tracking info to inherit from main
     +	git checkout -b main2 main &&
    -+	test -z "$(git config branch.main2.remote)" &&
    -+	test -z "$(git config branch.main2.merge)"
    ++	test_cmp_config "" --default "" branch.main2.remote &&
    ++	test_cmp_config "" --default "" branch.main2.merge
     +'
     +
      test_done
-:  ---------- > 3:  f79d27dc24 config: require lowercase for branch.*.autosetupmerge

base-commit: 6c40894d2466d4e7fddc047a05116aa9d14712ee

Comments

Josh Steadmon Dec. 15, 2021, 12:43 a.m. UTC | #1
On 2021.12.14 15:44, Josh Steadmon wrote:
> Changes since V5:
> * Greatly simplified BRANCH_CONFIG_VERBOSE output to not require nearly
>   so many conditionals.

I meant to expand on this but forgot before sending the series. I
removed as many distinctions as possible, as most can still be inferred
from context. For example, previously the output specifically called out
branches vs. tags, but this is obvious in the name itself: "some-branch"
vs. "refs/tags/some-tag" for example. Likewise, we don't need to specify
whether refs are remote or local: "some-remote/some-branch" vs.
"a-local-branch" should be understandable without us spelling it out.

Of course, if people feel like I've over-simplified here, I'm happy to
revert this change.
Junio C Hamano Dec. 16, 2021, 12:02 a.m. UTC | #2
Josh Steadmon <steadmon@google.com> writes:

> Changes since V5:
> * Greatly simplified BRANCH_CONFIG_VERBOSE output to not require nearly
>   so many conditionals.
> * Note that rebasing is not compatible with inheriting multiple upstream
>   branches.
> * Moved the change to case-sensitivity for branch.autosetupmerge to its
>   own commit.
> * Improve advice on failed tracking setup when multiple branches are
>   involved.
> * Make better use of string_list API.
> * Make better use of config API.
> * More straight-forward use of the `struct tracking` API.
> * Numerous style fixes.

I've queued this, and rebased Glen's "branch --recurse-submodules"
on top, and parked both of them near the tip of 'seen'.  I do not
have much confidence in the conflict resolution needed during the
rebasing or the other branch or merges into 'seen', and I would
appreciate it if you two can take a look to sanity check the result.

Thanks.
Glen Choo Dec. 16, 2021, 12:37 a.m. UTC | #3
Junio C Hamano <gitster@pobox.com> writes:

> Josh Steadmon <steadmon@google.com> writes:
>
>> Changes since V5:
>> * Greatly simplified BRANCH_CONFIG_VERBOSE output to not require nearly
>>   so many conditionals.
>> * Note that rebasing is not compatible with inheriting multiple upstream
>>   branches.
>> * Moved the change to case-sensitivity for branch.autosetupmerge to its
>>   own commit.
>> * Improve advice on failed tracking setup when multiple branches are
>>   involved.
>> * Make better use of string_list API.
>> * Make better use of config API.
>> * More straight-forward use of the `struct tracking` API.
>> * Numerous style fixes.
>
> I've queued this, and rebased Glen's "branch --recurse-submodules"
> on top, and parked both of them near the tip of 'seen'.  I do not
> have much confidence in the conflict resolution needed during the
> rebasing or the other branch or merges into 'seen', and I would
> appreciate it if you two can take a look to sanity check the result.
>
> Thanks.

I've just sent out a new version [1] which is rebased on top of Josh's
v6. Please use that version instead :)

I did not rebase this on top of 'seen' though; I'll take a look and see
if there's anything of concern.

[1] https://lore.kernel.org/git/20211216003213.99135-1-chooglen@google.com/,
Junio C Hamano Dec. 16, 2021, 1:20 a.m. UTC | #4
Glen Choo <chooglen@google.com> writes:

> I did not rebase this on top of 'seen' though; I'll take a look and see
> if there's anything of concern.

That's OK; please do not ever rebase anything on top of 'seen' or
'next'.  In this particular case, you and Josh agreed to base your
topic on top of Josh'es, if I understand it correctly, so find the
tip of js/branch-track-inherit from 'seen' [*] and rebase your topic
there.

But making a trial merge of the combined topic to say 'next' and
testing the result out before sending the patches to the list would
be very much appreciated ;-)


[Footnote]

* One way to do so would be:

 $ git fetch
 $ git show 'remote/origin/seen^{/^Merge branch .js/branch-track-inherit.}'