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