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