path: root/Documentation/git-diff.txt
diff options
authorJunio C Hamano <>2013-09-17 18:42:44 (GMT)
committerJunio C Hamano <>2013-09-17 18:42:44 (GMT)
commitcd8c891b7403754cc7f4b5ace0f799adb83d3218 (patch)
tree6e2e6b048303471b81b45647043d1e995b690314 /Documentation/git-diff.txt
parent8fbb07e3f37ab53febd0b2fc0f64811c68cd2492 (diff)
parent286bc123cdabed76a1da25a32e97d392b37d51a2 (diff)
Merge branch 'dw/diff-no-index-doc'
When the user types "git diff" outside a working tree, thinking he is inside one, the current error message that is a single-liner "usage: git diff --no-index <path> <path>" may not be sufficient to make him realize the mistake. Add "Not a git repository" to the error message when we fell into the "--no-index" mode without an explicit command line option to instruct us to do so. * dw/diff-no-index-doc: diff --no-index: describe in a separate paragraph diff --no-index: clarify operation when not inside a repository
Diffstat (limited to 'Documentation/git-diff.txt')
1 files changed, 9 insertions, 4 deletions
diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index 78d6d50..33fbd8c 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -28,10 +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.
+'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>...]::