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

From: Kevin Daudt <me@ikke.info>
Date: Nov 21, 2017, 21:23 UTC
Message-ID: <20171121212305.GA16418@alpha.vpn.ikke.info>
In-Reply-To: <alpine.LFD.2.21.1711211607200.25585@localhost.localdomain>

On Tue, Nov 21, 2017 at 04:12:02PM -0500, Robert P. J. Day wrote:

Show 13 quoted lines

> "man gitcli" already explains the purpose of the "--" syntax, so there
> is no value to a small subset of Git commands explaining that in their
> man pages.
> 
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
> 
> ---
> 
>   i tried this once before, and i'm going to try to push it through
> again ... it's pointless and inconsistent for less than a dozen man
> pages to explicitly explain the purpose of "--" unless all of the man
> pages do. as long as the "--" appears in the command SYNOPSIS, that
> should be more than adequate.

Although I agree that common options don't need to be explained everytime again, this change might make '--' even more obscure. To be honest, I didn't even know about gitcli(7), let alone most new users.

In the #git irc channel we often have to explain what '--' means and why it's sometimes necessary.

I don't however know a better solution to it more clear.

Kevin