[PATCH] document command to show diff of a commit

Document the best way to show the change introduced by a
commit, based on the suggestion by Linus on the list.

Signed-off-by: Junio C Hamano <junkio@cox.net>

diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
index 9ec4b29ff71fef1cfa63f4c7f868b9ac1ddfa6a5..816c592ebf13ddd18fdf4ab7f0dbb9c8311be2e1 100644 (file)
--- a/Documentation/git-diff-tree.txt
+++ b/Documentation/git-diff-tree.txt
@@ -9,12 +9,15 @@ git-diff-tree - Compares the content and mode of blobs found via two tree object
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-'git-diff-tree' [--stdin] [-m] [-s] [-v] [--pretty] [-t] [<common diff options>] <tree-ish> <tree-ish> [<path>...]
+'git-diff-tree' [--stdin] [-m] [-s] [-v] [--pretty] [-t] [<common diff options>] <tree-ish> [<tree-ish>] [<path>...]

 
 DESCRIPTION
 -----------
 Compares the content and mode of the blobs found via two tree objects.
 
 
 DESCRIPTION
 -----------
 Compares the content and mode of the blobs found via two tree objects.
 

+If there is only one <tree-ish> given, the commit is compared with its parents
+(see --stdin below).
+

 Note that "git-diff-tree" can use the tree encapsulated in a commit object.
 
 OPTIONS
 Note that "git-diff-tree" can use the tree encapsulated in a commit object.
 
 OPTIONS