[PATCH] Docs - tag object, git- prefix and s/changeset/commit/g
[git/gitweb.git] / Documentation / git-diff-tree.txt
blobea680ccbfadb701d650e44ec58f2a72bc97fec44
1 git-diff-tree(1)
2 ================
3 v0.1, May 2005
5 NAME
6 ----
7 git-diff-tree - Compares the content and mode of blobs found via two tree objects
10 SYNOPSIS
11 --------
12 'git-diff-tree' [-p] [-r] [-z] [--stdin] [-M] [-R] [-C] [-S<string>] [-m] [-s] [-v] <tree-ish> <tree-ish> [<pattern>]\*
14 DESCRIPTION
15 -----------
16 Compares the content and mode of the blobs found via two tree objects.
18 Note that "git-diff-tree" can use the tree encapsulated in a commit object.
20 OPTIONS
21 -------
22 <tree-ish>::
23         The id of a tree object.
25 <pattern>::
26         If provided, the results are limited to a subset of files
27         matching one of these prefix strings.
28         ie file matches `/^<pattern1>|<pattern2>|.../`
29         Note that pattern does not provide any wildcard or regexp
30         features.
32 -p::
33         generate patch (see section on generating patches).  For
34         git-diff-tree, this flag implies '-r' as well.
36 -M::
37         Detect renames.
39 -C::
40         Detect copies as well as renames.
42 -R::
43         Output diff in reverse.
45 -S<string>::
46         Look for differences that contains the change in <string>.
48 -r::
49         recurse
51 -z::
52         \0 line termination on output
54 --stdin::
55         When '--stdin' is specified, the command does not take
56         <tree-ish> arguments from the command line.  Instead, it
57         reads either one <commit> or a pair of <tree-ish>
58         separated with a single space from its standard input.
60 When a single commit is given on one line of such input, it compares
61 the commit with its parents.  The following flags further affects its
62 behaviour.  This does not apply to the case where two <tree-ish>
63 separated with a single space are given.
65 -m::
66         By default, "git-diff-tree --stdin" does not show
67         differences for merge commits.  With this flag, it shows
68         differences to that commit from all of its parents.
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 supressed.  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.
81 Limiting Output
82 ---------------
83 If you're only interested in differences in a subset of files, for
84 example some architecture-specific files, you might do:
86         git-diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64
88 and it will only show you what changed in those two directories.
90 Or if you are searching for what changed in just `kernel/sched.c`, just do
92         git-diff-tree -r <tree-ish> <tree-ish> kernel/sched.c
94 and it will ignore all differences to other files.
96 The pattern is always the prefix, and is matched exactly.  There are no
97 wildcards.  Even stricter, it has to match complete path comonent.
98 I.e. "foo" does not pick up `foobar.h`.  "foo" does match `foo/bar.h`
99 so it can be used to name subdirectories.
101 An example of normal usage is:
103   torvalds@ppc970:~/git> git-diff-tree 5319e4......
104   *100664->100664 blob    ac348b.......->a01513.......      git-fsck-cache.c
106 which tells you that the last commit changed just one file (it's from
107 this one:
109   commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8
110   tree 5319e4d609cdd282069cc4dce33c1db559539b03
111   parent b4e628ea30d5ab3606119d2ea5caeab141d38df7
112   author Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
113   committer Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
115   Make "git-fsck-cache" print out all the root commits it finds.
117   Once I do the reference tracking, I'll also make it print out all the
118   HEAD commits it finds, which is even more interesting.
120 in case you care).
122 Output format
123 -------------
124 include::diff-format.txt[]
127 Author
128 ------
129 Written by Linus Torvalds <torvalds@osdl.org>
131 Documentation
132 --------------
133 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
137 Part of the link:git.html[git] suite