Documentation/git-diff: A..B and A...B cannot take tree-ishes

As pointed out by Linus, these notations require the endpoints
given by the end user to be commits.  Clarify.

Also, three-dots in AsciiDoc are turned into ellipses unless
quoted with bq.  Be careful.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Junio C Hamano 2007-08-28 21:47:08 -07:00
parent 9d5fc59d12
commit 0c783f66df

View file

@ -53,23 +53,24 @@ forced by --no-index.
one side is omitted, it will have the same effect as one side is omitted, it will have the same effect as
using HEAD instead. using HEAD instead.
'git-diff' [--options] <commit>...<commit> [--] [<path>...]:: 'git-diff' [--options] <commit>\...<commit> [--] [<path>...]::
This form is to view the changes on the branch containing This form is to view the changes on the branch containing
and up to the second <commit>, starting at a common ancestor and up to the second <commit>, starting at a common ancestor
of both <commit>. "git-diff A...B" is equivalent to of both <commit>. "git-diff A\...B" is equivalent to
"git-diff $(git-merge-base A B) B". You can omit any one "git-diff $(git-merge-base A B) B". You can omit any one
of <commit>, which has the same effect as using HEAD instead. of <commit>, which has the same effect as using HEAD instead.
Just in case if you are doing something exotic, it should be Just in case if you are doing something exotic, it should be
noted that all of the <commit> in the above description can be noted that all of the <commit> in the above description, except
any <tree-ish>. for the last two forms that use ".." notations, can be any
<tree-ish>.
For a more complete list of ways to spell <commit>, see For a more complete list of ways to spell <commit>, see
"SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1]. "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
However, "diff" is about comparing two _endpoints_, not ranges, However, "diff" is about comparing two _endpoints_, not ranges,
and the range notations ("<commit>..<commit>" and and the range notations ("<commit>..<commit>" and
"<commit>...<commit>") do not mean a range as defined in the "<commit>\...<commit>") do not mean a range as defined in the
"SPECIFYING RANGES" section in gitlink:git-rev-parse[1]. "SPECIFYING RANGES" section in gitlink:git-rev-parse[1].
OPTIONS OPTIONS