git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Ramkumar Ramachandra <artagnon@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Git List <git@vger.kernel.org>
Subject: [PATCH 6/5] git-diff.txt: banish the <commit>..<commit> form
Date: Wed, 24 Apr 2013 22:33:00 +0530	[thread overview]
Message-ID: <1366822980-21926-1-git-send-email-artagnon@gmail.com> (raw)
In-Reply-To: <1366821216-20868-1-git-send-email-artagnon@gmail.com>

The '<commit>..<commit>' and '<commit>...<commit>' forms are confusing
as they are reminiscent of the corresponding forms in the "SPECIFYING
RANGES" section of revisions.txt.  We can remove the
'<commit>..<commit>' form now (hence discouraging its use), since it
is exactly equivalent to the clearer '<commit> <commit>' form.
However, we must keep the '<commit>...<commit>' form around until we
can find a different way to express the same thing.

Suggested-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
---
 Documentation/git-diff.txt | 21 ++++++---------------
 1 file changed, 6 insertions(+), 15 deletions(-)

diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index 1f2f681..118b448 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -14,7 +14,6 @@ SYNOPSIS
 'git diff' [options] --cached [<commit>] [[--] [<path>...]]
 'git diff' [options] <blob> <blob>
 'git diff' [options] <commit> <commit> [[--] [<path>...]]
-'git diff' [options] <commit>..<commit> [[--] [<path>...]]
 'git diff' [options] <commit>\...<commit> [[--] [<path>...]]
 
 DESCRIPTION
@@ -63,12 +62,6 @@ directories. This behavior can be forced by --no-index.
 	This is to view the changes between two arbitrary
 	<commit>.
 
-'git diff' [options] <commit>..<commit> [[--] [<path>...]]::
-
-	This is synonymous to the previous form.  If <commit> on
-	one side is omitted, it will have the same effect as
-	using HEAD instead.
-
 'git diff' [options] <commit>\...<commit> [[--] [<path>...]]::
 
 	This form is to view the changes on the branch containing
@@ -79,14 +72,12 @@ directories. This behavior can be forced by --no-index.
 
 Just in case if you are doing something exotic, it should be
 noted that all of the <commit> in the above description, except
-in the last two forms that use ".." notations, can be any
-<tree>.
-
-For a more complete list of ways to spell <commit>, see
-"SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
-However, "diff" is about comparing two _endpoints_, not ranges,
-and the range notations ("<commit>..<commit>" and
-"<commit>\...<commit>") do not mean a range as defined in the
+in the last "..." form, can be any <tree>.
+
+For a more complete list of ways to spell <commit>, see "SPECIFYING
+REVISIONS" section in linkgit:gitrevisions[7].  However, "diff" is
+about comparing two _endpoints_, not ranges, and the range notation
+"<commit>...<commit>" does not mean a range as defined in the
 "SPECIFYING RANGES" section in linkgit:gitrevisions[7].
 
 OPTIONS
-- 
1.8.2.1.502.g2d60b5c

  parent reply	other threads:[~2013-04-24 17:03 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-04-24 16:33 [PATCH 0/5] Documentation/git-diff.txt improvements Ramkumar Ramachandra
2013-04-24 16:33 ` [PATCH 1/5] git-diff.txt: reorder the <commit> <commit> form Ramkumar Ramachandra
2013-04-24 16:41   ` Jonathan Nieder
2013-04-24 16:33 ` [PATCH 2/5] git-diff.txt: strip the leading "--" from options template Ramkumar Ramachandra
2013-04-24 16:43   ` Jonathan Nieder
2013-04-24 16:44     ` Ramkumar Ramachandra
2013-04-24 18:15       ` Junio C Hamano
2013-04-24 16:33 ` [PATCH 3/5] git-diff.txt: group the [--] and [<path>...] templates Ramkumar Ramachandra
2013-04-24 18:20   ` Junio C Hamano
2013-04-24 18:23     ` Ramkumar Ramachandra
2013-04-24 18:43       ` Junio C Hamano
2013-04-24 18:53         ` Ramkumar Ramachandra
2013-04-24 19:21           ` Junio C Hamano
2013-04-24 19:24             ` Ramkumar Ramachandra
2013-04-24 18:57       ` Jonathan Nieder
2013-04-24 16:33 ` [PATCH 4/5] git-diff.txt: document the .. and ... forms in SYNOPSIS Ramkumar Ramachandra
2013-04-24 19:03   ` Jonathan Nieder
2013-04-24 16:33 ` [PATCH 5/5] git-diff.txt: fix ordering of the [--no-index] form Ramkumar Ramachandra
2013-04-24 18:25   ` Junio C Hamano
2013-04-24 18:29     ` Ramkumar Ramachandra
2013-04-24 19:06       ` Jonathan Nieder
2013-04-24 19:10         ` Ramkumar Ramachandra
2013-04-24 19:14           ` Jonathan Nieder
2013-04-24 19:20             ` Ramkumar Ramachandra
2013-04-24 19:25               ` Jonathan Nieder
2013-04-24 19:37             ` Ramkumar Ramachandra
2013-04-24 20:37               ` Jonathan Nieder
2013-04-24 20:45                 ` Ramkumar Ramachandra
2013-04-24 20:50                   ` Jonathan Nieder
2013-04-24 20:55                     ` Ramkumar Ramachandra
2013-04-24 17:03 ` Ramkumar Ramachandra [this message]
2013-04-24 18:29   ` [PATCH 6/5] git-diff.txt: banish the <commit>..<commit> form Junio C Hamano
2013-04-24 18:33     ` Ramkumar Ramachandra
2013-04-25 11:25 ` [PATCH 0/5] Documentation/git-diff.txt improvements Ramkumar Ramachandra
2013-04-29 16:33   ` Junio C Hamano
2013-04-29 17:19     ` Ramkumar Ramachandra
2013-04-29 17:40       ` Junio C Hamano
2013-04-29 18:28         ` Ramkumar Ramachandra
2013-04-29 18:46           ` 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=1366822980-21926-1-git-send-email-artagnon@gmail.com \
    --to=artagnon@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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 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 NNTP newsgroup(s).