[PATCH] Add -B flag to diff-* brothers.
[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] [-B] [-M] [-R] [-C] [-S<string>] [--pickaxe-all] [-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 -B::
37         Break complete rewrite changes into pairs of delete and create.
38
39 -M::
40         Detect renames.
41
42 -C::
43         Detect copies as well as renames.
44
45 -R::
46         Output diff in reverse.
47
48 -S<string>::
49         Look for differences that contains the change in <string>.
50
51 --pickaxe-all::
52         When -S finds a change, show all the changes in that
53         changeset, not just the files that contains the change
54         in <string>.
55
56 -r::
57         recurse
58
59 -t::
60         show tree entry itself as well as subtrees.  Implies -r.
61
62 -z::
63         \0 line termination on output
64
65 --root::
66         When '--root' is specified the initial commit will be showed as a big
67         creation event. This is equivalent to a diff against the NULL tree.
68
69 --stdin::
70         When '--stdin' is specified, the command does not take
71         <tree-ish> arguments from the command line.  Instead, it
72         reads either one <commit> or a pair of <tree-ish>
73         separated with a single space from its standard input.
74 +
75 When a single commit is given on one line of such input, it compares
76 the commit with its parents.  The following flags further affects its
77 behaviour.  This does not apply to the case where two <tree-ish>
78 separated with a single space are given.
79
80 -m::
81         By default, "git-diff-tree --stdin" does not show
82         differences for merge commits.  With this flag, it shows
83         differences to that commit from all of its parents.
84
85 -s::
86         By default, "git-diff-tree --stdin" shows differences,
87         either in machine-readable form (without '-p') or in patch
88         form (with '-p').  This output can be supressed.  It is
89         only useful with '-v' flag.
90
91 -v::
92         This flag causes "git-diff-tree --stdin" to also show
93         the commit message before the differences.
94
95
96 Limiting Output
97 ---------------
98 If you're only interested in differences in a subset of files, for
99 example some architecture-specific files, you might do:
100
101         git-diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64
102
103 and it will only show you what changed in those two directories.
104
105 Or if you are searching for what changed in just `kernel/sched.c`, just do
106
107         git-diff-tree -r <tree-ish> <tree-ish> kernel/sched.c
108
109 and it will ignore all differences to other files.
110
111 The pattern is always the prefix, and is matched exactly.  There are no
112 wildcards.  Even stricter, it has to match complete path comonent.
113 I.e. "foo" does not pick up `foobar.h`.  "foo" does match `foo/bar.h`
114 so it can be used to name subdirectories.
115
116 An example of normal usage is:
117
118   torvalds@ppc970:~/git> git-diff-tree 5319e4......
119   *100664->100664 blob    ac348b.......->a01513.......      git-fsck-cache.c
120
121 which tells you that the last commit changed just one file (it's from
122 this one:
123
124   commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8
125   tree 5319e4d609cdd282069cc4dce33c1db559539b03
126   parent b4e628ea30d5ab3606119d2ea5caeab141d38df7
127   author Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
128   committer Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
129
130   Make "git-fsck-cache" print out all the root commits it finds.
131
132   Once I do the reference tracking, I'll also make it print out all the
133   HEAD commits it finds, which is even more interesting.
134
135 in case you care).
136
137 Output format
138 -------------
139 include::diff-format.txt[]
140
141
142 Author
143 ------
144 Written by Linus Torvalds <torvalds@osdl.org>
145
146 Documentation
147 --------------
148 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
149
150 GIT
151 ---
152 Part of the link:git.html[git] suite
153