From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: Junio C Hamano <gitster@pobox.com>
Cc: Kevin Daudt <me@ikke.info>, Git Mailing list <git@vger.kernel.org>
Subject: Re: "man git-checkout", man page is inconsistent between SYNOPSIS and details
Date: Sun, 1 Oct 2017 06:05:44 -0400 (EDT) [thread overview]
Message-ID: <alpine.LFD.2.21.1710010603340.17338@localhost.localdomain> (raw)
In-Reply-To: <xmqqo9prv86l.fsf@gitster.mtv.corp.google.com>
On Sun, 1 Oct 2017, Junio C Hamano wrote:
> "Robert P. J. Day" <rpjday@crashcourse.ca> writes:
>
> > it's simply a matter of the forms not matching between the SYNOPSIS
> > and the DESCRIPTION sections. am i making sense?
>
> I think the whole thing is wrong and the root cause is because the
> (relatively newer) description of the "--patch" mode lazily tried to
> piggy-back the description of existing "check out from the index or
> tree-ish" mode, ending up in a confusing description...
... big snip ...
ok, i'm going to have to digest all that; pretty sure someone else
will need to change the man page to clarify the apparent inconsistency
i was referring to:
SYNOPSIS
git checkout [-p|--patch] [<tree-ish>] [--] [<paths>...]
DESCRIPTION
git checkout [-p|--patch] [<tree-ish>] [--] <pathspec>...
and on that note, i'll get back to proofreading.
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
next prev parent reply other threads:[~2017-10-01 10:05 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-30 9:27 "man git-checkout", man page is inconsistent between SYNOPSIS and details Robert P. J. Day
2017-09-30 14:32 ` Kevin Daudt
2017-09-30 15:01 ` Robert P. J. Day
2017-09-30 22:04 ` Robert P. J. Day
2017-10-01 3:49 ` Junio C Hamano
2017-10-01 10:05 ` Robert P. J. Day [this message]
2017-10-02 0:29 ` Junio C Hamano
2017-10-11 2:39 ` [PATCH] checkout doc: clarify command line args for "checkout paths" mode Junio C Hamano
2017-10-11 3:22 ` Jonathan Nieder
2017-10-11 5:02 ` Junio C Hamano
2017-10-11 5:16 ` Jonathan Nieder
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=alpine.LFD.2.21.1710010603340.17338@localhost.localdomain \
--to=rpjday@crashcourse.ca \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=me@ikke.info \
/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).