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>
Junio C Hamano committed
May 19, 2013 at 22:01 UTC
b3d6e6e7075967659dc2f5064b4829902cca67da
1 file changed
+6
-6
Documentation/git-diff-index.txt
+6
-6
@@ -3,7 +3,7 @@ git-diff-index(1)
3
4
NAME
5
----
6
-git-diff-index - Compares content and mode of blobs between the index and repository
6
+git-diff-index - Compare a tree to the working tree or index
7
8
9
SYNOPSIS
@@ -13,11 +13,11 @@ SYNOPSIS
13
14
DESCRIPTION
15
-----------
16
-Compares the content and mode of the blobs found via a tree
17
-object with the content of the current index and, optionally
18
-ignoring the stat state of the file on disk. When paths are
19
-specified, compares only those named paths. Otherwise all
20
-entries in the index are compared.
16
+Compares the content and mode of the blobs found in a tree object
17
+with the corresponding tracked files in the working tree, or with the
18
+corresponding paths in the index. When <path> arguments are present,
19
+compares only paths matching those patterns. Otherwise all tracked
20
+files are compared.
21
22
OPTIONS
23
-------