Allow adding arbitary lines in the mail header generated by format-patch.
[git/fastimport.git] / Documentation / git-diff.txt
blobca4163402261f1d381750bc5317d5e405f72a91c
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' [ --diff-options ] <ent>{0,2} [<path>...]
13 DESCRIPTION
14 -----------
15 Show changes between two ents, an ent and the working tree, an
16 ent and the index file, or the index file and the working tree.
17 The combination of what is compared with what is determined by
18 the number of ents given to the command.
20 * When no <ent> is given, the working tree and the index
21   file is compared, using `git-diff-files`.
23 * When one <ent> is given, the working tree and the named
24   tree is compared, using `git-diff-index`.  The option
25   `--cached` can be given to compare the index file and
26   the named tree.
28 * When two <ent>s are given, these two trees are compared
29   using `git-diff-tree`.
31 OPTIONS
32 -------
33 --diff-options::
34         '--diff-options' are passed to the `git-diff-files`,
35         `git-diff-index`, and `git-diff-tree` commands.  See the
36         documentation for these commands for description.
38 <path>...::
39         The <path> arguments are also passed to `git-diff-\*`
40         commands.
43 EXAMPLES
44 --------
46 Various ways to check your working tree::
48 ------------
49 $ git diff <1>
50 $ git diff --cached <2>
51 $ git diff HEAD <3>
53 <1> changes in the working tree since your last git-update-index.
54 <2> changes between the index and your last commit; what you
55 would be committing if you run "git commit" without "-a" option.
56 <3> changes in the working tree since your last commit; what you
57 would be committing if you run "git commit -a"
58 ------------
60 Comparing with arbitrary commits::
62 ------------
63 $ git diff test <1>
64 $ git diff HEAD -- ./test <2>
65 $ git diff HEAD^ HEAD <3>
67 <1> instead of using the tip of the current branch, compare with the
68 tip of "test" branch.
69 <2> instead of comparing with the tip of "test" branch, compare with
70 the tip of the current branch, but limit the comparison to the
71 file "test".
72 <3> compare the version before the last commit and the last commit.
73 ------------
76 Limiting the diff output::
78 ------------
79 $ git diff --diff-filter=MRC <1>
80 $ git diff --name-status -r <2>
81 $ git diff arch/i386 include/asm-i386 <3>
83 <1> show only modification, rename and copy, but not addition
84 nor deletion.
85 <2> show only names and the nature of change, but not actual
86 diff output.  --name-status disables usual patch generation
87 which in turn also disables recursive behaviour, so without -r
88 you would only see the directory name if there is a change in a
89 file in a subdirectory.
90 <3> limit diff output to named subtrees.
91 ------------
93 Munging the diff output::
95 ------------
96 $ git diff --find-copies-harder -B -C <1>
97 $ git diff -R <2>
99 <1> spend extra cycles to find renames, copies and complete
100 rewrites (very expensive).
101 <2> output diff in reverse.
102 ------------
105 Author
106 ------
107 Written by Linus Torvalds <torvalds@osdl.org>
109 Documentation
110 --------------
111 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
115 Part of the gitlink:git[7] suite