Currently 'git worktree add <path>' creates a new branch named after the
basename of the path by default. If a branch with that name already
exists, the command refuses to do anything, unless the '--force' option
is given.
However we can do a little better than that, and check the branch out if
it is not checked out anywhere else. This will help users who just want
to check an existing branch out into a new worktree, and save a few
keystrokes.
As the current behaviour is to simply 'die()' when a branch with the name
of the basename of the path already exists, there are no backwards
compatibility worries here.
We will still 'die()' if the branch is checked out in another worktree,
unless the --force flag is passed.
Signed-off-by: Thomas Gummerer <t.gummerer@xxxxxxxxx>
---
Documentation/git-worktree.txt | 9 +++++++--
builtin/worktree.c | 22 +++++++++++++++++++---
t/t2025-worktree-add.sh | 15 ++++++++++++---
3 files changed, 38 insertions(+), 8 deletions(-)
diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 41585f535d..98731b71a7 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -61,8 +61,13 @@ $ git worktree add --track -b <branch> <path> <remote>/<branch>
------------
+
If `<commit-ish>` 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, a worktree with a branch named after
+`$(basename <path>)` (call it `<branch>`) is created. If `<branch>`
+doesn't exist, a new branch based on HEAD is automatically created as
+if `-b <branch>` was given. If `<branch>` exists in the repository,
+it will be checked out in the new worktree, if it's not checked out
+anywhere else, otherwise the command will refuse to create the
+worktree.
list::
diff --git a/builtin/worktree.c b/builtin/worktree.c
index 52049b447a..b5d273751f 100644
--- a/builtin/worktree.c
+++ b/builtin/worktree.c
@@ -29,6 +29,7 @@ struct add_opts {
int keep_locked;
const char *new_branch;
int force_new_branch;
+ int checkout_existing_branch;
};
static int show_only;
@@ -318,8 +319,11 @@ static int add_worktree(const char *path, const char *refname,
if (ret)
goto done;
- if (opts->new_branch)
- fprintf(stderr, _("creating new branch '%s'"), opts->new_branch);
+ if (opts->checkout_existing_branch)
+ fprintf(stderr, _("checking out branch '%s'"),
+ refname);
+ else if (opts->new_branch)
+ fprintf(stderr, _("creating branch '%s'"), opts->new_branch);
fprintf(stderr, _("worktree HEAD is now at %s"),
find_unique_abbrev(commit->object.oid.hash, DEFAULT_ABBREV));
@@ -371,7 +375,19 @@ static const char *dwim_branch(const char *path, struct add_opts *opts)
{
int n;
const char *s = worktree_basename(path, &n);
- opts->new_branch = xstrndup(s, n);
+ const char *branchname = xstrndup(s, n);
+ struct strbuf ref = STRBUF_INIT;
+
+ if (!strbuf_check_branch_ref(&ref, branchname) &&
+ ref_exists(ref.buf)) {
+ *branch = branchname;
+ opts->checkout_existing_branch = 1;
+ strbuf_release(&ref);
+ UNLEAK(branchname);
+ return branchname;
+ }
+
+ opts->new_branch = branchname;
if (guess_remote) {
struct object_id oid;
const char *remote =
diff --git a/t/t2025-worktree-add.sh b/t/t2025-worktree-add.sh
index 2b95944973..721b0e4c26 100755
--- a/t/t2025-worktree-add.sh
+++ b/t/t2025-worktree-add.sh
@@ -198,13 +198,22 @@ test_expect_success '"add" with <branch> omitted' '
test_cmp_rev HEAD bat
'
-test_expect_success '"add" auto-vivify does not clobber existing branch' '
+test_expect_success '"add" auto-vivify checks out existing branch' '
test_commit c1 &&
test_commit c2 &&
git branch precious HEAD~1 &&
- test_must_fail git worktree add precious &&
+ git worktree add precious &&
test_cmp_rev HEAD~1 precious &&
- test_path_is_missing precious
+ (
+ cd precious &&
+ test_cmp_rev precious HEAD
+ )
+'
+
+test_expect_success '"add" auto-vivify fails with checked out branch' '
+ git checkout -b test-branch &&
+ test_must_fail git worktree add test-branch &&
+ test_path_is_missing test-branch
'
test_expect_success '"add" no auto-vivify with --detach and <branch> omitted' '
--
2.17.0.rc0.231.g781580f06
