Re: "man git-checkout", man page is inconsistent between SYNOPSIS and details

From: Robert P. J. Day <rpjday@crashcourse.ca>
Date: Oct 1, 2017, 10:05 UTC
Message-ID: <alpine.LFD.2.21.1710010603340.17338@localhost.localdomain>
In-Reply-To: <xmqqo9prv86l.fsf@gitster.mtv.corp.google.com>

On Sun, 1 Oct 2017, Junio C Hamano wrote:

Show 9 quoted lines

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