Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 1 | git-diff(1) |
| 2 | =========== |
| 3 | |
| 4 | NAME |
| 5 | ---- |
Junio C Hamano | 0107892 | 2006-03-10 00:31:47 | [diff] [blame] | 6 | git-diff - Show changes between commits, commit and working tree, etc |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 7 | |
| 8 | |
| 9 | SYNOPSIS |
| 10 | -------- |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame^] | 11 | 'git diff' [<common diff options>] <commit>{0,2} [--] [<path>...] |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 12 | |
| 13 | DESCRIPTION |
| 14 | ----------- |
Junio C Hamano | 51c2ab0 | 2006-07-09 20:38:54 | [diff] [blame] | 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. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 17 | |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame^] | 18 | 'git diff' [--options] [--] [<path>...]:: |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 19 | |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 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 |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 24 | stage these changes by using linkgit:git-add[1]. |
Junio C Hamano | c435b1c | 2007-08-28 06:25:35 | [diff] [blame] | 25 | + |
| 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. |
Junio C Hamano | db911ee | 2007-02-28 08:13:52 | [diff] [blame] | 29 | |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame^] | 30 | 'git diff' [--options] --cached [<commit>] [--] [<path>...]:: |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 31 | |
| 32 | This form is to view the changes you staged for the next |
Junio C Hamano | 4bf6dca | 2006-12-21 02:25:57 | [diff] [blame] | 33 | commit relative to the named <commit>. Typically you |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 34 | would want comparison with the latest commit, so if you |
| 35 | do not give <commit>, it defaults to HEAD. |
| 36 | |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame^] | 37 | 'git diff' [--options] <commit> [--] [<path>...]:: |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 38 | |
| 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. |
| 44 | |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame^] | 45 | 'git diff' [--options] <commit> <commit> [--] [<path>...]:: |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 46 | |
Junio C Hamano | c435b1c | 2007-08-28 06:25:35 | [diff] [blame] | 47 | This is to view the changes between two arbitrary |
| 48 | <commit>. |
| 49 | |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame^] | 50 | 'git diff' [--options] <commit>..<commit> [--] [<path>...]:: |
Junio C Hamano | c435b1c | 2007-08-28 06:25:35 | [diff] [blame] | 51 | |
| 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. |
| 55 | |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame^] | 56 | 'git diff' [--options] <commit>\...<commit> [--] [<path>...]:: |
Junio C Hamano | c435b1c | 2007-08-28 06:25:35 | [diff] [blame] | 57 | |
| 58 | This form is to view the changes on the branch containing |
| 59 | and up to the second <commit>, starting at a common ancestor |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame^] | 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 |
Junio C Hamano | c435b1c | 2007-08-28 06:25:35 | [diff] [blame] | 62 | of <commit>, which has the same effect as using HEAD instead. |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 63 | |
| 64 | Just in case if you are doing something exotic, it should be |
Junio C Hamano | 7d9e9bd | 2007-08-29 07:31:47 | [diff] [blame] | 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>. |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 68 | |
Junio C Hamano | 2d47c62 | 2007-01-18 06:24:10 | [diff] [blame] | 69 | For a more complete list of ways to spell <commit>, see |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 70 | "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. |
Junio C Hamano | c435b1c | 2007-08-28 06:25:35 | [diff] [blame] | 71 | However, "diff" is about comparing two _endpoints_, not ranges, |
| 72 | and the range notations ("<commit>..<commit>" and |
Junio C Hamano | 7d9e9bd | 2007-08-29 07:31:47 | [diff] [blame] | 73 | "<commit>\...<commit>") do not mean a range as defined in the |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 74 | "SPECIFYING RANGES" section in linkgit:git-rev-parse[1]. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 75 | |
| 76 | OPTIONS |
| 77 | ------- |
Junio C Hamano | ff97979 | 2007-11-16 10:11:30 | [diff] [blame] | 78 | :git-diff: 1 |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 79 | include::diff-options.txt[] |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 80 | |
| 81 | <path>...:: |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 82 | The <paths> parameters, when given, are used to limit |
| 83 | the diff to the named paths (you can give directory |
| 84 | names and get diff for all files under them). |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 85 | |
Junio C Hamano | 7ae0ab2 | 2007-11-03 02:46:46 | [diff] [blame] | 86 | Output format |
| 87 | ------------- |
| 88 | include::diff-format.txt[] |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 89 | |
| 90 | EXAMPLES |
| 91 | -------- |
| 92 | |
| 93 | Various ways to check your working tree:: |
| 94 | + |
| 95 | ------------ |
Junio C Hamano | c8d88c2 | 2006-04-29 07:02:01 | [diff] [blame] | 96 | $ git diff <1> |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 97 | $ git diff --cached <2> |
Junio C Hamano | c8d88c2 | 2006-04-29 07:02:01 | [diff] [blame] | 98 | $ git diff HEAD <3> |
| 99 | ------------ |
| 100 | + |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 101 | <1> Changes in the working tree not yet staged for the next commit. |
| 102 | <2> Changes between the index and your last commit; what you |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 103 | would be committing if you run "git commit" without "-a" option. |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 104 | <3> Changes in the working tree since your last commit; what you |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 105 | would be committing if you run "git commit -a" |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 106 | |
| 107 | Comparing with arbitrary commits:: |
| 108 | + |
| 109 | ------------ |
Junio C Hamano | c8d88c2 | 2006-04-29 07:02:01 | [diff] [blame] | 110 | $ git diff test <1> |
| 111 | $ git diff HEAD -- ./test <2> |
| 112 | $ git diff HEAD^ HEAD <3> |
| 113 | ------------ |
| 114 | + |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 115 | <1> Instead of using the tip of the current branch, compare with the |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 116 | tip of "test" branch. |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 117 | <2> Instead of comparing with the tip of "test" branch, compare with |
Junio C Hamano | 235a91e | 2006-01-07 01:13:58 | [diff] [blame] | 118 | the tip of the current branch, but limit the comparison to the |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 119 | file "test". |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 120 | <3> Compare the version before the last commit and the last commit. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 121 | |
Junio C Hamano | c435b1c | 2007-08-28 06:25:35 | [diff] [blame] | 122 | Comparing branches:: |
| 123 | + |
| 124 | ------------ |
| 125 | $ git diff topic master <1> |
| 126 | $ git diff topic..master <2> |
| 127 | $ git diff topic...master <3> |
| 128 | ------------ |
| 129 | + |
| 130 | <1> Changes between the tips of the topic and the master branches. |
| 131 | <2> Same as above. |
Junio C Hamano | 764a667 | 2007-10-23 01:23:31 | [diff] [blame] | 132 | <3> Changes that occurred on the master branch since when the topic |
Junio C Hamano | c435b1c | 2007-08-28 06:25:35 | [diff] [blame] | 133 | branch was started off it. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 134 | |
| 135 | Limiting the diff output:: |
| 136 | + |
| 137 | ------------ |
Junio C Hamano | c8d88c2 | 2006-04-29 07:02:01 | [diff] [blame] | 138 | $ git diff --diff-filter=MRC <1> |
Junio C Hamano | bdeff82 | 2007-07-30 09:07:17 | [diff] [blame] | 139 | $ git diff --name-status <2> |
Junio C Hamano | c8d88c2 | 2006-04-29 07:02:01 | [diff] [blame] | 140 | $ git diff arch/i386 include/asm-i386 <3> |
| 141 | ------------ |
| 142 | + |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 143 | <1> Show only modification, rename and copy, but not addition |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 144 | nor deletion. |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 145 | <2> Show only names and the nature of change, but not actual |
Junio C Hamano | bdeff82 | 2007-07-30 09:07:17 | [diff] [blame] | 146 | diff output. |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 147 | <3> Limit diff output to named subtrees. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 148 | |
| 149 | Munging the diff output:: |
| 150 | + |
| 151 | ------------ |
Junio C Hamano | c8d88c2 | 2006-04-29 07:02:01 | [diff] [blame] | 152 | $ git diff --find-copies-harder -B -C <1> |
| 153 | $ git diff -R <2> |
| 154 | ------------ |
| 155 | + |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 156 | <1> Spend extra cycles to find renames, copies and complete |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 157 | rewrites (very expensive). |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 158 | <2> Output diff in reverse. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 159 | |
| 160 | |
| 161 | Author |
| 162 | ------ |
| 163 | Written by Linus Torvalds <torvalds@osdl.org> |
| 164 | |
| 165 | Documentation |
| 166 | -------------- |
| 167 | Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. |
| 168 | |
| 169 | GIT |
| 170 | --- |
Junio C Hamano | f7c042d | 2008-06-06 22:50:53 | [diff] [blame] | 171 | Part of the linkgit:git[1] suite |