More useful/hinting error messages in git-checkout
[git/repo.git] / Documentation / git-diff-tree.txt
blob9153e4cf2a1020dc9a3b5792ff3f64f7efd9f42c
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         ie 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 behaviour.  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.
65 -s::
66         By default, "git-diff-tree --stdin" shows differences,
67         either in machine-readable form (without '-p') or in patch
68         form (with '-p').  This output can be suppressed.  It is
69         only useful with '-v' flag.
71 -v::
72         This flag causes "git-diff-tree --stdin" to also show
73         the commit message before the differences.
75 --pretty[=(raw|medium|short)]::
76         This is used to control "pretty printing" format of the
77         commit message.  Without "=<style>", it defaults to
78         medium.
80 --no-commit-id::
81         git-diff-tree outputs a line with the commit ID when
82         applicable.  This flag suppressed the commit ID output.
84 -c,--cc::
85         These flags change the way a merge commit is displayed
86         (which means it is useful only when the command is given
87         one <tree-ish>, or '--stdin').  It shows the differences
88         from each of the parents to the merge result
89         simultaneously, instead of showing pairwise diff between
90         a parent and the result one at a time, which '-m' option
91         output does.  '--cc' further compresses the output by
92         omiting hunks that show differences from only one
93         parent, or show the same change from all but one parent
94         for an Octopus merge.  When this optimization makes all
95         hunks disappear, the commit itself and the commit log
96         message is not shown, just like any other "empty diff" cases.
98 --always::
99         Show the commit itself and the commit log message even
100         if the diff itself is empty.
103 Limiting Output
104 ---------------
105 If you're only interested in differences in a subset of files, for
106 example some architecture-specific files, you might do:
108         git-diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64
110 and it will only show you what changed in those two directories.
112 Or if you are searching for what changed in just `kernel/sched.c`, just do
114         git-diff-tree -r <tree-ish> <tree-ish> kernel/sched.c
116 and it will ignore all differences to other files.
118 The pattern is always the prefix, and is matched exactly.  There are no
119 wildcards.  Even stricter, it has to match a complete path component.
120 I.e. "foo" does not pick up `foobar.h`.  "foo" does match `foo/bar.h`
121 so it can be used to name subdirectories.
123 An example of normal usage is:
125   torvalds@ppc970:~/git> git-diff-tree 5319e4......
126   *100664->100664 blob    ac348b.......->a01513.......      git-fsck-objects.c
128 which tells you that the last commit changed just one file (it's from
129 this one:
131 -----------------------------------------------------------------------------
132 commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8
133 tree 5319e4d609cdd282069cc4dce33c1db559539b03
134 parent b4e628ea30d5ab3606119d2ea5caeab141d38df7
135 author Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
136 committer Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
138 Make "git-fsck-objects" print out all the root commits it finds.
140 Once I do the reference tracking, I'll also make it print out all the
141 HEAD commits it finds, which is even more interesting.
142 -----------------------------------------------------------------------------
144 in case you care).
146 Output format
147 -------------
148 include::diff-format.txt[]
151 Author
152 ------
153 Written by Linus Torvalds <torvalds@osdl.org>
155 Documentation
156 --------------
157 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
161 Part of the gitlink:git[7] suite