git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Chris Torek <chris.torek@gmail.com>
To: "Martin Ågren" <martin.agren@gmail.com>
Cc: Git List <git@vger.kernel.org>
Subject: Re: [PATCH 2/2] git-diff.txt: reorder possible usages
Date: Mon, 13 Jul 2020 15:04:23 -0700	[thread overview]
Message-ID: <CAPx1Gve7Sy5BUdRztVoVNVZgdqm14dvD=36eYzLPed5YMQeMEQ@mail.gmail.com> (raw)
In-Reply-To: <280943ef56a2a777ab0162b8ec4ba0166cc2095c.1594666410.git.martin.agren@gmail.com>

On Mon, Jul 13, 2020 at 12:10 PM Martin Ågren <martin.agren@gmail.com> wrote:
> It then goes on to say that "all of the <commit> in the above
> description, except in the last two forms that use '..' notations, can
> be any <tree>". The "last two" actually refers to 6 and 8. This got out
> of sync in commit b7e10b2ca2 ("Documentation: usage for diff combined
> commits", 2020-06-12) which added item 7 to the mix.

Moving this down (as you do in this patch) is the right thing to do,
but I'll note that formally, the word "that" in "forms that use ..." is
part of a restrictive clause, so it means "find the last two examples
that use dots".  (In American English at least, the unrestrictive version
would be set off with commas, and use "which" instead of "that".)

> An added bonus of this commit is that we're trying to steer users away
> from `git diff <commit>..<commit>` and moving it further down probably
> doesn't hurt.

Q: Just how hard should we try?  In particular, would it be good to mark
the two-dot form as deprecated in the documentation?  I anticipate
objections because it's not possible to omit `HEAD` without using
the two-dot form.

Chris

  reply	other threads:[~2020-07-13 22:04 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
2020-07-13 19:10 ` [PATCH 2/2] git-diff.txt: reorder possible usages Martin Ågren
2020-07-13 22:04   ` Chris Torek [this message]
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

  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='CAPx1Gve7Sy5BUdRztVoVNVZgdqm14dvD=36eYzLPed5YMQeMEQ@mail.gmail.com' \
    --to=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.
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).