Re: [PATCH v2 2/6] doc: align 'diff --no-index' in text with synopsis

From: Andreas Heiduk <asheiduk@gmail.com>
Date: Apr 27, 2018, 18:28 UTC
Message-ID: <a3253c99-63a4-22bc-53a0-4d94c01a564c@gmail.com>
In-Reply-To: <CAN0heSpdc51+7-uWcLVXU72qLZgZApdME8ywBJaQQy4DiWHAfg@mail.gmail.com>

Am 27.04.2018 um 19:18 schrieb Martin Ågren:

Show 17 quoted lines

> On 27 April 2018 at 19:04, Andreas Heiduk <asheiduk@gmail.com> wrote:
>> The two '<path>' parameters are not optional but the option
>> '--no-index' is. Also move the `--options` part to the same
>> place where the other variants show them.
> 
> Should this commit message be updated after the changes you did to
> address Junio's comment? This text suggests you want to place --no-index
> in [] (and you did in v1) but you do not do that below.
> 
>> All three items are already correct in the synopsis.
> 
> Same here, now you actually do change things there.
> 
>> Signed-off-by: Andreas Heiduk <asheiduk@gmail.com>
>> Reviewed-by: Martin Ågren <martin.agren@gmail.com>
> 
> Strictly speaking, my Reviewed-by was on another patch. I do find this

Sorry, I've added that trailer after reading "The diff LGTM.", then applied Junio's changes and forgot to remove the trailer.

> one better though thanks to Junio's suggestion (except the mismatch with
> the commit message).

I'll fix that with this:

	doc: align 'diff --no-index' in text with synopsis

	Make the two '<path>' parameters in DESCRIPTION mandatory and
	move the `--options` part to the same place where the other
	variants show them. And finally make `--no-index` in SYNOPSIS
	as mandatory as in DESCRIPTION.