[PATCH] Reformat git-show-branches-script documentation.
[git/dscho.git] / Documentation / git-diff-tree.txt
blob5ccf0ba1291d2175ef1bf9dea35ac174b59a24e6
1 git-diff-tree(1)
2 ================
3 v0.1, May 2005
5 NAME
6 ----
7 git-diff-tree - Compares the content and mode of blobs found via two tree objects
10 SYNOPSIS
11 --------
12 'git-diff-tree' [--stdin] [-m] [-s] [-v] [--pretty] [-t] [<common diff options>] <tree-ish> <tree-ish> [<path>...]
14 DESCRIPTION
15 -----------
16 Compares the content and mode of the blobs found via two tree objects.
18 Note that "git-diff-tree" can use the tree encapsulated in a commit object.
20 OPTIONS
21 -------
22 include::diff-options.txt[]
24 <tree-ish>::
25         The id of a tree object.
27 <path>...::
28         If provided, the results are limited to a subset of files
29         matching one of these prefix strings.
30         ie file matches `/^<pattern1>|<pattern2>|.../`
31         Note that this parameter does not provide any wildcard or regexp
32         features.
34 -t::
35         show tree entry itself as well as subtrees.  Implies -r.
37 --root::
38         When '--root' is specified the initial commit will be showed as a big
39         creation event. This is equivalent to a diff against the NULL tree.
41 --stdin::
42         When '--stdin' is specified, the command does not take
43         <tree-ish> arguments from the command line.  Instead, it
44         reads either one <commit> or a pair of <tree-ish>
45         separated with a single space from its standard input.
47 When a single commit is given on one line of such input, it compares
48 the commit with its parents.  The following flags further affects its
49 behaviour.  This does not apply to the case where two <tree-ish>
50 separated with a single space are given.
52 -m::
53         By default, "git-diff-tree --stdin" does not show
54         differences for merge commits.  With this flag, it shows
55         differences to that commit from all of its parents.
57 -s::
58         By default, "git-diff-tree --stdin" shows differences,
59         either in machine-readable form (without '-p') or in patch
60         form (with '-p').  This output can be supressed.  It is
61         only useful with '-v' flag.
63 -v::
64         This flag causes "git-diff-tree --stdin" to also show
65         the commit message before the differences.
67 --pretty[=(raw|medium|short)]::
68         This is used to control "pretty printing" format of the
69         commit message.  Without "=<style>", it defaults to
70         medium.
73 Limiting Output
74 ---------------
75 If you're only interested in differences in a subset of files, for
76 example some architecture-specific files, you might do:
78         git-diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64
80 and it will only show you what changed in those two directories.
82 Or if you are searching for what changed in just `kernel/sched.c`, just do
84         git-diff-tree -r <tree-ish> <tree-ish> kernel/sched.c
86 and it will ignore all differences to other files.
88 The pattern is always the prefix, and is matched exactly.  There are no
89 wildcards.  Even stricter, it has to match a complete path component.
90 I.e. "foo" does not pick up `foobar.h`.  "foo" does match `foo/bar.h`
91 so it can be used to name subdirectories.
93 An example of normal usage is:
95   torvalds@ppc970:~/git> git-diff-tree 5319e4......
96   *100664->100664 blob    ac348b.......->a01513.......      git-fsck-cache.c
98 which tells you that the last commit changed just one file (it's from
99 this one:
101   commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8
102   tree 5319e4d609cdd282069cc4dce33c1db559539b03
103   parent b4e628ea30d5ab3606119d2ea5caeab141d38df7
104   author Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
105   committer Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
107   Make "git-fsck-cache" print out all the root commits it finds.
109   Once I do the reference tracking, I'll also make it print out all the
110   HEAD commits it finds, which is even more interesting.
112 in case you care).
114 Output format
115 -------------
116 include::diff-format.txt[]
119 Author
120 ------
121 Written by Linus Torvalds <torvalds@osdl.org>
123 Documentation
124 --------------
125 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
129 Part of the link:git.html[git] suite