gitweb: Fix escaping HTML of project owner in 'projects_list' and
[git/dscho.git] / Documentation / git-diff.txt
blob68e65324f87a691be9459957796761ff45898564
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 can be
66 any <tree-ish>.
68 For a more complete list of ways to spell <commit>, see
69 "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
70 However, "diff" is about comparing two _endpoints_, not ranges,
71 and the range notations ("<commit>..<commit>" and
72 "<commit>...<commit>") do not mean a range as defined in the
73 "SPECIFYING RANGES" section in gitlink:git-rev-parse[1].
75 OPTIONS
76 -------
77 include::diff-options.txt[]
79 <path>...::
80         The <paths> parameters, when given, are used to limit
81         the diff to the named paths (you can give directory
82         names and get diff for all files under them).
85 EXAMPLES
86 --------
88 Various ways to check your working tree::
90 ------------
91 $ git diff            <1>
92 $ git diff --cached   <2>
93 $ git diff HEAD       <3>
94 ------------
96 <1> Changes in the working tree not yet staged for the next commit.
97 <2> Changes between the index and your last commit; what you
98 would be committing if you run "git commit" without "-a" option.
99 <3> Changes in the working tree since your last commit; what you
100 would be committing if you run "git commit -a"
102 Comparing with arbitrary commits::
104 ------------
105 $ git diff test            <1>
106 $ git diff HEAD -- ./test  <2>
107 $ git diff HEAD^ HEAD      <3>
108 ------------
110 <1> Instead of using the tip of the current branch, compare with the
111 tip of "test" branch.
112 <2> Instead of comparing with the tip of "test" branch, compare with
113 the tip of the current branch, but limit the comparison to the
114 file "test".
115 <3> Compare the version before the last commit and the last commit.
117 Comparing branches::
119 ------------
120 $ git diff topic master    <1>
121 $ git diff topic..master   <2>
122 $ git diff topic...master  <3>
123 ------------
125 <1> Changes between the tips of the topic and the master branches.
126 <2> Same as above.
127 <3> Changes that occured on the master branch since when the topic
128 branch was started off it.
130 Limiting the diff output::
132 ------------
133 $ git diff --diff-filter=MRC            <1>
134 $ git diff --name-status                <2>
135 $ git diff arch/i386 include/asm-i386   <3>
136 ------------
138 <1> Show only modification, rename and copy, but not addition
139 nor deletion.
140 <2> Show only names and the nature of change, but not actual
141 diff output.
142 <3> Limit diff output to named subtrees.
144 Munging the diff output::
146 ------------
147 $ git diff --find-copies-harder -B -C  <1>
148 $ git diff -R                          <2>
149 ------------
151 <1> Spend extra cycles to find renames, copies and complete
152 rewrites (very expensive).
153 <2> Output diff in reverse.
156 Author
157 ------
158 Written by Linus Torvalds <torvalds@osdl.org>
160 Documentation
161 --------------
162 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
166 Part of the gitlink:git[7] suite