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