Code

diff-tree: Note that the commit ID is printed with --stdin
[git.git] / Documentation / git-diff-tree.txt
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]
13               [-t] [-r] [-c | --cc] [--root] [<common diff options>]
14               <tree-ish> [<tree-ish>] [<path>...]
16 DESCRIPTION
17 -----------
18 Compares the content and mode of the blobs found via two tree objects.
20 If there is only one <tree-ish> given, the commit is compared with its parents
21 (see --stdin below).
23 Note that 'git-diff-tree' can use the tree encapsulated in a commit object.
25 OPTIONS
26 -------
27 include::diff-options.txt[]
29 <tree-ish>::
30         The id of a tree object.
32 <path>...::
33         If provided, the results are limited to a subset of files
34         matching one of these prefix strings.
35         i.e., file matches `/^<pattern1>|<pattern2>|.../`
36         Note that this parameter does not provide any wildcard or regexp
37         features.
39 -r::
40         recurse into sub-trees
42 -t::
43         show tree entry itself as well as subtrees.  Implies -r.
45 --root::
46         When '--root' is specified the initial commit will be showed as a big
47         creation event. This is equivalent to a diff against the NULL tree.
49 --stdin::
50         When '--stdin' is specified, the command does not take
51         <tree-ish> arguments from the command line.  Instead, it
52         reads either one <commit> or a list of <commit>
53         separated with a single space from its standard input.
54 +
55 When a single commit is given, it compares the commit with its
56 parents.  The remaining commits, when given, are used as if they are
57 parents of the first commit.
58 +
59 The ID of the first (or only) commit, followed by a newline, is
60 printed before the differences.
61 +
62 The following flags further affects its behavior.
64 -m::
65         By default, 'git-diff-tree --stdin' does not show
66         differences for merge commits.  With this flag, it shows
67         differences to that commit from all of its parents. See
68         also '-c'.
70 -s::
71         By default, 'git-diff-tree --stdin' shows differences,
72         either in machine-readable form (without '-p') or in patch
73         form (with '-p').  This output can be suppressed.  It is
74         only useful with '-v' flag.
76 -v::
77         This flag causes 'git-diff-tree --stdin' to also show
78         the commit message before the differences.
80 include::pretty-options.txt[]
82 --no-commit-id::
83         'git-diff-tree' outputs a line with the commit ID when
84         applicable.  This flag suppressed the commit ID output.
86 -c::
87         This flag changes the way a merge commit is displayed
88         (which means it is useful only when the command is given
89         one <tree-ish>, or '--stdin').  It shows the differences
90         from each of the parents to the merge result simultaneously
91         instead of showing pairwise diff between a parent and the
92         result one at a time (which is what the '-m' option does).
93         Furthermore, it lists only files which were modified
94         from all parents.
96 --cc::
97         This flag changes the way a merge commit patch is displayed,
98         in a similar way to the '-c' option. It implies the '-c'
99         and '-p' options and further compresses the patch output
100         by omitting uninteresting hunks whose the contents in the parents
101         have only two variants and the merge result picks one of them
102         without modification.  When all hunks are uninteresting, the commit
103         itself and the commit log message is not shown, just like in any other
104         "empty diff" case.
106 --always::
107         Show the commit itself and the commit log message even
108         if the diff itself is empty.
111 include::pretty-formats.txt[]
114 Limiting Output
115 ---------------
116 If you're only interested in differences in a subset of files, for
117 example some architecture-specific files, you might do:
119         git diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64
121 and it will only show you what changed in those two directories.
123 Or if you are searching for what changed in just `kernel/sched.c`, just do
125         git diff-tree -r <tree-ish> <tree-ish> kernel/sched.c
127 and it will ignore all differences to other files.
129 The pattern is always the prefix, and is matched exactly.  There are no
130 wildcards.  Even stricter, it has to match a complete path component.
131 I.e. "foo" does not pick up `foobar.h`.  "foo" does match `foo/bar.h`
132 so it can be used to name subdirectories.
134 An example of normal usage is:
136   torvalds@ppc970:~/git> git diff-tree 5319e4......
137   *100664->100664 blob    ac348b.......->a01513.......      git-fsck-objects.c
139 which tells you that the last commit changed just one file (it's from
140 this one:
142 -----------------------------------------------------------------------------
143 commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8
144 tree 5319e4d609cdd282069cc4dce33c1db559539b03
145 parent b4e628ea30d5ab3606119d2ea5caeab141d38df7
146 author Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
147 committer Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
149 Make "git-fsck-objects" print out all the root commits it finds.
151 Once I do the reference tracking, I'll also make it print out all the
152 HEAD commits it finds, which is even more interesting.
153 -----------------------------------------------------------------------------
155 in case you care).
157 Output format
158 -------------
159 include::diff-format.txt[]
162 Author
163 ------
164 Written by Linus Torvalds <torvalds@osdl.org>
166 Documentation
167 --------------
168 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
170 GIT
171 ---
172 Part of the linkgit:git[1] suite