[PATCH] document command to show diff of a commit
authorRobert Watson <robert.oo.watson@gmail.com>
Fri, 23 Sep 2005 10:06:04 +0000 (11:06 +0100)
committerJunio C Hamano <junkio@cox.net>
Fri, 23 Sep 2005 21:28:40 +0000 (14:28 -0700)
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>
Documentation/git-diff-tree.txt

index 9ec4b29..816c592 100644 (file)
@@ -9,12 +9,15 @@ git-diff-tree - Compares the content and mode of blobs found via two tree object
 
 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.
 
+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