git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
* misleading "man git-worktree", is last "add" argument necessarily a "branch"?
@ 2018-01-17 12:58 Robert P. J. Day
  2018-01-17 13:34 ` Duy Nguyen
  0 siblings, 1 reply; 4+ messages in thread
From: Robert P. J. Day @ 2018-01-17 12:58 UTC (permalink / raw)
  To: Git Mailing list


  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"?

rday

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: misleading "man git-worktree", is last "add" argument necessarily a "branch"?
  2018-01-17 12:58 misleading "man git-worktree", is last "add" argument necessarily a "branch"? Robert P. J. Day
@ 2018-01-17 13:34 ` Duy Nguyen
  2018-01-17 13:42   ` Robert P. J. Day
  2018-01-17 18:32   ` Re* " Junio C Hamano
  0 siblings, 2 replies; 4+ messages in thread
From: Duy Nguyen @ 2018-01-17 13:34 UTC (permalink / raw)
  To: Robert P. J. Day; +Cc: Git Mailing list

On Wed, Jan 17, 2018 at 7:58 PM, Robert P. J. Day <rpjday@crashcourse.ca> wrote:
>
>   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)
-- 
Duy

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: misleading "man git-worktree", is last "add" argument necessarily a "branch"?
  2018-01-17 13:34 ` Duy Nguyen
@ 2018-01-17 13:42   ` Robert P. J. Day
  2018-01-17 18:32   ` Re* " Junio C Hamano
  1 sibling, 0 replies; 4+ messages in thread
From: Robert P. J. Day @ 2018-01-17 13:42 UTC (permalink / raw)
  To: Duy Nguyen; +Cc: Git Mailing list

On Wed, 17 Jan 2018, Duy Nguyen wrote:

> On Wed, Jan 17, 2018 at 7:58 PM, Robert P. J. Day <rpjday@crashcourse.ca> wrote:
> >
> >   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)

  guess i better update my repo, thanks.

rday

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re* misleading "man git-worktree", is last "add" argument necessarily a "branch"?
  2018-01-17 13:34 ` Duy Nguyen
  2018-01-17 13:42   ` Robert P. J. Day
@ 2018-01-17 18:32   ` Junio C Hamano
  1 sibling, 0 replies; 4+ messages in thread
From: Junio C Hamano @ 2018-01-17 18:32 UTC (permalink / raw)
  To: Duy Nguyen; +Cc: Robert P. J. Day, Git Mailing list

Duy Nguyen <pclouds@gmail.com> writes:

> On Wed, Jan 17, 2018 at 7:58 PM, Robert P. J. Day <rpjday@crashcourse.ca> wrote:
>>
>>   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 <gitster@pobox.com>
---
 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>]"),



^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2018-01-17 18:32 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-01-17 12:58 misleading "man git-worktree", is last "add" argument necessarily a "branch"? Robert P. J. Day
2018-01-17 13:34 ` Duy Nguyen
2018-01-17 13:42   ` Robert P. J. Day
2018-01-17 18:32   ` Re* " Junio C Hamano

git@vger.kernel.org list mirror (unofficial, one of many)

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://public-inbox.org/git
	git clone --mirror http://ou63pmih66umazou.onion/git
	git clone --mirror http://czquwvybam4bgbro.onion/git
	git clone --mirror http://hjrcffqmbrq6wope.onion/git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 git git/ https://public-inbox.org/git \
		git@vger.kernel.org
	public-inbox-index git

Example config snippet for mirrors.
Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.version-control.git
	nntp://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/inbox.comp.version-control.git
	nntp://ie5yzdi7fg72h7s4sdcztq5evakq23rdt33mfyfcddc5u3ndnw24ogqd.onion/inbox.comp.version-control.git
	nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.version-control.git
	nntp://news.gmane.io/gmane.comp.version-control.git
 note: .onion URLs require Tor: https://www.torproject.org/

code repositories for project(s) associated with this inbox:

	https://80x24.org/mirrors/git.git

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git