summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar Eric Sunshine <sunshine@sunshineco.com>2015-07-06 13:30:53 -0400
committerLibravatar Junio C Hamano <gitster@pobox.com>2015-07-06 11:07:47 -0700
commitcbdf60fa183e3a2330849046846b400ef4a99c3b (patch)
tree2ea6cfd259515270553cc433822e253d1c479634 /Documentation
parentworktree: add --detach option (diff)
downloadtgif-cbdf60fa183e3a2330849046846b400ef4a99c3b.tar.xz
worktree: add -b/-B options
One of git-worktree's roles is to populate the new worktree, much like git-checkout, and thus, for convenience, ought to support several of the same shortcuts. Toward this goal, add -b/-B options to create a new branch and check it out in the new worktree. (For brevity, only -b is mentioned in the synopsis; -B is omitted.) Signed-off-by: Eric Sunshine <sunshine@sunshineco.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-worktree.txt13
1 files changed, 10 insertions, 3 deletions
diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 231271b2f8..f44cd78784 100644
--- 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] <path> <branch>
+'git worktree add' [-f] [--detach] [-b <new-branch>] <path> <branch>
'git worktree prune' [-n] [-v] [--expire <expire>]
DESCRIPTION
@@ -64,6 +64,14 @@ OPTIONS
is already checked out by another worktree. This option overrides
that safeguard.
+-b <new-branch>::
+-B <new-branch>::
+ With `add`, create a new branch named `<new-branch>` starting at
+ `<branch>`, and check out `<new-branch>` into the new worktree.
+ By default, `-b` refuses to create a new branch if it already
+ exists. `-B` overrides this safeguard, resetting `<new-branch>` to
+ `<branch>`.
+
--detach::
With `add`, detach HEAD in the new worktree. See "DETACHED HEAD" in
linkgit:git-checkout[1].
@@ -133,8 +141,7 @@ make the emergency fix, remove it when done, and then resume your earlier
refactoring session.
------------
-$ git branch emergency-fix master
-$ git worktree add ../temp emergency-fix
+$ git worktree add -b emergency-fix ../temp master
$ pushd ../temp
# ... hack hack hack ...
$ git commit -a -m 'emergency fix for boss'