cherry-pick/revert -m: add tests
[git/gitweb-caching.git] / Documentation / git-diff.txt
blobce0f5024687056b696fe5e77362a6f01b18dd0bd
1 git-diff(1)
2 ===========
4 NAME
5 ----
6 git-diff - Show changes between commits, commit and working tree, etc
9 SYNOPSIS
10 --------
11 'git-diff' [<common diff options>] <commit>{0,2} [--] [<path>...]
13 DESCRIPTION
14 -----------
15 Show changes between two trees, a tree and the working tree, a
16 tree and the index file, or the index file and the working tree.
18 'git-diff' [--options] [--] [<path>...]::
20         This form is to view the changes you made relative to
21         the index (staging area for the next commit).  In other
22         words, the differences are what you _could_ tell git to
23         further add to the index but you still haven't.  You can
24         stage these changes by using gitlink:git-add[1].
26 If exactly two paths are given, and at least one is untracked,
27 compare the two files / directories. This behavior can be
28 forced by --no-index.
30 'git-diff' [--options] --cached [<commit>] [--] [<path>...]::
32         This form is to view the changes you staged for the next
33         commit relative to the named <commit>.  Typically you
34         would want comparison with the latest commit, so if you
35         do not give <commit>, it defaults to HEAD.
37 'git-diff' [--options] <commit> [--] [<path>...]::
39         This form is to view the changes you have in your
40         working tree relative to the named <commit>.  You can
41         use HEAD to compare it with the latest commit, or a
42         branch name to compare with the tip of a different
43         branch.
45 'git-diff' [--options] <commit> <commit> [--] [<path>...]::
47         This is to view the changes between two arbitrary
48         <commit>.
50 'git-diff' [--options] <commit>..<commit> [--] [<path>...]::
52         This is synonymous to the previous form.  If <commit> on
53         one side is omitted, it will have the same effect as
54         using HEAD instead.
56 'git-diff' [--options] <commit>\...<commit> [--] [<path>...]::
58         This form is to view the changes on the branch containing
59         and up to the second <commit>, starting at a common ancestor
60         of both <commit>.  "git-diff A\...B" is equivalent to
61         "git-diff $(git-merge-base A B) B".  You can omit any one
62         of <commit>, which has the same effect as using HEAD instead.
64 Just in case if you are doing something exotic, it should be
65 noted that all of the <commit> in the above description, except
66 for the last two forms that use ".." notations, can be any
67 <tree-ish>.
69 For a more complete list of ways to spell <commit>, see
70 "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
71 However, "diff" is about comparing two _endpoints_, not ranges,
72 and the range notations ("<commit>..<commit>" and
73 "<commit>\...<commit>") do not mean a range as defined in the
74 "SPECIFYING RANGES" section in gitlink:git-rev-parse[1].
76 OPTIONS
77 -------
78 include::diff-options.txt[]
80 <path>...::
81         The <paths> parameters, when given, are used to limit
82         the diff to the named paths (you can give directory
83         names and get diff for all files under them).
86 EXAMPLES
87 --------
89 Various ways to check your working tree::
91 ------------
92 $ git diff            <1>
93 $ git diff --cached   <2>
94 $ git diff HEAD       <3>
95 ------------
97 <1> Changes in the working tree not yet staged for the next commit.
98 <2> Changes between the index and your last commit; what you
99 would be committing if you run "git commit" without "-a" option.
100 <3> Changes in the working tree since your last commit; what you
101 would be committing if you run "git commit -a"
103 Comparing with arbitrary commits::
105 ------------
106 $ git diff test            <1>
107 $ git diff HEAD -- ./test  <2>
108 $ git diff HEAD^ HEAD      <3>
109 ------------
111 <1> Instead of using the tip of the current branch, compare with the
112 tip of "test" branch.
113 <2> Instead of comparing with the tip of "test" branch, compare with
114 the tip of the current branch, but limit the comparison to the
115 file "test".
116 <3> Compare the version before the last commit and the last commit.
118 Comparing branches::
120 ------------
121 $ git diff topic master    <1>
122 $ git diff topic..master   <2>
123 $ git diff topic...master  <3>
124 ------------
126 <1> Changes between the tips of the topic and the master branches.
127 <2> Same as above.
128 <3> Changes that occurred on the master branch since when the topic
129 branch was started off it.
131 Limiting the diff output::
133 ------------
134 $ git diff --diff-filter=MRC            <1>
135 $ git diff --name-status                <2>
136 $ git diff arch/i386 include/asm-i386   <3>
137 ------------
139 <1> Show only modification, rename and copy, but not addition
140 nor deletion.
141 <2> Show only names and the nature of change, but not actual
142 diff output.
143 <3> Limit diff output to named subtrees.
145 Munging the diff output::
147 ------------
148 $ git diff --find-copies-harder -B -C  <1>
149 $ git diff -R                          <2>
150 ------------
152 <1> Spend extra cycles to find renames, copies and complete
153 rewrites (very expensive).
154 <2> Output diff in reverse.
157 Author
158 ------
159 Written by Linus Torvalds <torvalds@osdl.org>
161 Documentation
162 --------------
163 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
167 Part of the gitlink:git[7] suite