Re: [PATCH] doc: Remove explanation of "--" from several man pages
On Mon, 13 Nov 2017, Junio C Hamano wrote:
Show 26 quoted lines
> "Robert P. J. Day" <rpjday@crashcourse.ca> writes:
>
> >> > diff --git a/Documentation/git-check-attr.txt b/Documentation/git-check-attr.txt
> >> > index aa3b2bf2f..0ae2523e0 100644
> >> > --- a/Documentation/git-check-attr.txt
> >> > +++ b/Documentation/git-check-attr.txt
> >> > @@ -36,10 +36,6 @@ OPTIONS
> >> > If `--stdin` is also given, input paths are separated
> >> > with a NUL character instead of a linefeed character.
> >> >
> >> > -\--::
> >> > - Interpret all preceding arguments as attributes and all following
> >> > - arguments as path names.
> >> > -
> >>
> >> This also has a similar issue. "--" here is not between revs and
> >> pathspecs but is between attributes and pathspecs.
> >
> > that can already be seen in the SYNOPSIS for that command, it does
> > not require further explanation:
> >
> > SYNOPSIS
> > git check-attr [-a | --all | attr...] [--] pathname...
>
> Nah. With the same logic you could say --all is already on synopsis
> and no need for explanation.
uh, that's not what i meant. what i *meant* was that the purpose of
"--" was already in the SYNOPSIS (as it appears to be in *all* man
pages) to visually show that it is a separator between the first part
of the command and possible pathnames. i was *not* suggesting that, if
something is in the SYNOPSIS, there is no further need to explain it.
anyway, i can see this is a losing battle so i'll let it go.
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================Robert P. J. Day <rpjday@crashcourse.ca>