blob: 9153e4cf2a1020dc9a3b5792ff3f64f7efd9f42c [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231git-diff-tree(1)
2================
3
4NAME
5----
6git-diff-tree - Compares the content and mode of blobs found via two tree objects
7
8
9SYNOPSIS
10--------
Junio C Hamano235a91e2006-01-07 01:13:5811[verse]
Junio C Hamanofb56a962006-01-28 10:38:1912'git-diff-tree' [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty]
13 [-t] [-r] [-c | --cc] [--root] [<common diff options>]
14 <tree-ish> [<tree-ish>] [<path>...]
Junio C Hamano1a4e8412005-12-27 08:17:2315
16DESCRIPTION
17-----------
18Compares the content and mode of the blobs found via two tree objects.
19
20If there is only one <tree-ish> given, the commit is compared with its parents
21(see --stdin below).
22
23Note that "git-diff-tree" can use the tree encapsulated in a commit object.
24
25OPTIONS
26-------
27include::diff-options.txt[]
28
29<tree-ish>::
30The id of a tree object.
31
32<path>...::
33If provided, the results are limited to a subset of files
34matching one of these prefix strings.
35ie file matches `/^<pattern1>|<pattern2>|.../`
36Note that this parameter does not provide any wildcard or regexp
37features.
38
39-r::
40 recurse into sub-trees
41
42-t::
43show tree entry itself as well as subtrees. Implies -r.
44
45--root::
46When '--root' is specified the initial commit will be showed as a big
47creation event. This is equivalent to a diff against the NULL tree.
48
49--stdin::
50When '--stdin' is specified, the command does not take
51<tree-ish> arguments from the command line. Instead, it
52reads either one <commit> or a pair of <tree-ish>
53separated with a single space from its standard input.
54+
55When a single commit is given on one line of such input, it compares
56the commit with its parents. The following flags further affects its
57behaviour. This does not apply to the case where two <tree-ish>
58separated with a single space are given.
59
60-m::
61By default, "git-diff-tree --stdin" does not show
62differences for merge commits. With this flag, it shows
63differences to that commit from all of its parents.
64
65-s::
66By default, "git-diff-tree --stdin" shows differences,
67either in machine-readable form (without '-p') or in patch
Junio C Hamano235a91e2006-01-07 01:13:5868form (with '-p'). This output can be suppressed. It is
Junio C Hamano1a4e8412005-12-27 08:17:2369only useful with '-v' flag.
70
71-v::
72This flag causes "git-diff-tree --stdin" to also show
73the commit message before the differences.
74
75--pretty[=(raw|medium|short)]::
76This is used to control "pretty printing" format of the
77commit message. Without "=<style>", it defaults to
78medium.
79
80--no-commit-id::
81git-diff-tree outputs a line with the commit ID when
82applicable. This flag suppressed the commit ID output.
83
Junio C Hamanofb56a962006-01-28 10:38:1984-c,--cc::
85These flags change the way a merge commit is displayed
86(which means it is useful only when the command is given
87one <tree-ish>, or '--stdin'). It shows the differences
88from each of the parents to the merge result
89simultaneously, instead of showing pairwise diff between
90a parent and the result one at a time, which '-m' option
91output does. '--cc' further compresses the output by
92omiting hunks that show differences from only one
93parent, or show the same change from all but one parent
94for an Octopus merge. When this optimization makes all
95hunks disappear, the commit itself and the commit log
Junio C Hamano1b6885b2006-02-02 23:50:1896message is not shown, just like any other "empty diff" cases.
Junio C Hamanofb56a962006-01-28 10:38:1997
Junio C Hamanod9d71c02006-02-08 00:52:3398--always::
99Show the commit itself and the commit log message even
100if the diff itself is empty.
101
Junio C Hamano1a4e8412005-12-27 08:17:23102
103Limiting Output
104---------------
105If you're only interested in differences in a subset of files, for
106example some architecture-specific files, you might do:
107
108git-diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64
109
110and it will only show you what changed in those two directories.
111
112Or if you are searching for what changed in just `kernel/sched.c`, just do
113
114git-diff-tree -r <tree-ish> <tree-ish> kernel/sched.c
115
116and it will ignore all differences to other files.
117
118The pattern is always the prefix, and is matched exactly. There are no
119wildcards. Even stricter, it has to match a complete path component.
120I.e. "foo" does not pick up `foobar.h`. "foo" does match `foo/bar.h`
121so it can be used to name subdirectories.
122
123An example of normal usage is:
124
125 torvalds@ppc970:~/git> git-diff-tree 5319e4......
126 *100664->100664 blob ac348b.......->a01513....... git-fsck-objects.c
127
128which tells you that the last commit changed just one file (it's from
129this one:
130
131-----------------------------------------------------------------------------
132commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8
133tree 5319e4d609cdd282069cc4dce33c1db559539b03
134parent b4e628ea30d5ab3606119d2ea5caeab141d38df7
135author Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
136committer Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
137
138Make "git-fsck-objects" print out all the root commits it finds.
139
140Once I do the reference tracking, I'll also make it print out all the
141HEAD commits it finds, which is even more interesting.
142-----------------------------------------------------------------------------
143
144in case you care).
145
146Output format
147-------------
148include::diff-format.txt[]
149
150
151Author
152------
153Written by Linus Torvalds <torvalds@osdl.org>
154
155Documentation
156--------------
157Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
158
159GIT
160---
161Part of the gitlink:git[7] suite
162