]> git.ipfire.org Git - thirdparty/git.git/blob - Documentation/git-diff.txt
git-add.txt: add missing short option -A to synopsis
[thirdparty/git.git] / Documentation / git-diff.txt
1 git-diff(1)
2 ===========
3
4 NAME
5 ----
6 git-diff - Show changes between commits, commit and working tree, etc
7
8
9 SYNOPSIS
10 --------
11 [verse]
12 'git diff' [<options>] [<commit>] [--] [<path>...]
13 'git diff' [<options>] --cached [--merge-base] [<commit>] [--] [<path>...]
14 'git diff' [<options>] [--merge-base] <commit> [<commit>...] <commit> [--] [<path>...]
15 'git diff' [<options>] <commit>...<commit> [--] [<path>...]
16 'git diff' [<options>] <blob> <blob>
17 'git diff' [<options>] --no-index [--] <path> <path>
18
19 DESCRIPTION
20 -----------
21 Show changes between the working tree and the index or a tree, changes
22 between the index and a tree, changes between two trees, changes resulting
23 from a merge, changes between two blob objects, or changes between two
24 files on disk.
25
26 'git diff' [<options>] [--] [<path>...]::
27
28 This form is to view the changes you made relative to
29 the index (staging area for the next commit). In other
30 words, the differences are what you _could_ tell Git to
31 further add to the index but you still haven't. You can
32 stage these changes by using linkgit:git-add[1].
33
34 'git diff' [<options>] --no-index [--] <path> <path>::
35
36 This form is to compare the given two paths on the
37 filesystem. You can omit the `--no-index` option when
38 running the command in a working tree controlled by Git and
39 at least one of the paths points outside the working tree,
40 or when running the command outside a working tree
41 controlled by Git. This form implies `--exit-code`.
42
43 'git diff' [<options>] --cached [--merge-base] [<commit>] [--] [<path>...]::
44
45 This form is to view the changes you staged for the next
46 commit relative to the named <commit>. Typically you
47 would want comparison with the latest commit, so if you
48 do not give <commit>, it defaults to HEAD.
49 If HEAD does not exist (e.g. unborn branches) and
50 <commit> is not given, it shows all staged changes.
51 --staged is a synonym of --cached.
52 +
53 If --merge-base is given, instead of using <commit>, use the merge base
54 of <commit> and HEAD. `git diff --cached --merge-base A` is equivalent to
55 `git diff --cached $(git merge-base A HEAD)`.
56
57 'git diff' [<options>] [--merge-base] <commit> [--] [<path>...]::
58
59 This form is to view the changes you have in your
60 working tree relative to the named <commit>. You can
61 use HEAD to compare it with the latest commit, or a
62 branch name to compare with the tip of a different
63 branch.
64 +
65 If --merge-base is given, instead of using <commit>, use the merge base
66 of <commit> and HEAD. `git diff --merge-base A` is equivalent to
67 `git diff $(git merge-base A HEAD)`.
68
69 'git diff' [<options>] [--merge-base] <commit> <commit> [--] [<path>...]::
70
71 This is to view the changes between two arbitrary
72 <commit>.
73 +
74 If --merge-base is given, use the merge base of the two commits for the
75 "before" side. `git diff --merge-base A B` is equivalent to
76 `git diff $(git merge-base A B) B`.
77
78 'git diff' [<options>] <commit> <commit>... <commit> [--] [<path>...]::
79
80 This form is to view the results of a merge commit. The first
81 listed <commit> must be the merge itself; the remaining two or
82 more commits should be its parents. Convenient ways to produce
83 the desired set of revisions are to use the suffixes `^@` and
84 `^!`. If A is a merge commit, then `git diff A A^@`,
85 `git diff A^!` and `git show A` all give the same combined diff.
86
87 'git diff' [<options>] <commit>..<commit> [--] [<path>...]::
88
89 This is synonymous to the earlier form (without the `..`) for
90 viewing the changes between two arbitrary <commit>. If <commit> on
91 one side is omitted, it will have the same effect as
92 using HEAD instead.
93
94 'git diff' [<options>] <commit>\...<commit> [--] [<path>...]::
95
96 This form is to view the changes on the branch containing
97 and up to the second <commit>, starting at a common ancestor
98 of both <commit>. `git diff A...B` is equivalent to
99 `git diff $(git merge-base A B) B`. You can omit any one
100 of <commit>, which has the same effect as using HEAD instead.
101
102 Just in case you are doing something exotic, it should be
103 noted that all of the <commit> in the above description, except
104 in the `--merge-base` case and in the last two forms that use `..`
105 notations, can be any <tree>.
106
107 For a more complete list of ways to spell <commit>, see
108 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
109 However, "diff" is about comparing two _endpoints_, not ranges,
110 and the range notations (`<commit>..<commit>` and
111 `<commit>...<commit>`) do not mean a range as defined in the
112 "SPECIFYING RANGES" section in linkgit:gitrevisions[7].
113
114 'git diff' [<options>] <blob> <blob>::
115
116 This form is to view the differences between the raw
117 contents of two blob objects.
118
119 OPTIONS
120 -------
121 :git-diff: 1
122 include::diff-options.txt[]
123
124 -1 --base::
125 -2 --ours::
126 -3 --theirs::
127 Compare the working tree with the "base" version (stage #1),
128 "our branch" (stage #2) or "their branch" (stage #3). The
129 index contains these stages only for unmerged entries i.e.
130 while resolving conflicts. See linkgit:git-read-tree[1]
131 section "3-Way Merge" for detailed information.
132
133 -0::
134 Omit diff output for unmerged entries and just show
135 "Unmerged". Can be used only when comparing the working tree
136 with the index.
137
138 <path>...::
139 The <paths> parameters, when given, are used to limit
140 the diff to the named paths (you can give directory
141 names and get diff for all files under them).
142
143
144 include::diff-format.txt[]
145
146 EXAMPLES
147 --------
148
149 Various ways to check your working tree::
150 +
151 ------------
152 $ git diff <1>
153 $ git diff --cached <2>
154 $ git diff HEAD <3>
155 ------------
156 +
157 <1> Changes in the working tree not yet staged for the next commit.
158 <2> Changes between the index and your last commit; what you
159 would be committing if you run `git commit` without `-a` option.
160 <3> Changes in the working tree since your last commit; what you
161 would be committing if you run `git commit -a`
162
163 Comparing with arbitrary commits::
164 +
165 ------------
166 $ git diff test <1>
167 $ git diff HEAD -- ./test <2>
168 $ git diff HEAD^ HEAD <3>
169 ------------
170 +
171 <1> Instead of using the tip of the current branch, compare with the
172 tip of "test" branch.
173 <2> Instead of comparing with the tip of "test" branch, compare with
174 the tip of the current branch, but limit the comparison to the
175 file "test".
176 <3> Compare the version before the last commit and the last commit.
177
178 Comparing branches::
179 +
180 ------------
181 $ git diff topic master <1>
182 $ git diff topic..master <2>
183 $ git diff topic...master <3>
184 ------------
185 +
186 <1> Changes between the tips of the topic and the master branches.
187 <2> Same as above.
188 <3> Changes that occurred on the master branch since when the topic
189 branch was started off it.
190
191 Limiting the diff output::
192 +
193 ------------
194 $ git diff --diff-filter=MRC <1>
195 $ git diff --name-status <2>
196 $ git diff arch/i386 include/asm-i386 <3>
197 ------------
198 +
199 <1> Show only modification, rename, and copy, but not addition
200 or deletion.
201 <2> Show only names and the nature of change, but not actual
202 diff output.
203 <3> Limit diff output to named subtrees.
204
205 Munging the diff output::
206 +
207 ------------
208 $ git diff --find-copies-harder -B -C <1>
209 $ git diff -R <2>
210 ------------
211 +
212 <1> Spend extra cycles to find renames, copies and complete
213 rewrites (very expensive).
214 <2> Output diff in reverse.
215
216 CONFIGURATION
217 -------------
218
219 include::includes/cmd-config-section-all.txt[]
220
221 include::config/diff.txt[]
222
223 SEE ALSO
224 --------
225 diff(1),
226 linkgit:git-difftool[1],
227 linkgit:git-log[1],
228 linkgit:gitdiffcore[7],
229 linkgit:git-format-patch[1],
230 linkgit:git-apply[1],
231 linkgit:git-show[1]
232
233 GIT
234 ---
235 Part of the linkgit:git[1] suite