From: Eric Sunshine <sunshine@sunshineco.com>
Date: Fri, 27 Apr 2018 19:12:46 GMT
Subject: Re: [PATCH v2 2/6] doc: align 'diff --no-index' in text with synopsis
Message-ID: <CAPig+cQyVWXfLXGJO2JBxXTB1sT3ba_AukbKtaYwq8SjWcKq8g@mail.gmail.com>
In-Reply-To: <bb44e716-a57b-71fb-4446-20809ddb73d1@gmail.com>

On Fri, Apr 27, 2018 at 2:40 PM, 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:
>>> @@ -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 ;-)

I wasn't suggesting that this patch should fix that issue (it
shouldn't) but that it could/should be done by a separate new patch
since it's a distinct change. (That's why I was careful to say "aim of
this patch _series_".)