From: Martin Ågren <martin.agren@gmail.com>
Date: Fri, 27 Apr 2018 18:43:55 GMT
Subject: Re: [PATCH v2 2/6] doc: align 'diff --no-index' in text with synopsis
Message-ID: <CAN0heSqSu0g=3V6MueOQaYKv-HWDbXDBwrEQ=o3r4v_xa1xWkw@mail.gmail.com>
In-Reply-To: <bb44e716-a57b-71fb-4446-20809ddb73d1@gmail.com>

On 27 April 2018 at 20:40, Andreas Heiduk <asheiduk@gmail.com> wrote:
> Am 27.04.2018 um 19:33 schrieb Eric Sunshine:
>> On Fri, Apr 27, 2018 at 1:04 PM, 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.
>>>
>>> All three items are already correct in the synopsis.
>>>
>>> Signed-off-by: Andreas Heiduk <asheiduk@gmail.com>
>>> ---
>>> diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
>>> @@ -13,7 +13,7 @@ SYNOPSIS
>>> -'git diff' [options] [--no-index] [--] <path> <path>
>>> +'git diff' [options] --no-index [--] <path> <path>
>>> @@ -29,7 +29,7 @@ two blob objects, or changes between two files on disk.
>>> -'git diff' --no-index [--options] [--] [<path>...]::
>>> +'git diff' [--options] --no-index [--] <path> <path>::
>>
>> Not a problem introduced by this patch, but shouldn't this say
>> "[options]" rather than "[--options]"? Since the aim of this patch
>> series is to clean up botches and normalize documentation, perhaps it
>> could also fix this oddness(?).
>>
>
> Well, in the SYNOPSIS it is always `[options]` for all variants but in
> the DESCRIPTION it is always `[--options]` for all variants. Fixing the
> other variants would stretch the "subject" line of the patch a little
> bit to far ;-)

Hmm, I do not think it's always though. It's pretty consistent in its
inconsistency, but "git diff [options] <blob> <blob>" goes the other
way. Maybe that's patch 1/7...