From: Martin Ågren <martin.agren@gmail.com>
Date: Fri, 27 Apr 2018 17:18:23 GMT
Subject: Re: [PATCH v2 2/6] doc: align 'diff --no-index' in text with synopsis
Message-ID: <CAN0heSpdc51+7-uWcLVXU72qLZgZApdME8ywBJaQQy4DiWHAfg@mail.gmail.com>
In-Reply-To: <20180427170440.30418-3-asheiduk@gmail.com>

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
one better though thanks to Junio's suggestion (except the mismatch with
the commit message).

Thanks for continuing with this series.

Martin

> ---
>  Documentation/git-diff.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
> index b0c1bb95c8..6593b58299 100644
> --- a/Documentation/git-diff.txt
> +++ b/Documentation/git-diff.txt
> @@ -13,7 +13,7 @@ SYNOPSIS
>  'git diff' [options] --cached [<commit>] [--] [<path>...]
>  'git diff' [options] <commit> <commit> [--] [<path>...]
>  'git diff' [options] <blob> <blob>
> -'git diff' [options] [--no-index] [--] <path> <path>
> +'git diff' [options] --no-index [--] <path> <path>
>
>  DESCRIPTION
>  -----------
> @@ -29,7 +29,7 @@ two blob objects, or changes between two files on disk.
>         further add to the index but you still haven't.  You can
>         stage these changes by using linkgit:git-add[1].
>
> -'git diff' --no-index [--options] [--] [<path>...]::
> +'git diff' [--options] --no-index [--] <path> <path>::
>
>         This form is to compare the given two paths on the
>         filesystem.  You can omit the `--no-index` option when