From: Junio C Hamano <junkio@cox.net>
Date: Tue, 24 May 2005 01:20:39 +0000 (-0700)
Subject: [PATCH] Update git-diff-cache documentation.
X-Git-Tag: v0.99~478
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=b1c006dd651fce55e25a7b06d00382cfdc1a3f91;p=git.git

[PATCH] Update git-diff-cache documentation.

The recent diff updates gave diff-cache the same ability to
filter paths, which was not properly documented.

Signed-off-by: Junio C Hamano <junkio@cox.net>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
---

diff --git a/Documentation/git-diff-cache.txt b/Documentation/git-diff-cache.txt
index e89aaa503..35253b11b 100644
--- a/Documentation/git-diff-cache.txt
+++ b/Documentation/git-diff-cache.txt
@@ -9,13 +9,15 @@ git-diff-cache - Compares content and mode of blobs between the cache and reposi
 
 SYNOPSIS
 --------
-'git-diff-cache' [-p] [-r] [-z] [-m] [-M] [-R] [-C] [-S<string>] [--cached] <tree-ish>
+'git-diff-cache' [-p] [-r] [-z] [-m] [-M] [-R] [-C] [-S<string>] [--cached] <tree-ish> [<path>...]
 
 DESCRIPTION
 -----------
-Compares the content and mode of the blobs found via a tree object
-with the content of the current cache and, optionally ignoring the
-stat state of the file on disk.
+Compares the content and mode of the blobs found via a tree
+object with the content of the current cache 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 cache are compared.
 
 OPTIONS
 -------
diff --git a/diff-cache.c b/diff-cache.c
index 579a673f6..744fffb7c 100644
--- a/diff-cache.c
+++ b/diff-cache.c
@@ -154,7 +154,7 @@ static void mark_merge_entries(void)
 }
 
 static char *diff_cache_usage =
-"git-diff-cache [-p] [-r] [-z] [-m] [-M] [-C] [-R] [-S<string>] [--cached] <tree-ish>";
+"git-diff-cache [-p] [-r] [-z] [-m] [-M] [-C] [-R] [-S<string>] [--cached] <tree-ish> [<path>...]";
 
 int main(int argc, const char **argv)
 {