[PATCH 6/5] git-diff.txt: banish the <commit>..<commit> form
- From
Ramkumar Ramachandra <artagnon@gmail.com>
- Date
- Apr 24, 2013, 17:03 UTC
- Message-ID
- <1366822980-21926-1-git-send-email-artagnon@gmail.com>
- 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