git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Eric Sunshine <sunshine@sunshineco.com>
To: Thomas Gummerer <t.gummerer@gmail.com>
Cc: "Git List" <git@vger.kernel.org>,
	"Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>,
	"Junio C Hamano" <gitster@pobox.com>
Subject: Re: [PATCH v3 3/3] worktree: make add <path> dwim
Date: Sun, 19 Nov 2017 14:04:13 -0500	[thread overview]
Message-ID: <CAPig+cQqbvuZg0Y8ZMObZc7mYXzohooVBFj0-o+CGGXrgGLp5w@mail.gmail.com> (raw)
In-Reply-To: <20171118224706.13810-4-t.gummerer@gmail.com>

On Sat, Nov 18, 2017 at 5:47 PM, Thomas Gummerer <t.gummerer@gmail.com> wrote:
> Currently 'git worktree add <path>' creates a new branch named after the
> basename of the <path>, that matches the HEAD of whichever worktree we
> were on when calling "git worktree add <path>".
>
> Make 'git worktree add <path> behave more like the dwim machinery in
> 'git checkout <new-branch>', i.e. check if the new branch name uniquely
> matches the branch name of a remote tracking branch, and if so check out
> that branch and set the upstream to the remote tracking branch.
>
> This is a change of behaviour compared to the current behaviour, where
> we create a new branch matching HEAD.  However as 'git worktree' is
> still an experimental feature, and it's easy to notice/correct the
> behaviour in case it's not what the user desired it's probably okay to
> break existing behaviour here.
>
> In order to also satisfy users who want the current behaviour of
> creating a new branch from HEAD, add a '--no-track' flag, which disables
> the new behaviour, and keeps the old behaviour of creating a new branch
> from the head of the current worktree.
>
> Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com>
> ---
> diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
> @@ -60,9 +60,18 @@ $ git worktree add -b <branch> <path> <remote>/<branch>
>  ------------
>  If `<branch>` is omitted and neither `-b` nor `-B` nor `--detach` used,
> -then, as a convenience, a new branch based at HEAD is created automatically,
> -as if `-b $(basename <path>)` was specified.
> -
> +then, as a convenience, if there exists a tracking branch in exactly
> +one remote (call it <remote>) matching the basename of the path
> +(call it <branch>), treat it as equivalent to

Inconsistent typesetting. In the context, typesetting is `<foo>`,
whereas in the new content, you've used <foo> for these two.

> +------------
> +$ git worktree add -b <branch> <path> <remote>/<branch>
> +------------
> +If no tracking branch exists in exactly one remote, <branch> is

Typesetting: `<foo>`

> +created based on HEAD, as if `-b $(basename <path>)` was specified.
> ++
> +To disable the behaviour of trying to match the basename of <path> to
> +a remote, and always create a new branch from HEAD, the `--no-track`

Does --[no-]track deserve to be documented in the OPTIONS section like
the other options are?

> +flag can be passed to `git worktree add`.
>  list::

You lost a blank line before "list::".

>  List details of each worktree.  The main worktree is listed first, followed by
> diff --git a/builtin/worktree.c b/builtin/worktree.c
> @@ -351,6 +352,7 @@ static int add(int ac, const char **av, const char *prefix)
> +               OPT_BOOL(0, "track", &track_dwim, N_("checkout upstream branch if there's a unique match")),

git-checkout and git-branch help describe this as "setting upstream"
and "setting up tracking", respectively. Using "checkout" in this help
message could be confusing, especially since git-worktree has a
--no-checkout option; this seems to imply that --track would override
it.

>                 OPT_END()
>         };
>
> diff --git a/t/t2025-worktree-add.sh b/t/t2025-worktree-add.sh
> @@ -360,4 +360,64 @@ test_expect_success '"add" <path> <branch> dwims' '
> +test_expect_success 'git worktree add --no-track does not set up tracking' '
> +       test_when_finished rm -rf repo_a &&
> +       test_when_finished rm -rf repo_b &&
> +       test_when_finished rm -rf foo &&
> +       git init repo_a &&
> +       (
> +               cd repo_a &&
> +               test_commit a_master &&
> +               git checkout -b foo &&
> +               test_commit a_foo
> +       ) &&
> +       git init repo_b &&
> +       (
> +               cd repo_b &&
> +               test_commit b_master &&
> +               git remote add repo_a ../repo_a &&
> +               git config remote.repo_a.fetch \
> +                       "+refs/heads/*:refs/remotes/other_a/*" &&
> +               git fetch --all &&
> +               git worktree add --no-track ../foo
> +       ) &&
> +       (
> +               cd foo &&
> +               ! test_branch_upstream foo repo_a foo &&
> +               git rev-parse other_a/foo >expect &&
> +               git rev-parse foo >actual &&
> +               ! test_cmp expect actual
> +       )
> +'

Most of the boilerplate in the three new tests (added in this and the
previous patch) is identical (and very verbose). Perhaps the bulk of
it can be factored out into a function?

> +
> +test_expect_success 'git worktree add sets up tracking' '
> +       test_when_finished rm -rf repo_a &&
> +       test_when_finished rm -rf repo_b &&
> +       test_when_finished rm -rf foo &&
> +       git init repo_a &&
> +       (
> +               cd repo_a &&
> +               test_commit a_master &&
> +               git checkout -b foo &&
> +               test_commit a_foo
> +       ) &&
> +       git init repo_b &&
> +       (
> +               cd repo_b &&
> +               test_commit b_master &&
> +               git remote add repo_a ../repo_a &&
> +               git config remote.repo_a.fetch \
> +                       "+refs/heads/*:refs/remotes/other_a/*" &&
> +               git fetch --all &&
> +               git worktree add ../foo
> +       ) &&
> +       (
> +               cd foo &&
> +               test_branch_upstream foo repo_a foo &&
> +               git rev-parse other_a/foo >expect &&
> +               git rev-parse foo >actual &&
> +               test_cmp expect actual
> +       )
> +'
> +
>  test_done

  reply	other threads:[~2017-11-19 19:04 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-12 13:43 [PATCH v1 1/2] checkout: factor out functions to new lib file Thomas Gummerer
2017-11-12 13:43 ` [PATCH v1 2/2] worktree: make add dwim Thomas Gummerer
2017-11-13  3:04   ` Junio C Hamano
2017-11-14  8:45     ` Thomas Gummerer
2017-11-14 20:14       ` Eric Sunshine
2017-11-14 20:29         ` Eric Sunshine
2017-11-15  8:52           ` Thomas Gummerer
2017-11-18 18:13             ` Thomas Gummerer
2017-11-15  8:50         ` Thomas Gummerer
2017-11-15  9:12           ` Eric Sunshine
2017-11-13  2:41 ` [PATCH v1 1/2] checkout: factor out functions to new lib file Junio C Hamano
2017-11-14  8:46   ` Thomas Gummerer
2017-11-18 18:11 ` [PATCH v2 1/3] " Thomas Gummerer
2017-11-18 18:11   ` [PATCH v2 2/3] worktree: make add <path> <branch> dwim Thomas Gummerer
2017-11-18 22:18     ` Thomas Gummerer
2017-11-18 18:11   ` [PATCH v2 3/3] worktree: make add <path> dwim Thomas Gummerer
2017-11-18 22:47   ` [PATCH v3 0/3] make git worktree add dwim more Thomas Gummerer
2017-11-18 22:47     ` [PATCH v3 1/3] checkout: factor out functions to new lib file Thomas Gummerer
2017-11-18 22:47     ` [PATCH v3 2/3] worktree: make add <path> <branch> dwim Thomas Gummerer
2017-11-19  8:31       ` Eric Sunshine
2017-11-19 17:43         ` Thomas Gummerer
2017-11-18 22:47     ` [PATCH v3 3/3] worktree: make add <path> dwim Thomas Gummerer
2017-11-19 19:04       ` Eric Sunshine [this message]
2017-11-19 20:20         ` Eric Sunshine
2017-11-20  0:39           ` Junio C Hamano
2017-11-21 22:13           ` Thomas Gummerer
2017-11-22  1:20             ` Junio C Hamano
2017-11-22 19:49               ` Thomas Gummerer

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=CAPig+cQqbvuZg0Y8ZMObZc7mYXzohooVBFj0-o+CGGXrgGLp5w@mail.gmail.com \
    --to=sunshine@sunshineco.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=pclouds@gmail.com \
    --cc=t.gummerer@gmail.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).