From: Junio C Hamano <gitster@pobox.com>
To: Duy Nguyen <pclouds@gmail.com>
Cc: "Robert P. J. Day" <rpjday@crashcourse.ca>,
Git Mailing list <git@vger.kernel.org>
Subject: Re* misleading "man git-worktree", is last "add" argument necessarily a "branch"?
Date: Wed, 17 Jan 2018 10:32:32 -0800 [thread overview]
Message-ID: <xmqqh8rks5dr.fsf_-_@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <CACsJy8A0BcdqwkDDd0Fx_8DDCgJc6gZaXkcYqysdv8BH1nvibQ@mail.gmail.com> (Duy Nguyen's message of "Wed, 17 Jan 2018 20:34:14 +0700")
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>]"),
prev parent reply other threads:[~2018-01-17 18:32 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
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 ` Junio C Hamano [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqh8rks5dr.fsf_-_@gitster.mtv.corp.google.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=pclouds@gmail.com \
--cc=rpjday@crashcourse.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).