git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Andreas Heiduk <asheiduk@gmail.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: "Git Mailing List" <git@vger.kernel.org>,
	"Junio C Hamano" <gitster@pobox.com>, "Eric Wong" <e@80x24.org>,
	"Martin Ågren" <martin.agren@gmail.com>
Subject: Re: [PATCH v2 2/6] doc: align 'diff --no-index' in text with synopsis
Date: Fri, 27 Apr 2018 20:40:39 +0200	[thread overview]
Message-ID: <bb44e716-a57b-71fb-4446-20809ddb73d1@gmail.com> (raw)
In-Reply-To: <CAPig+cTM1J35hvwYwj9BOkFxw0tGQJFZjPL_WnCa=wDxzYzj0g@mail.gmail.com>

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 ;-)

  reply	other threads:[~2018-04-27 18:40 UTC|newest]

Thread overview: 56+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-10 18:32 [PATCH 0/6] Some doc-fixes Andreas Heiduk
2018-04-10 18:32 ` [PATCH 1/6] doc: fix formatting inconsistency in githooks.txt Andreas Heiduk
2018-04-10 19:13   ` Martin Ågren
2018-04-10 20:04     ` Andreas Heiduk
2018-04-10 20:44       ` Martin Ågren
2018-04-10 21:23         ` Junio C Hamano
2018-04-11 21:05           ` Andreas Heiduk
2018-04-11 21:08             ` fixup! " Andreas Heiduk
2018-04-11 21:08             ` Andreas Heiduk
2018-04-12 19:36               ` Martin Ågren
2018-04-27 16:21                 ` Andreas Heiduk
2018-04-10 18:32 ` [PATCH 2/6] doc: align 'diff --no-index' in text with synopsis Andreas Heiduk
2018-04-10 19:14   ` Martin Ågren
2018-04-10 19:14     ` Martin Ågren
2018-04-10 19:32     ` Andreas Heiduk
2018-04-10 21:22   ` Junio C Hamano
2018-04-11 21:21     ` fixup! " Andreas Heiduk
2018-04-10 18:32 ` [PATCH 3/6] doc: clarify ignore rules for git ls-files Andreas Heiduk
2018-04-10 18:32 ` [PATCH 4/6] doc: added '-d' and '-q' for 'git push' Andreas Heiduk
2018-04-10 19:17   ` Martin Ågren
2018-04-10 19:38     ` Andreas Heiduk
2018-04-10 20:05       ` Martin Ågren
2018-04-10 20:05         ` Martin Ågren
2018-04-10 18:39 ` [PATCH 5/6] git-svn: commit-diff does not support --add-author-from Andreas Heiduk
2018-04-17  6:18   ` Eric Wong
2018-04-27 16:31     ` Andreas Heiduk
2018-04-10 18:39 ` [PATCH 6/6] doc: add note about shell quoting to revision.txt Andreas Heiduk
2018-04-10 21:25   ` Junio C Hamano
2018-04-27 17:04 ` [PATCH v2 0/6] Some doc-fixes Andreas Heiduk
2018-05-03 18:48   ` [PATCH v3 0/7] " Andreas Heiduk
2018-05-03 18:48     ` [PATCH v3 1/7] doc: improve formatting in githooks.txt Andreas Heiduk
2018-05-03 18:48     ` [PATCH v3 2/7] doc: align 'diff --no-index' in text and synopsis Andreas Heiduk
2018-05-03 18:48     ` [PATCH v3 3/7] doc: clarify ignore rules for git ls-files Andreas Heiduk
2018-05-03 18:48     ` [PATCH v3 4/7] doc: add '-d' and '-o' for 'git push' Andreas Heiduk
2018-05-03 18:48     ` [PATCH v3 5/7] git-svn: remove ''--add-author-from' for 'commit-diff' Andreas Heiduk
2018-05-03 18:48     ` [PATCH v3 6/7] doc: add note about shell quoting to revision.txt Andreas Heiduk
2018-05-03 18:48     ` [PATCH v3 7/7] doc: normalize [--options] to [options] in git-diff Andreas Heiduk
2018-05-04 18:47     ` [PATCH v3 0/7] Some doc-fixes Martin Ågren
2018-04-27 17:04 ` [PATCH v2 1/6] doc: improve formatting in githooks.txt Andreas Heiduk
2018-04-27 18:46   ` Martin Ågren
2018-04-27 17:04 ` [PATCH v2 2/6] doc: align 'diff --no-index' in text with synopsis Andreas Heiduk
2018-04-27 17:18   ` Martin Ågren
2018-04-27 18:28     ` Andreas Heiduk
2018-04-27 18:45       ` Martin Ågren
2018-04-27 19:08         ` Andreas Heiduk
2018-04-27 17:33   ` Eric Sunshine
2018-04-27 18:40     ` Andreas Heiduk [this message]
2018-04-27 18:43       ` Martin Ågren
2018-04-27 19:12       ` Eric Sunshine
2018-04-27 17:04 ` [PATCH v2 3/6] doc: clarify ignore rules for git ls-files Andreas Heiduk
2018-04-27 17:04 ` [PATCH v2 4/6] doc: add '-d' and '-o' for 'git push' Andreas Heiduk
2018-04-27 17:04 ` [PATCH v2 5/6] git-svn: remove ''--add-author-from' for 'commit-diff' Andreas Heiduk
2018-04-27 17:04 ` [PATCH v2 6/6] doc: add note about shell quoting to revision.txt Andreas Heiduk
2018-04-27 17:36   ` Eric Sunshine
2018-04-27 18:42     ` Andreas Heiduk
2018-04-27 19:23 ` [PATCH v2 7/6] doc: normalize [--options] to [options] in git-diff Andreas Heiduk

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=bb44e716-a57b-71fb-4446-20809ddb73d1@gmail.com \
    --to=asheiduk@gmail.com \
    --cc=e@80x24.org \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=martin.agren@gmail.com \
    --cc=sunshine@sunshineco.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).