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 | 2e6ded8 | 2010-12-05 06:20:48 | [diff] [blame] | 11 | [verse] |
Junio C Hamano | c9cb517 | 2018-06-01 07:13:44 | [diff] [blame] | 12 | 'git diff' [<options>] [<commit>] [--] [<path>...] |
| 13 | 'git diff' [<options>] --cached [<commit>] [--] [<path>...] |
| 14 | 'git diff' [<options>] <commit> <commit> [--] [<path>...] |
| 15 | 'git diff' [<options>] <blob> <blob> |
| 16 | 'git diff' [<options>] --no-index [--] <path> <path> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 17 | |
| 18 | DESCRIPTION |
| 19 | ----------- |
Junio C Hamano | 2e6ded8 | 2010-12-05 06:20:48 | [diff] [blame] | 20 | Show changes between the working tree and the index or a tree, changes |
Junio C Hamano | 3a3357e | 2013-06-26 23:20:56 | [diff] [blame] | 21 | between the index and a tree, changes between two trees, changes between |
| 22 | two blob objects, or changes between two files on disk. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 23 | |
Junio C Hamano | c9cb517 | 2018-06-01 07:13:44 | [diff] [blame] | 24 | 'git diff' [<options>] [--] [<path>...]:: |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 25 | |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 26 | This form is to view the changes you made relative to |
| 27 | the index (staging area for the next commit). In other |
Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 28 | words, the differences are what you _could_ tell Git to |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 29 | further add to the index but you still haven't. You can |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 30 | stage these changes by using linkgit:git-add[1]. |
Junio C Hamano | e6f28d0 | 2013-09-17 21:34:00 | [diff] [blame] | 31 | |
Junio C Hamano | c9cb517 | 2018-06-01 07:13:44 | [diff] [blame] | 32 | 'git diff' [<options>] --no-index [--] <path> <path>:: |
Junio C Hamano | e6f28d0 | 2013-09-17 21:34:00 | [diff] [blame] | 33 | |
| 34 | This form is to compare the given two paths on the |
| 35 | filesystem. You can omit the `--no-index` option when |
| 36 | running the command in a working tree controlled by Git and |
| 37 | at least one of the paths points outside the working tree, |
| 38 | or when running the command outside a working tree |
| 39 | controlled by Git. |
Junio C Hamano | db911ee | 2007-02-28 08:13:52 | [diff] [blame] | 40 | |
Junio C Hamano | c9cb517 | 2018-06-01 07:13:44 | [diff] [blame] | 41 | 'git diff' [<options>] --cached [<commit>] [--] [<path>...]:: |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 42 | |
| 43 | This form is to view the changes you staged for the next |
Junio C Hamano | 4bf6dca | 2006-12-21 02:25:57 | [diff] [blame] | 44 | commit relative to the named <commit>. Typically you |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 45 | would want comparison with the latest commit, so if you |
| 46 | do not give <commit>, it defaults to HEAD. |
Junio C Hamano | 826f5c4 | 2014-02-07 20:33:30 | [diff] [blame] | 47 | If HEAD does not exist (e.g. unborn branches) and |
Junio C Hamano | e611683 | 2011-02-08 00:49:45 | [diff] [blame] | 48 | <commit> is not given, it shows all staged changes. |
Junio C Hamano | 8b4977b | 2008-11-12 04:57:48 | [diff] [blame] | 49 | --staged is a synonym of --cached. |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 50 | |
Junio C Hamano | c9cb517 | 2018-06-01 07:13:44 | [diff] [blame] | 51 | 'git diff' [<options>] <commit> [--] [<path>...]:: |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 52 | |
| 53 | This form is to view the changes you have in your |
| 54 | working tree relative to the named <commit>. You can |
| 55 | use HEAD to compare it with the latest commit, or a |
| 56 | branch name to compare with the tip of a different |
| 57 | branch. |
| 58 | |
Junio C Hamano | c9cb517 | 2018-06-01 07:13:44 | [diff] [blame] | 59 | 'git diff' [<options>] <commit> <commit> [--] [<path>...]:: |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 60 | |
Junio C Hamano | c435b1c | 2007-08-28 06:25:35 | [diff] [blame] | 61 | This is to view the changes between two arbitrary |
| 62 | <commit>. |
| 63 | |
Junio C Hamano | c9cb517 | 2018-06-01 07:13:44 | [diff] [blame] | 64 | 'git diff' [<options>] <commit>..<commit> [--] [<path>...]:: |
Junio C Hamano | c435b1c | 2007-08-28 06:25:35 | [diff] [blame] | 65 | |
| 66 | This is synonymous to the previous form. If <commit> on |
| 67 | one side is omitted, it will have the same effect as |
| 68 | using HEAD instead. |
| 69 | |
Junio C Hamano | c9cb517 | 2018-06-01 07:13:44 | [diff] [blame] | 70 | 'git diff' [<options>] <commit>\...<commit> [--] [<path>...]:: |
Junio C Hamano | c435b1c | 2007-08-28 06:25:35 | [diff] [blame] | 71 | |
| 72 | This form is to view the changes on the branch containing |
| 73 | and up to the second <commit>, starting at a common ancestor |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 74 | of both <commit>. "git diff A\...B" is equivalent to |
| 75 | "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] | 76 | of <commit>, which has the same effect as using HEAD instead. |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 77 | |
| 78 | Just in case if you are doing something exotic, it should be |
Junio C Hamano | 7d9e9bd | 2007-08-29 07:31:47 | [diff] [blame] | 79 | noted that all of the <commit> in the above description, except |
Junio C Hamano | c27b733 | 2010-10-14 04:37:28 | [diff] [blame] | 80 | in the last two forms that use ".." notations, can be any |
Junio C Hamano | db81b99 | 2012-12-21 23:49:12 | [diff] [blame] | 81 | <tree>. |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 82 | |
Junio C Hamano | 2d47c62 | 2007-01-18 06:24:10 | [diff] [blame] | 83 | For a more complete list of ways to spell <commit>, see |
Junio C Hamano | c27b733 | 2010-10-14 04:37:28 | [diff] [blame] | 84 | "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7]. |
Junio C Hamano | c435b1c | 2007-08-28 06:25:35 | [diff] [blame] | 85 | However, "diff" is about comparing two _endpoints_, not ranges, |
| 86 | and the range notations ("<commit>..<commit>" and |
Junio C Hamano | 7d9e9bd | 2007-08-29 07:31:47 | [diff] [blame] | 87 | "<commit>\...<commit>") do not mean a range as defined in the |
Junio C Hamano | c27b733 | 2010-10-14 04:37:28 | [diff] [blame] | 88 | "SPECIFYING RANGES" section in linkgit:gitrevisions[7]. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 89 | |
Junio C Hamano | c9cb517 | 2018-06-01 07:13:44 | [diff] [blame] | 90 | 'git diff' [<options>] <blob> <blob>:: |
Junio C Hamano | 3a3357e | 2013-06-26 23:20:56 | [diff] [blame] | 91 | |
| 92 | This form is to view the differences between the raw |
| 93 | contents of two blob objects. |
| 94 | |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 95 | OPTIONS |
| 96 | ------- |
Junio C Hamano | ff97979 | 2007-11-16 10:11:30 | [diff] [blame] | 97 | :git-diff: 1 |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 98 | include::diff-options.txt[] |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 99 | |
Junio C Hamano | 52a094d | 2017-04-20 05:35:10 | [diff] [blame] | 100 | -1 --base:: |
| 101 | -2 --ours:: |
| 102 | -3 --theirs:: |
| 103 | Compare the working tree with the "base" version (stage #1), |
| 104 | "our branch" (stage #2) or "their branch" (stage #3). The |
| 105 | index contains these stages only for unmerged entries i.e. |
| 106 | while resolving conflicts. See linkgit:git-read-tree[1] |
| 107 | section "3-Way Merge" for detailed information. |
| 108 | |
| 109 | -0:: |
| 110 | Omit diff output for unmerged entries and just show |
| 111 | "Unmerged". Can be used only when comparing the working tree |
| 112 | with the index. |
| 113 | |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 114 | <path>...:: |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 115 | The <paths> parameters, when given, are used to limit |
| 116 | the diff to the named paths (you can give directory |
| 117 | names and get diff for all files under them). |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 118 | |
Junio C Hamano | 543f8d6 | 2009-07-29 08:35:21 | [diff] [blame] | 119 | |
Junio C Hamano | 7ae0ab2 | 2007-11-03 02:46:46 | [diff] [blame] | 120 | include::diff-format.txt[] |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 121 | |
| 122 | EXAMPLES |
| 123 | -------- |
| 124 | |
| 125 | Various ways to check your working tree:: |
| 126 | + |
| 127 | ------------ |
Junio C Hamano | c8d88c2 | 2006-04-29 07:02:01 | [diff] [blame] | 128 | $ git diff <1> |
Junio C Hamano | 47848ae | 2006-12-14 11:20:06 | [diff] [blame] | 129 | $ git diff --cached <2> |
Junio C Hamano | c8d88c2 | 2006-04-29 07:02:01 | [diff] [blame] | 130 | $ git diff HEAD <3> |
| 131 | ------------ |
| 132 | + |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 133 | <1> Changes in the working tree not yet staged for the next commit. |
| 134 | <2> Changes between the index and your last commit; what you |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 135 | would be committing if you run "git commit" without "-a" option. |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 136 | <3> Changes in the working tree since your last commit; what you |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 137 | would be committing if you run "git commit -a" |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 138 | |
| 139 | Comparing with arbitrary commits:: |
| 140 | + |
| 141 | ------------ |
Junio C Hamano | c8d88c2 | 2006-04-29 07:02:01 | [diff] [blame] | 142 | $ git diff test <1> |
| 143 | $ git diff HEAD -- ./test <2> |
| 144 | $ git diff HEAD^ HEAD <3> |
| 145 | ------------ |
| 146 | + |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 147 | <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] | 148 | tip of "test" branch. |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 149 | <2> Instead of comparing with the tip of "test" branch, compare with |
Junio C Hamano | 235a91e | 2006-01-07 01:13:58 | [diff] [blame] | 150 | the tip of the current branch, but limit the comparison to the |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 151 | file "test". |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 152 | <3> Compare the version before the last commit and the last commit. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 153 | |
Junio C Hamano | c435b1c | 2007-08-28 06:25:35 | [diff] [blame] | 154 | Comparing branches:: |
| 155 | + |
| 156 | ------------ |
| 157 | $ git diff topic master <1> |
| 158 | $ git diff topic..master <2> |
| 159 | $ git diff topic...master <3> |
| 160 | ------------ |
| 161 | + |
| 162 | <1> Changes between the tips of the topic and the master branches. |
| 163 | <2> Same as above. |
Junio C Hamano | 764a667 | 2007-10-23 01:23:31 | [diff] [blame] | 164 | <3> Changes that occurred on the master branch since when the topic |
Junio C Hamano | c435b1c | 2007-08-28 06:25:35 | [diff] [blame] | 165 | branch was started off it. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 166 | |
| 167 | Limiting the diff output:: |
| 168 | + |
| 169 | ------------ |
Junio C Hamano | c8d88c2 | 2006-04-29 07:02:01 | [diff] [blame] | 170 | $ git diff --diff-filter=MRC <1> |
Junio C Hamano | bdeff82 | 2007-07-30 09:07:17 | [diff] [blame] | 171 | $ git diff --name-status <2> |
Junio C Hamano | c8d88c2 | 2006-04-29 07:02:01 | [diff] [blame] | 172 | $ git diff arch/i386 include/asm-i386 <3> |
| 173 | ------------ |
| 174 | + |
Junio C Hamano | d75148a | 2014-04-08 19:48:38 | [diff] [blame] | 175 | <1> Show only modification, rename, and copy, but not addition |
| 176 | or deletion. |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 177 | <2> Show only names and the nature of change, but not actual |
Junio C Hamano | bdeff82 | 2007-07-30 09:07:17 | [diff] [blame] | 178 | diff output. |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 179 | <3> Limit diff output to named subtrees. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 180 | |
| 181 | Munging the diff output:: |
| 182 | + |
| 183 | ------------ |
Junio C Hamano | c8d88c2 | 2006-04-29 07:02:01 | [diff] [blame] | 184 | $ git diff --find-copies-harder -B -C <1> |
| 185 | $ git diff -R <2> |
| 186 | ------------ |
| 187 | + |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 188 | <1> Spend extra cycles to find renames, copies and complete |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 189 | rewrites (very expensive). |
Junio C Hamano | 092f5f0 | 2007-08-02 07:23:38 | [diff] [blame] | 190 | <2> Output diff in reverse. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 191 | |
Junio C Hamano | a9701f0 | 2010-01-21 00:42:16 | [diff] [blame] | 192 | SEE ALSO |
| 193 | -------- |
Junio C Hamano | c27b733 | 2010-10-14 04:37:28 | [diff] [blame] | 194 | diff(1), |
| 195 | linkgit:git-difftool[1], |
| 196 | linkgit:git-log[1], |
| 197 | linkgit:gitdiffcore[7], |
| 198 | linkgit:git-format-patch[1], |
| 199 | linkgit:git-apply[1] |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 200 | |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 201 | GIT |
| 202 | --- |
Junio C Hamano | f7c042d | 2008-06-06 22:50:53 | [diff] [blame] | 203 | Part of the linkgit:git[1] suite |