From: Junio C Hamano <gitster@pobox.com>
To: "Martin Ågren" <martin.agren@gmail.com>
Cc: git@vger.kernel.org, Chris Torek <chris.torek@gmail.com>
Subject: Re: [PATCH 1/2] git-diff.txt: don't mark required argument as optional
Date: Mon, 13 Jul 2020 12:45:49 -0700 [thread overview]
Message-ID: <xmqq365vnqqa.fsf@gitster.c.googlers.com> (raw)
In-Reply-To: <77e4442ae51a968d460b2329fc39b6a5e96902b0.1594666410.git.martin.agren@gmail.com> ("Martin Ågren"'s message of "Mon, 13 Jul 2020 21:10:08 +0200")
Martin Ågren <martin.agren@gmail.com> writes:
> Commit b7e10b2ca2 ("Documentation: usage for diff combined commits",
> 2020-06-12) modified the synopsis by adding an optional "[<commit>...]"
> to
>
> 'git diff' [<options>] <commit> <commit> [--] [<path>...]
>
> to effectively add
>
> 'git diff' [<options>] <commit> <commit>... <commit> [--] [<path>...]
>
> as another valid invocation. Which makes sense.
>
> Further down, in the description, it left the existing entry for
>
> 'git diff' [<options>] <commit> <commit> [--] [<path>...]
>
> intact and added a new entry on
>
> 'git diff' [<options>] <commit> [<commit>...] <commit> [--] [<path>...]
>
> where it says that "[t]his form is to view the results of a merge
> commit" and details how "the first listed commit must be the merge
> itself". But one possible instantiation of this form is `git diff
> <commit> <commit>` for which the added text doesn't really apply.
>
> Remove the brackets so that we lose this overlap between the two
> descriptions. We can still use the more compact representation in the
> synopsis.
>
> Signed-off-by: Martin Ågren <martin.agren@gmail.com>
> ---
> Documentation/git-diff.txt | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
> index 1018110ddc..c613e71ca4 100644
> --- a/Documentation/git-diff.txt
> +++ b/Documentation/git-diff.txt
> @@ -69,7 +69,7 @@ files on disk.
> one side is omitted, it will have the same effect as
> using HEAD instead.
>
> -'git diff' [<options>] <commit> [<commit>...] <commit> [--] [<path>...]::
> +'git diff' [<options>] <commit> <commit>... <commit> [--] [<path>...]::
Thanks.
>
> This form is to view the results of a merge commit. The first
> listed <commit> must be the merge itself; the remaining two or
next prev parent reply other threads:[~2020-07-13 19:45 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-13 19:10 [PATCH 0/2] git-diff.txt: reorder possible usages Martin Ågren
2020-07-13 19:10 ` [PATCH 1/2] git-diff.txt: don't mark required argument as optional Martin Ågren
2020-07-13 19:45 ` Junio C Hamano [this message]
2020-07-13 19:10 ` [PATCH 2/2] git-diff.txt: reorder possible usages Martin Ågren
2020-07-13 22:04 ` Chris Torek
2020-07-14 14:49 ` Martin Ågren
2020-07-15 2:45 ` Junio C Hamano
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqq365vnqqa.fsf@gitster.c.googlers.com \
--to=gitster@pobox.com \
--cc=chris.torek@gmail.com \
--cc=git@vger.kernel.org \
--cc=martin.agren@gmail.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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.