Thread (1 message) 1 message, 1 author, 2018-01-17

Re* misleading "man git-worktree", is last "add" argument necessarily a "branch"?

From: Junio C Hamano <hidden>
Date: 2018-01-17 18:32:39
Subsystem: the rest · Maintainer: Linus Torvalds

Duy Nguyen [off-list ref] writes:
On Wed, Jan 17, 2018 at 7:58 PM, Robert P. J. Day [off-list ref] wrote:
quoted
  perusing "git worktree", and man page reads:

  SYNOPSIS
       git worktree add [-f] [--detach] [--checkout] [--lock]   \
                        [-b <new-branch>] <path> [<branch>]
                                                 ^^^^^^^^^^

however, can't that last optional argument be any arbitrary commit,
not just a "branch"?
It's been changed to commit-ish about two months ago in c4738aedc0
(worktree: add can be created from any commit-ish - 2017-11-26)
Indeed "git worktree --help" is more up to date, but "git worktree
-h" is stale.

-- >8 --
Subject: worktree: say that "add" takes an arbitrary commit in short-help

c4738aed ("worktree: add can be created from any commit-ish",
2017-11-26) taught "git worktree add" to start a new worktree
with an arbitrary commit-ish checked out, not limited to a tip
of a branch.  

"git worktree --help" was updated to describe this, but we forgot to
update "git worktree -h".

Signed-off-by: Junio C Hamano <redacted>
---
 builtin/worktree.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/builtin/worktree.c b/builtin/worktree.c
index 7cef5b120b..9efdc22466 100644
--- a/builtin/worktree.c
+++ b/builtin/worktree.c
@@ -14,7 +14,7 @@
 #include "worktree.h"
 
 static const char * const worktree_usage[] = {
-	N_("git worktree add [<options>] <path> [<branch>]"),
+	N_("git worktree add [<options>] <path> [<commit-ish>]"),
 	N_("git worktree list [<options>]"),
 	N_("git worktree lock [<options>] <path>"),
 	N_("git worktree prune [<options>]"),

Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help