On Fri, 15 Mar 2019, Duy Nguyen wrote:
> On Fri, Mar 15, 2019 at 8:19 PM Robert P. J. Day <rpjday@xxxxxxxxxxxxxx> wrote:
> > this is the first time i've played with this feature, so i'm
> > still working my way through the man page, trying to figure out
> > the various valid combinations for shallow cloning.
> >
> > i notice that the SYNOPSIS for "man git-clone" does not contain
> > all of the supported options (eg., --shallow-exclude is missing,
> > among others). is that deliberate?
>
> No. It's either laziness or giving up on adding every option in the
> SYNOPSIS. Improvements are welcome. I can see now that
> --single-branch is mentioned in --depth (the original option to make
> a shallow clone) but not on the newer ones. My bad.
it's fairly obvious that, when you have a git command with a
bazillion options, it's pointless to try to include everything in the
SYNOPSIS part of the man page -- best to just go with something like:
SYNOPSIS
git log [<options>] [<revision range>] [[--] <path>...]
what should (IMHO) be avoided are *incomplete* synopses, as those are
exactly the ones that can mislead the reader into thinking that's the
full set of options. "man git-clone" might be at the point of just
reducing the synopsis.
also, i think "man git-clone" could really use a set of examples for
shallow cloning. i'd offer to write it but i'm still figuring it out.
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca/dokuwiki
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
