Re: [PATCH] doc: Remove explanation of "--" from several man pages

From: Junio C Hamano <gitster@pobox.com>
Date: Nov 13, 2017, 09:48 UTC
Message-ID: <xmqqlgja8q74.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <alpine.LFD.2.21.1711130357190.10471@localhost.localdomain>

"Robert P. J. Day" <rpjday@crashcourse.ca> writes:

Show 21 quoted lines

>> > 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.

If you are shooting for pedantic consistency, adding to pages that are missing would be less problematic than removing from the ones that have them, especially given that people thought the use of double-dash in commands described on these pages are common or special enough to deserve extra attention.