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>
This commit is contained in:
Junio C Hamano 2013-05-19 22:01:20 -07:00
parent 92758dd2a2
commit b3d6e6e707

View File

@ -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
-------