wor...@alum.mit.edu (Dale R. Worley) writes:

>> For now, I'll queue your version as-is modulo style fixes, while
>> waiting for others to help polishing the documentation better.
> It'd difficult to figure out how to describe it well.  In my
> opinion, the problem here is the DWIM nature of the command,
> ... My preference is ... But that's not how git-diff works.

So given the constraints, I think this is the best we can do.  As nobody
seems to be helping to polish the text, here is my attempt, on top
of your patch.

 Documentation/git-diff.txt | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index b1630ba..33fbd8c 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -28,11 +28,15 @@ two blob objects, or changes between two files on disk.
        words, the differences are what you _could_ tell Git to
        further add to the index but you still haven't.  You can
        stage these changes by using linkgit:git-add[1].
-If exactly two paths are given and at least one points outside
-the current repository, 'git diff' will compare the two files /
-directories. This behavior can be forced by --no-index or by
-executing 'git diff' outside of a working tree.
+'git diff' --no-index [--options] [--] [<path>...]::
+       This form is to compare the given two paths on the
+       filesystem.  You can omit the `--no-index` option when
+       running the command in a working tree controlled by Git and
+       at least one of the paths points outside the working tree,
+       or when running the command outside a working tree
+       controlled by Git.
 'git diff' [--options] --cached [<commit>] [--] [<path>...]::
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Reply via email to