Documentation/git-submodule.txt: Further clarify the description
[git/vmiklos.git] / Documentation / git-diff-tree.txt
blob0e45b58d8332cc9f48e0e18165f536adb94a5c6f
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 pair of <tree-ish>
53         separated with a single space from its standard input.
55 When a single commit is given on one line of such input, it compares
56 the commit with its parents.  The following flags further affects its
57 behavior.  This does not apply to the case where two <tree-ish>
58 separated with a single space are given.
60 -m::
61         By default, 'git-diff-tree --stdin' does not show
62         differences for merge commits.  With this flag, it shows
63         differences to that commit from all of its parents. See
64         also '-c'.
66 -s::
67         By default, 'git-diff-tree --stdin' shows differences,
68         either in machine-readable form (without '-p') or in patch
69         form (with '-p').  This output can be suppressed.  It is
70         only useful with '-v' flag.
72 -v::
73         This flag causes 'git-diff-tree --stdin' to also show
74         the commit message before the differences.
76 include::pretty-options.txt[]
78 --no-commit-id::
79         'git-diff-tree' outputs a line with the commit ID when
80         applicable.  This flag suppressed the commit ID output.
82 -c::
83         This flag changes the way a merge commit is displayed
84         (which means it is useful only when the command is given
85         one <tree-ish>, or '--stdin').  It shows the differences
86         from each of the parents to the merge result simultaneously
87         instead of showing pairwise diff between a parent and the
88         result one at a time (which is what the '-m' option does).
89         Furthermore, it lists only files which were modified
90         from all parents.
92 --cc::
93         This flag changes the way a merge commit patch is displayed,
94         in a similar way to the '-c' option. It implies the '-c'
95         and '-p' options and further compresses the patch output
96         by omitting hunks that show differences from only one
97         parent, or show the same change from all but one parent
98         for an Octopus merge.  When this optimization makes all
99         hunks disappear, the commit itself and the commit log
100         message is not shown, just like in any other "empty diff" case.
102 --always::
103         Show the commit itself and the commit log message even
104         if the diff itself is empty.
107 include::pretty-formats.txt[]
110 Limiting Output
111 ---------------
112 If you're only interested in differences in a subset of files, for
113 example some architecture-specific files, you might do:
115         git diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64
117 and it will only show you what changed in those two directories.
119 Or if you are searching for what changed in just `kernel/sched.c`, just do
121         git diff-tree -r <tree-ish> <tree-ish> kernel/sched.c
123 and it will ignore all differences to other files.
125 The pattern is always the prefix, and is matched exactly.  There are no
126 wildcards.  Even stricter, it has to match a complete path component.
127 I.e. "foo" does not pick up `foobar.h`.  "foo" does match `foo/bar.h`
128 so it can be used to name subdirectories.
130 An example of normal usage is:
132   torvalds@ppc970:~/git> git diff-tree 5319e4......
133   *100664->100664 blob    ac348b.......->a01513.......      git-fsck-objects.c
135 which tells you that the last commit changed just one file (it's from
136 this one:
138 -----------------------------------------------------------------------------
139 commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8
140 tree 5319e4d609cdd282069cc4dce33c1db559539b03
141 parent b4e628ea30d5ab3606119d2ea5caeab141d38df7
142 author Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
143 committer Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
145 Make "git-fsck-objects" print out all the root commits it finds.
147 Once I do the reference tracking, I'll also make it print out all the
148 HEAD commits it finds, which is even more interesting.
149 -----------------------------------------------------------------------------
151 in case you care).
153 Output format
154 -------------
155 include::diff-format.txt[]
158 Author
159 ------
160 Written by Linus Torvalds <torvalds@osdl.org>
162 Documentation
163 --------------
164 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
168 Part of the linkgit:git[1] suite