worktree: add: auto-vivify new branch when <branch> is omitted

As a convenience, when <branch> is omitted from "git worktree <path>
<branch>" and neither -b nor -B is used, automatically create a new
branch named after <path>, as if "-b $(basename <path>)" was specified.
Thus, "git worktree add ../hotfix" creates a new branch named "hotfix"
and associates it with new worktree "../hotfix".

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 377ae0f92e2c0009d6a2f33fb85bfa19667dcd89..da71f508b1d9e909025637874bb80f13b2575126 100644 (file)
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -9,7 +9,7 @@ git-worktree - Manage multiple worktrees
 SYNOPSIS
 --------
 [verse]
-'git worktree add' [-f] [--detach] [-b <new-branch>] <path> <branch>
+'git worktree add' [-f] [--detach] [-b <new-branch>] <path> [<branch>]
 'git worktree prune' [-n] [-v] [--expire <expire>]
 
 DESCRIPTION
@@ -45,11 +45,15 @@ pruning should be suppressed. See section "DETAILS" for more information.
 
 COMMANDS
 --------
-add <path> <branch>::
+add <path> [<branch>]::
 
 Create `<path>` and checkout `<branch>` into it. The new working directory
 is linked to the current repository, sharing everything except working
 directory specific files such as HEAD, index, etc.
++
+If `<branch>` is omitted and neither `-b` nor `-B` is used, then, as a
+convenience, a new branch based at HEAD is created automatically, as if
+`-b $(basename <path>)` was specified.
 
 prune::
 

diff --git a/builtin/worktree.c b/builtin/worktree.c
index 323d444b35cd465f5c7c61d4d935475c562be0d3..69248ba0a352de82f59a117b9ba4ed4e6af74a4d 100644 (file)
--- a/builtin/worktree.c
+++ b/builtin/worktree.c
@@ -291,12 +291,16 @@ static int add(int ac, const char **av, const char *prefix)
                die(_("-b and -B are mutually exclusive"));
        if (ac < 1 || ac > 2)
                usage_with_options(worktree_usage, options);
-       if (ac < 2 && !new_branch && !new_branch_force)
-               usage_with_options(worktree_usage, options);
 
        path = prefix ? prefix_filename(prefix, strlen(prefix), av[0]) : av[0];
        branch = ac < 2 ? "HEAD" : av[1];
 
+       if (ac < 2 && !new_branch && !new_branch_force) {
+               int n;
+               const char *s = worktree_basename(path, &n);
+               new_branch = xstrndup(s, n);
+       }
+
        argv_array_push(&cmd, "checkout");
        if (force)
                argv_array_push(&cmd, "--ignore-other-worktrees");

diff --git a/t/t2025-worktree-add.sh b/t/t2025-worktree-add.sh
index 8964dec75ab808a440c40de8e320f20f12fb7908..ead8aa2a9d78c8f6451d19812d48ae5d69e6ee69 100755 (executable)
--- a/t/t2025-worktree-add.sh
+++ b/t/t2025-worktree-add.sh
@@ -145,4 +145,18 @@ test_expect_success '"add -b" with <branch> omitted' '
        test_cmp_rev HEAD burble
 '
 
+test_expect_success '"add" with <branch> omitted' '
+       git worktree add wiffle/bat &&
+       test_cmp_rev HEAD bat
+'
+
+test_expect_success '"add" auto-vivify does not clobber existing branch' '
+       test_commit c1 &&
+       test_commit c2 &&
+       git branch precious HEAD~1 &&
+       test_must_fail git worktree add precious &&
+       test_cmp_rev HEAD~1 precious &&
+       test_path_is_missing precious
+'
+
 test_done