Re: [PATCH] doc: remove unsupported parameter from patch-id

From: Jeff King <peff@peff.net>
Date: Jul 28, 2017, 00:55 UTC
Message-ID: <20170728005532.5q5x2ur5alu2pora@sigill.intra.peff.net>
In-Reply-To: <20170727224616.7216-1-asheiduk@gmail.com>

On Fri, Jul 28, 2017 at 12:46:16AM +0200, Andreas Heiduk wrote:

Show 18 quoted lines

> The patch is read from standard input and not from a parameter.
> 
> Signed-off-by: Andreas Heiduk <asheiduk@gmail.com>
> ---
>  Documentation/git-patch-id.txt | 3 ---
>  1 file changed, 3 deletions(-)
> 
> diff --git a/Documentation/git-patch-id.txt b/Documentation/git-patch-id.txt
> index cf71fba1c..442caff8a 100644
> --- a/Documentation/git-patch-id.txt
> +++ b/Documentation/git-patch-id.txt
> @@ -56,9 +56,6 @@ OPTIONS
>  
>  	This is the default.
>  
> -<patch>::
> -	The diff to create the ID of.
> -

Heh, I think this is a leftover from 33e8fc874 (usage: do not insist that standard input must come from a file, 2015-10-16).

Before then, the usage at the top said something like:

  git patch-id < <patch>

and this "parameter" made sense. But after, we just talk about stdin in the text, and mentioning "<patch>" is simply confusing.

I looked through the other documentation touched by 33e8fc874 to see if there were other cases of this same problem, but I think this is the only one.

-Peff