summaryrefslogtreecommitdiff
path: root/Documentation/git-diff-index.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2013-05-19 22:01:20 -0700
committerJunio C Hamano <gitster@pobox.com>2013-05-20 15:50:44 -0700
commitb3d6e6e7075967659dc2f5064b4829902cca67da (patch)
treeefe213fe5d710a2684a18b21d0007d80fed86be0 /Documentation/git-diff-index.txt
parent92758dd2a2de94c90c0697ef0e8174c3543a47f9 (diff)
downloadgit-b3d6e6e7075967659dc2f5064b4829902cca67da.tar.gz
Documentation/diff-index: mention two modes of operation
"diff-index" can be used to compare a tree with the tracked working tree files (when used without the --index option), or with the index (when used with the --index option). The text however did not say anything about the comparison with the working tree at all. Fix this. Reported-by: Albert Netymk <albertnetymk@gmail.com> Helped-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-diff-index.txt')
-rw-r--r--Documentation/git-diff-index.txt12
1 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/git-diff-index.txt b/Documentation/git-diff-index.txt
index c0b7c581ad..a86cf62e68 100644
--- a/Documentation/git-diff-index.txt
+++ b/Documentation/git-diff-index.txt
@@ -3,7 +3,7 @@ git-diff-index(1)
NAME
----
-git-diff-index - Compares content and mode of blobs between the index and repository
+git-diff-index - Compare a tree to the working tree or index
SYNOPSIS
@@ -13,11 +13,11 @@ SYNOPSIS
DESCRIPTION
-----------
-Compares the content and mode of the blobs found via a tree
-object with the content of the current index and, optionally
-ignoring the stat state of the file on disk. When paths are
-specified, compares only those named paths. Otherwise all
-entries in the index are compared.
+Compares the content and mode of the blobs found in a tree object
+with the corresponding tracked files in the working tree, or with the
+corresponding paths in the index. When <path> arguments are present,
+compares only paths matching those patterns. Otherwise all tracked
+files are compared.
OPTIONS
-------