[PATCH] show changed tree objects with recursive git-diff-tree
[git.git] / Documentation / git-diff-tree.txt
1 git-diff-tree(1)
2 ================
3 v0.1, May 2005
4
5 NAME
6 ----
7 git-diff-tree - Compares the content and mode of blobs found via two tree objects
8
9
10 SYNOPSIS
11 --------
12 'git-diff-tree' [-p] [-r] [-z] [--stdin] [-M] [-R] [-C] [-S<string>] [-m] [-s] [-v] [-t] <tree-ish> <tree-ish> [<pattern>]\*
13
14 DESCRIPTION
15 -----------
16 Compares the content and mode of the blobs found via two tree objects.
17
18 Note that "git-diff-tree" can use the tree encapsulated in a commit object.
19
20 OPTIONS
21 -------
22 <tree-ish>::
23         The id of a tree object.
24
25 <pattern>::
26         If provided, the results are limited to a subset of files
27         matching one of these prefix strings.
28         ie file matches `/^<pattern1>|<pattern2>|.../`
29         Note that pattern does not provide any wildcard or regexp
30         features.
31
32 -p::
33         generate patch (see section on generating patches).  For
34         git-diff-tree, this flag implies '-r' as well.
35
36 -M::
37         Detect renames.
38
39 -C::
40         Detect copies as well as renames.
41
42 -R::
43         Output diff in reverse.
44
45 -S<string>::
46         Look for differences that contains the change in <string>.
47
48 -r::
49         recurse
50
51 -t::
52         show tree entry itself as well as subtrees.  Implies -r.
53
54 -z::
55         \0 line termination on output
56
57 --stdin::
58         When '--stdin' is specified, the command does not take
59         <tree-ish> arguments from the command line.  Instead, it
60         reads either one <commit> or a pair of <tree-ish>
61         separated with a single space from its standard input.
62 +
63 When a single commit is given on one line of such input, it compares
64 the commit with its parents.  The following flags further affects its
65 behaviour.  This does not apply to the case where two <tree-ish>
66 separated with a single space are given.
67
68 -m::
69         By default, "git-diff-tree --stdin" does not show
70         differences for merge commits.  With this flag, it shows
71         differences to that commit from all of its parents.
72
73 -s::
74         By default, "git-diff-tree --stdin" shows differences,
75         either in machine-readable form (without '-p') or in patch
76         form (with '-p').  This output can be supressed.  It is
77         only useful with '-v' flag.
78
79 -v::
80         This flag causes "git-diff-tree --stdin" to also show
81         the commit message before the differences.
82
83
84 Limiting Output
85 ---------------
86 If you're only interested in differences in a subset of files, for
87 example some architecture-specific files, you might do:
88
89         git-diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64
90
91 and it will only show you what changed in those two directories.
92
93 Or if you are searching for what changed in just `kernel/sched.c`, just do
94
95         git-diff-tree -r <tree-ish> <tree-ish> kernel/sched.c
96
97 and it will ignore all differences to other files.
98
99 The pattern is always the prefix, and is matched exactly.  There are no
100 wildcards.  Even stricter, it has to match complete path comonent.
101 I.e. "foo" does not pick up `foobar.h`.  "foo" does match `foo/bar.h`
102 so it can be used to name subdirectories.
103
104 An example of normal usage is:
105
106   torvalds@ppc970:~/git> git-diff-tree 5319e4......
107   *100664->100664 blob    ac348b.......->a01513.......      git-fsck-cache.c
108
109 which tells you that the last commit changed just one file (it's from
110 this one:
111
112   commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8
113   tree 5319e4d609cdd282069cc4dce33c1db559539b03
114   parent b4e628ea30d5ab3606119d2ea5caeab141d38df7
115   author Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
116   committer Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
117
118   Make "git-fsck-cache" print out all the root commits it finds.
119
120   Once I do the reference tracking, I'll also make it print out all the
121   HEAD commits it finds, which is even more interesting.
122
123 in case you care).
124
125 Output format
126 -------------
127 include::diff-format.txt[]
128
129
130 Author
131 ------
132 Written by Linus Torvalds <torvalds@osdl.org>
133
134 Documentation
135 --------------
136 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
137
138 GIT
139 ---
140 Part of the link:git.html[git] suite
141