[PATCH] Bugfix: initialize pack_base to NULL.
[git/jrn.git] / Documentation / git-diff-tree.txt
blobab0ba4fb1708042bce516ed6f9e22db55672736c
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' [-p] [-r] [-z] [--stdin] [-m] [-s] [-v] [-t] [-R] [-B] [-M] [-C] [--find-copies-harder] [-O<orderfile>] [-S<string>] [--pickaxe-all] <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 <tree-ish>::
23         The id of a tree object.
25 <path>...::
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 this parameter does not provide any wildcard or regexp
30         features.
32 -p::
33         generate patch (see section on generating patches).  For
34         git-diff-tree, this flag implies '-r' as well.
36 -B::
37         Break complete rewrite changes into pairs of delete and create.
39 -M::
40         Detect renames.
42 -C::
43         Detect copies as well as renames.
45 --find-copies-harder::
46         By default, -C option finds copies only if the original
47         file of the copy was modified in the same changeset for
48         performance reasons.  This flag makes the command
49         inspect unmodified files as candidates for the source of
50         copy.  This is a very expensive operation for large
51         projects, so use it with caution.
53 -R::
54         Swap two input trees.
56 -S<string>::
57         Look for differences that contains the change in <string>.
59 --pickaxe-all::
60         When -S finds a change, show all the changes in that
61         changeset, not just the files that contains the change
62         in <string>.
64 -O<orderfile>::
65         Output the patch in the order specified in the
66         <orderfile>, which has one shell glob pattern per line.
68 -r::
69         recurse
71 -t::
72         show tree entry itself as well as subtrees.  Implies -r.
74 -z::
75         \0 line termination on output
77 --root::
78         When '--root' is specified the initial commit will be showed as a big
79         creation event. This is equivalent to a diff against the NULL tree.
81 --stdin::
82         When '--stdin' is specified, the command does not take
83         <tree-ish> arguments from the command line.  Instead, it
84         reads either one <commit> or a pair of <tree-ish>
85         separated with a single space from its standard input.
87 When a single commit is given on one line of such input, it compares
88 the commit with its parents.  The following flags further affects its
89 behaviour.  This does not apply to the case where two <tree-ish>
90 separated with a single space are given.
92 -m::
93         By default, "git-diff-tree --stdin" does not show
94         differences for merge commits.  With this flag, it shows
95         differences to that commit from all of its parents.
97 -s::
98         By default, "git-diff-tree --stdin" shows differences,
99         either in machine-readable form (without '-p') or in patch
100         form (with '-p').  This output can be supressed.  It is
101         only useful with '-v' flag.
103 -v::
104         This flag causes "git-diff-tree --stdin" to also show
105         the commit message before the differences.
107 --pretty[=(raw|medium|short)]::
108         This is used to control "pretty printing" format of the
109         commit message.  Without "=<style>", it defaults to
110         medium.
113 Limiting Output
114 ---------------
115 If you're only interested in differences in a subset of files, for
116 example some architecture-specific files, you might do:
118         git-diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64
120 and it will only show you what changed in those two directories.
122 Or if you are searching for what changed in just `kernel/sched.c`, just do
124         git-diff-tree -r <tree-ish> <tree-ish> kernel/sched.c
126 and it will ignore all differences to other files.
128 The pattern is always the prefix, and is matched exactly.  There are no
129 wildcards.  Even stricter, it has to match complete path comonent.
130 I.e. "foo" does not pick up `foobar.h`.  "foo" does match `foo/bar.h`
131 so it can be used to name subdirectories.
133 An example of normal usage is:
135   torvalds@ppc970:~/git> git-diff-tree 5319e4......
136   *100664->100664 blob    ac348b.......->a01513.......      git-fsck-cache.c
138 which tells you that the last commit changed just one file (it's from
139 this one:
141   commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8
142   tree 5319e4d609cdd282069cc4dce33c1db559539b03
143   parent b4e628ea30d5ab3606119d2ea5caeab141d38df7
144   author Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
145   committer Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
147   Make "git-fsck-cache" print out all the root commits it finds.
149   Once I do the reference tracking, I'll also make it print out all the
150   HEAD commits it finds, which is even more interesting.
152 in case you care).
154 Output format
155 -------------
156 include::diff-format.txt[]
159 Author
160 ------
161 Written by Linus Torvalds <torvalds@osdl.org>
163 Documentation
164 --------------
165 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
169 Part of the link:git.html[git] suite