[PATCH] Documentation for git-request-pull-script.
[gitweb.git] / Documentation / git-diff-tree.txt
index e2a22e0869c5db73a29dd740fe089b43e104abbc..5ccf0ba1291d2175ef1bf9dea35ac174b59a24e6 100644 (file)
@@ -9,7 +9,7 @@ git-diff-tree - Compares the content and mode of blobs found via two tree object
 
 SYNOPSIS
 --------
-'git-diff-tree' [-p] [-r] [-z] [--stdin] [-M] [-R] [-C] [-S<string>] [-m] [-s] [-v] [-t] <tree-ish> <tree-ish> [<pattern>]\*
+'git-diff-tree' [--stdin] [-m] [-s] [-v] [--pretty] [-t] [<common diff options>] <tree-ish> <tree-ish> [<path>...]
 
 DESCRIPTION
 -----------
@@ -19,40 +19,24 @@ Note that "git-diff-tree" can use the tree encapsulated in a commit object.
 
 OPTIONS
 -------
+include::diff-options.txt[]
+
 <tree-ish>::
        The id of a tree object.
 
-<pattern>::
+<path>...::
        If provided, the results are limited to a subset of files
        matching one of these prefix strings.
        ie file matches `/^<pattern1>|<pattern2>|.../`
-       Note that pattern does not provide any wildcard or regexp
+       Note that this parameter does not provide any wildcard or regexp
        features.
 
--p::
-       generate patch (see section on generating patches).  For
-       git-diff-tree, this flag implies '-r' as well.
-
--M::
-       Detect renames.
-
--C::
-       Detect copies as well as renames.
-
--R::
-       Output diff in reverse.
-
--S<string>::
-       Look for differences that contains the change in <string>.
-
--r::
-       recurse
-
 -t::
        show tree entry itself as well as subtrees.  Implies -r.
 
--z::
-       \0 line termination on output
+--root::
+       When '--root' is specified the initial commit will be showed as a big
+       creation event. This is equivalent to a diff against the NULL tree.
 
 --stdin::
        When '--stdin' is specified, the command does not take
@@ -80,6 +64,11 @@ separated with a single space are given.
        This flag causes "git-diff-tree --stdin" to also show
        the commit message before the differences.
 
+--pretty[=(raw|medium|short)]::
+       This is used to control "pretty printing" format of the
+       commit message.  Without "=<style>", it defaults to
+       medium.
+
 
 Limiting Output
 ---------------
@@ -97,7 +86,7 @@ Or if you are searching for what changed in just `kernel/sched.c`, just do
 and it will ignore all differences to other files.
 
 The pattern is always the prefix, and is matched exactly.  There are no
-wildcards.  Even stricter, it has to match complete path comonent.
+wildcards.  Even stricter, it has to match a complete path component.
 I.e. "foo" does not pick up `foobar.h`.  "foo" does match `foo/bar.h`
 so it can be used to name subdirectories.