2 .\" Title: git-diff-index
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
7 .\" Source: Git 2.44.0.53.g0f9d4d28b7
10 .TH "GIT\-DIFF\-INDEX" "1" "2024\-02\-27" "Git 2\&.44\&.0\&.53\&.g0f9d4d2" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 git-diff-index \- Compare a tree to the working tree or index
35 \fIgit diff\-index\fR [\-m] [\-\-cached] [\-\-merge\-base] [<common\-diff\-options>] <tree\-ish> [<path>\&...]
40 Compare the content and mode of the blobs found in a tree object with the corresponding tracked files in the working tree, or with the corresponding paths in the index\&. When <path> arguments are present, compare only paths matching those patterns\&. Otherwise all tracked files are compared\&.
46 the section called \(lqGENERATING PATCH TEXT WITH \-P\(rq)\&.
51 Suppress all output from the diff machinery\&. Useful for commands like
53 that show the patch by default to squelch their output, or to cancel the effect of options like
56 earlier on the command line in an alias\&.
59 \-U<n>, \-\-unified=<n>
61 Generate diffs with <n> lines of context instead of the usual three\&. Implies
67 Output to a specific file instead of stdout\&.
70 \-\-output\-indicator\-new=<char>, \-\-output\-indicator\-old=<char>, \-\-output\-indicator\-context=<char>
72 Specify the character used to indicate new, old or context lines in the generated patch\&. Normally they are
75 and \*(Aq \*(Aq respectively\&.
80 Generate the diff in raw format\&. This is the default\&.
91 Enable the heuristic that shifts diff hunk boundaries to make patches easier to read\&. This is the default\&.
94 \-\-no\-indent\-heuristic
96 Disable the indent heuristic\&.
101 Spend extra time to make sure the smallest possible diff is produced\&.
106 Generate a diff using the "patience diff" algorithm\&.
111 Generate a diff using the "histogram diff" algorithm\&.
116 Generate a diff using the "anchored diff" algorithm\&.
118 This option may be specified more than once\&.
120 If a line exists in both the source and destination, exists only once, and starts with this text, this algorithm attempts to prevent it from appearing as a deletion or addition in the output\&. It uses the "patience diff" algorithm internally\&.
123 \-\-diff\-algorithm={patience|minimal|histogram|myers}
125 Choose a diff algorithm\&. The variants are as follows:
127 \fBdefault\fR, \fBmyers\fR
129 The basic greedy diff algorithm\&. Currently, this is the default\&.
134 Spend extra time to make sure the smallest possible diff is produced\&.
139 Use "patience diff" algorithm when generating patches\&.
144 This algorithm extends the patience algorithm to "support low\-occurrence common elements"\&.
147 For instance, if you configured the
148 \fBdiff\&.algorithm\fR
149 variable to a non\-default value and want to use the default one, then you have to use
150 \fB\-\-diff\-algorithm=default\fR
154 \-\-stat[=<width>[,<name\-width>[,<count>]]]
156 Generate a diffstat\&. By default, as much space as necessary will be used for the filename part, and the rest for the graph part\&. Maximum width defaults to terminal width, or 80 columns if not connected to a terminal, and can be overridden by
157 \fB<width>\fR\&. The width of the filename part can be limited by giving another width
159 after a comma or by setting
160 \fBdiff\&.statNameWidth=<width>\fR\&. The width of the graph part can be limited by using
161 \fB\-\-stat\-graph\-width=<width>\fR
163 \fBdiff\&.statGraphWidth=<width>\fR\&. Using
166 \fB\-\-stat\-graph\-width\fR
167 affects all commands generating a stat graph, while setting
168 \fBdiff\&.statNameWidth\fR
170 \fBdiff\&.statGraphWidth\fR
172 \fBgit format\-patch\fR\&. By giving a third parameter
173 \fB<count>\fR, you can limit the output to the first
179 These parameters can also be set individually with
180 \fB\-\-stat\-width=<width>\fR,
181 \fB\-\-stat\-name\-width=<name\-width>\fR
183 \fB\-\-stat\-count=<count>\fR\&.
188 Output a condensed summary of extended header information such as file creations or deletions ("new" or "gone", optionally "+l" if it\(cqs a symlink) and mode changes ("+x" or "\-x" for adding or removing executable bit respectively) in diffstat\&. The information is put between the filename part and the graph part\&. Implies
195 \fB\-\-stat\fR, but shows number of added and deleted lines in decimal notation and pathname without abbreviation, to make it more machine friendly\&. For binary files, outputs two
203 Output only the last line of the
205 format containing total number of modified files, as well as number of added and deleted lines\&.
208 \-X[<param1,param2,\&...>], \-\-dirstat[=<param1,param2,\&...>]
210 Output the distribution of relative amount of changes for each sub\-directory\&. The behavior of
212 can be customized by passing it a comma separated list of parameters\&. The defaults are controlled by the
214 configuration variable (see
215 \fBgit-config\fR(1))\&. The following parameters are available:
219 Compute the dirstat numbers by counting the lines that have been removed from the source, or added to the destination\&. This ignores the amount of pure code movements within a file\&. In other words, rearranging lines in a file is not counted as much as other changes\&. This is the default behavior when no parameter is given\&.
224 Compute the dirstat numbers by doing the regular line\-based diff analysis, and summing the removed/added line counts\&. (For binary files, count 64\-byte chunks instead, since binary files have no natural concept of lines)\&. This is a more expensive
228 behavior, but it does count rearranged lines within a file as much as other changes\&. The resulting output is consistent with what you get from the other
235 Compute the dirstat numbers by counting the number of files changed\&. Each changed file counts equally in the dirstat analysis\&. This is the computationally cheapest
237 behavior, since it does not have to look at the file contents at all\&.
242 Count changes in a child directory for the parent directory as well\&. Note that when using
243 \fBcumulative\fR, the sum of the percentages reported may exceed 100%\&. The default (non\-cumulative) behavior can be specified with the
250 An integer parameter specifies a cut\-off percent (3% by default)\&. Directories contributing less than this percentage of the changes are not shown in the output\&.
253 Example: The following will count changed files, while ignoring directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories:
254 \fB\-\-dirstat=files,10,cumulative\fR\&.
259 Synonym for \-\-dirstat=cumulative
262 \-\-dirstat\-by\-file[=<param1,param2>\&...]
264 Synonym for \-\-dirstat=files,<param1>,<param2>\&...
269 Output a condensed summary of extended header information such as creations, renames and mode changes\&.
272 \-\-patch\-with\-stat
275 \fB\-p \-\-stat\fR\&.
285 \fB\-\-name\-status\fR
286 has been given, do not munge pathnames and use NULs as output field terminators\&.
288 Without this option, pathnames with "unusual" characters are quoted as explained for the configuration variable
289 \fBcore\&.quotePath\fR
291 \fBgit-config\fR(1))\&.
296 Show only names of changed files\&. The file names are often encoded in UTF\-8\&. For more information see the discussion about encoding in the
303 Show only names and status of changed files\&. See the description of the
304 \fB\-\-diff\-filter\fR
305 option on what the status letters mean\&. Just like
307 the file names are often encoded in UTF\-8\&.
310 \-\-submodule[=<format>]
312 Specify how differences in submodules are shown\&. When specifying
313 \fB\-\-submodule=short\fR
316 format is used\&. This format just shows the names of the commits at the beginning and end of the range\&. When
319 \fB\-\-submodule=log\fR
322 format is used\&. This format lists the commits in the range like
323 \fBgit-submodule\fR(1)
326 \fB\-\-submodule=diff\fR
329 format is used\&. This format shows an inline diff of the changes in the submodule contents between the commit range\&. Defaults to
330 \fBdiff\&.submodule\fR
333 format if the config option is unset\&.
341 \fI=<when>\fR) is the same as
342 \fB\-\-color=always\fR\&.
352 Turn off colored diff\&. It is the same as
353 \fB\-\-color=never\fR\&.
356 \-\-color\-moved[=<mode>]
358 Moved lines of code are colored differently\&. The <mode> defaults to
360 if the option is not given and to
362 if the option with no mode is given\&. The mode must be one of:
366 Moved lines are not highlighted\&.
372 \fBzebra\fR\&. This may change to a more sensible mode in the future\&.
377 Any line that is added in one location and was removed in another location will be colored with
378 \fIcolor\&.diff\&.newMoved\fR\&. Similarly
379 \fIcolor\&.diff\&.oldMoved\fR
380 will be used for removed lines that are added somewhere else in the diff\&. This mode picks up any moved line, but it is not very useful in a review to determine if a block of code was moved without permutation\&.
385 Blocks of moved text of at least 20 alphanumeric characters are detected greedily\&. The detected blocks are painted using either the
386 \fIcolor\&.diff\&.{old,new}Moved\fR
387 color\&. Adjacent blocks cannot be told apart\&.
392 Blocks of moved text are detected as in
394 mode\&. The blocks are painted using either the
395 \fIcolor\&.diff\&.{old,new}Moved\fR
397 \fIcolor\&.diff\&.{old,new}MovedAlternative\fR\&. The change between the two colors indicates that a new block was detected\&.
403 \fIzebra\fR, but additional dimming of uninteresting parts of moved code is performed\&. The bordering lines of two adjacent blocks are considered interesting, the rest is uninteresting\&.
405 is a deprecated synonym\&.
411 Turn off move detection\&. This can be used to override configuration settings\&. It is the same as
412 \fB\-\-color\-moved=no\fR\&.
415 \-\-color\-moved\-ws=<modes>
417 This configures how whitespace is ignored when performing the move detection for
418 \fB\-\-color\-moved\fR\&. These modes can be given as a comma separated list:
422 Do not ignore whitespace when performing move detection\&.
425 ignore\-space\-at\-eol
427 Ignore changes in whitespace at EOL\&.
430 ignore\-space\-change
432 Ignore changes in amount of whitespace\&. This ignores whitespace at line end, and considers all other sequences of one or more whitespace characters to be equivalent\&.
437 Ignore whitespace when comparing lines\&. This ignores differences even if one line has whitespace where the other line has none\&.
440 allow\-indentation\-change
442 Initially ignore any whitespace in the move detection, then group the moved code blocks only into a block if the change in whitespace is the same per line\&. This is incompatible with the other modes\&.
446 \-\-no\-color\-moved\-ws
448 Do not ignore whitespace when performing move detection\&. This can be used to override configuration settings\&. It is the same as
449 \fB\-\-color\-moved\-ws=no\fR\&.
452 \-\-word\-diff[=<mode>]
454 Show a word diff, using the <mode> to delimit changed words\&. By default, words are delimited by whitespace; see
455 \fB\-\-word\-diff\-regex\fR
456 below\&. The <mode> defaults to
457 \fIplain\fR, and must be one of:
461 Highlight changed words using only colors\&. Implies
470 \fB{+added+}\fR\&. Makes no attempts to escape the delimiters if they appear in the input, so the output may be ambiguous\&.
475 Use a special line\-based format intended for script consumption\&. Added/removed/unchanged runs are printed in the usual unified diff format, starting with a
476 \fB+\fR/\fB\-\fR/` ` character at the beginning of the line and extending to the end of the line\&. Newlines in the input are represented by a tilde
478 on a line of its own\&.
483 Disable word diff again\&.
486 Note that despite the name of the first mode, color is used to highlight the changed parts in all modes if enabled\&.
489 \-\-word\-diff\-regex=<regex>
491 Use <regex> to decide what a word is, instead of considering runs of non\-whitespace to be a word\&. Also implies
493 unless it was already enabled\&.
495 Every non\-overlapping match of the <regex> is considered a word\&. Anything between these matches is considered whitespace and ignored(!) for the purposes of finding differences\&. You may want to append
497 to your regular expression to make sure that it matches all non\-whitespace characters\&. A match that contains a newline is silently truncated(!) at the newline\&.
500 \fB\-\-word\-diff\-regex=\&.\fR
501 will treat each character as a word and, correspondingly, show differences character by character\&.
503 The regex can also be set via a diff driver or configuration option, see
504 \fBgitattributes\fR(5)
506 \fBgit-config\fR(1)\&. Giving it explicitly overrides any diff driver or configuration setting\&. Diff drivers override configuration settings\&.
509 \-\-color\-words[=<regex>]
512 \fB\-\-word\-diff=color\fR
513 plus (if a regex was specified)
514 \fB\-\-word\-diff\-regex=<regex>\fR\&.
519 Turn off rename detection, even when the configuration file gives the default to do so\&.
522 \-\-[no\-]rename\-empty
524 Whether to use empty blobs as rename source\&.
529 Warn if changes introduce conflict markers or whitespace errors\&. What are considered whitespace errors is controlled by
530 \fBcore\&.whitespace\fR
531 configuration\&. By default, trailing whitespaces (including lines that consist solely of whitespaces) and a space character that is immediately followed by a tab character inside the initial indent of the line are considered whitespace errors\&. Exits with non\-zero status if problems are found\&. Not compatible with \-\-exit\-code\&.
534 \-\-ws\-error\-highlight=<kind>
536 Highlight whitespace errors in the
541 lines of the diff\&. Multiple values are separated by comma,
543 resets previous values,
550 \fBold,new,context\fR\&. When this option is not given, and the configuration variable
551 \fBdiff\&.wsErrorHighlight\fR
552 is not set, only whitespace errors in
554 lines are highlighted\&. The whitespace errors are colored with
555 \fBcolor\&.diff\&.whitespace\fR\&.
560 Instead of the first handful of characters, show the full pre\- and post\-image blob object names on the "index" line when generating patch format output\&.
566 \fB\-\-full\-index\fR, output a binary diff that can be applied with
567 \fBgit\-apply\fR\&. Implies
573 Instead of showing the full 40\-byte hexadecimal object name in diff\-raw format output and diff\-tree header lines, show the shortest prefix that is at least
575 hexdigits long that uniquely refers the object\&. In diff\-patch output format,
576 \fB\-\-full\-index\fR
577 takes higher precedence, i\&.e\&. if
578 \fB\-\-full\-index\fR
579 is specified, full blob names will be shown regardless of
580 \fB\-\-abbrev\fR\&. Non default number of digits can be specified with
581 \fB\-\-abbrev=<n>\fR\&.
584 \-B[<n>][/<m>], \-\-break\-rewrites[=[<n>][/<m>]]
586 Break complete rewrite changes into pairs of delete and create\&. This serves two purposes:
588 It affects the way a change that amounts to a total rewrite of a file not as a series of deletion and insertion mixed together with a very few lines that happen to match textually as the context, but as a single deletion of everything old followed by a single insertion of everything new, and the number
590 controls this aspect of the \-B option (defaults to 60%)\&.
592 specifies that less than 30% of the original should remain in the result for Git to consider it a total rewrite (i\&.e\&. otherwise the resulting patch will be a series of deletion and insertion mixed together with context lines)\&.
594 When used with \-M, a totally\-rewritten file is also considered as the source of a rename (usually \-M only considers a file that disappeared as the source of a rename), and the number
596 controls this aspect of the \-B option (defaults to 50%)\&.
598 specifies that a change with addition and deletion compared to 20% or more of the file\(cqs size are eligible for being picked up as a possible source of a rename to another file\&.
601 \-M[<n>], \-\-find\-renames[=<n>]
605 is specified, it is a threshold on the similarity index (i\&.e\&. amount of addition/deletions compared to the file\(cqs size)\&. For example,
607 means Git should consider a delete/add pair to be a rename if more than 90% of the file hasn\(cqt changed\&. Without a
609 sign, the number is to be read as a fraction, with a decimal point before it\&. I\&.e\&.,
611 becomes 0\&.5, and is thus the same as
612 \fB\-M50%\fR\&. Similarly,
615 \fB\-M5%\fR\&. To limit detection to exact renames, use
616 \fB\-M100%\fR\&. The default similarity index is 50%\&.
619 \-C[<n>], \-\-find\-copies[=<n>]
621 Detect copies as well as renames\&. See also
622 \fB\-\-find\-copies\-harder\fR\&. If
624 is specified, it has the same meaning as for
628 \-\-find\-copies\-harder
630 For performance reasons, by default,
632 option finds copies only if the original file of the copy was modified in the same changeset\&. This flag makes the command inspect unmodified files as candidates for the source of copy\&. This is a very expensive operation for large projects, so use it with caution\&. Giving more than one
634 option has the same effect\&.
637 \-D, \-\-irreversible\-delete
639 Omit the preimage for deletes, i\&.e\&. print only the header but not the diff between the preimage and
640 \fB/dev/null\fR\&. The resulting patch is not meant to be applied with
643 \fBgit apply\fR; this is solely for people who want to just concentrate on reviewing the text after the change\&. In addition, the output obviously lacks enough information to apply such a patch in reverse, even manually, hence the name of the option\&.
645 When used together with
646 \fB\-B\fR, omit also the preimage in the deletion part of a delete/create pair\&.
655 options involve some preliminary steps that can detect subsets of renames/copies cheaply, followed by an exhaustive fallback portion that compares all remaining unpaired destinations to all relevant sources\&. (For renames, only remaining unpaired sources are relevant; for copies, all original sources are relevant\&.) For N sources and destinations, this exhaustive check is O(N^2)\&. This option prevents the exhaustive portion of rename/copy detection from running if the number of source/destination files involved exceeds the specified number\&. Defaults to diff\&.renameLimit\&. Note that a value of 0 is treated as unlimited\&.
658 \-\-diff\-filter=[(A|C|D|M|R|T|U|X|B)\&...[*]]
660 Select only files that are Added (\fBA\fR), Copied (\fBC\fR), Deleted (\fBD\fR), Modified (\fBM\fR), Renamed (\fBR\fR), have their type (i\&.e\&. regular file, symlink, submodule, \&...) changed (\fBT\fR), are Unmerged (\fBU\fR), are Unknown (\fBX\fR), or have had their pairing Broken (\fBB\fR)\&. Any combination of the filter characters (including none) can be used\&. When
662 (All\-or\-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected\&.
664 Also, these upper\-case letters can be downcased to exclude\&. E\&.g\&.
665 \fB\-\-diff\-filter=ad\fR
666 excludes added and deleted paths\&.
668 Note that not all diffs can feature all types\&. For instance, copied and renamed entries cannot appear if detection for those types is disabled\&.
673 Look for differences that change the number of occurrences of the specified string (i\&.e\&. addition/deletion) in a file\&. Intended for the scripter\(cqs use\&.
675 It is useful when you\(cqre looking for an exact block of code (like a struct), and want to know the history of that block since it first came into being: use the feature iteratively to feed the interesting block in the preimage back into
676 \fB\-S\fR, and keep going until you get the very first version of the block\&.
678 Binary files are searched as well\&.
683 Look for differences whose patch text contains added/removed lines that match <regex>\&.
685 To illustrate the difference between
686 \fB\-S<regex> \-\-pickaxe\-regex\fR
688 \fB\-G<regex>\fR, consider a commit with the following diff in the same file:
694 + return frotz(nitfol, two\->ptr, 1, 0);
696 \- hit = frotz(nitfol, mf2\&.ptr, 1, 0);
703 \fBgit log \-G"frotz\e(nitfol"\fR
704 will show this commit,
705 \fBgit log \-S"frotz\e(nitfol" \-\-pickaxe\-regex\fR
706 will not (because the number of occurrences of that string did not change)\&.
710 is supplied patches of binary files without a textconv filter will be ignored\&.
716 for more information\&.
719 \-\-find\-object=<object\-id>
721 Look for differences that change the number of occurrences of the specified object\&. Similar to
722 \fB\-S\fR, just the argument is different in that it doesn\(cqt search for a specific string but for a specific object id\&.
724 The object can be a blob or a submodule commit\&. It implies the
728 to also find trees\&.
737 finds a change, show all the changes in that changeset, not just the files that contain the change in <string>\&.
742 Treat the <string> given to
744 as an extended POSIX regular expression to match\&.
749 Control the order in which files appear in the output\&. This overrides the
750 \fBdiff\&.orderFile\fR
751 configuration variable (see
752 \fBgit-config\fR(1))\&. To cancel
753 \fBdiff\&.orderFile\fR, use
754 \fB\-O/dev/null\fR\&.
756 The output order is determined by the order of glob patterns in <orderfile>\&. All files with pathnames that match the first pattern are output first, all files with pathnames that match the second pattern (but not the first) are output next, and so on\&. All files with pathnames that do not match any pattern are output last, as if there was an implicit match\-all pattern at the end of the file\&. If multiple pathnames have the same rank (they match the same pattern but no earlier patterns), their output order relative to each other is the normal order\&.
758 <orderfile> is parsed as follows:
768 Blank lines are ignored, so they can be used as separators for readability\&.
779 Lines starting with a hash ("\fB#\fR") are ignored, so they can be used for comments\&. Add a backslash ("\fB\e\fR") to the beginning of the pattern if it starts with a hash\&.
790 Each other line contains a single pattern\&.
793 Patterns have the same syntax and semantics as patterns used for fnmatch(3) without the FNM_PATHNAME flag, except a pathname also matches a pattern if removing any number of the final pathname components matches the pattern\&. For example, the pattern "\fBfoo*bar\fR" matches "\fBfooasdfbar\fR" and "\fBfoo/bar/baz/asdf\fR" but not "\fBfoobarx\fR"\&.
796 \-\-skip\-to=<file>, \-\-rotate\-to=<file>
798 Discard the files before the named <file> from the output (i\&.e\&.
799 \fIskip to\fR), or move them to the end of the output (i\&.e\&.
800 \fIrotate to\fR)\&. These options were invented primarily for the use of the
802 command, and may not be very useful otherwise\&.
807 Swap two inputs; that is, show differences from index or on\-disk file to tree contents\&.
810 \-\-relative[=<path>], \-\-no\-relative
812 When run from a subdirectory of the project, it can be told to exclude changes outside the directory and show pathnames relative to it with this option\&. When you are not in a subdirectory (e\&.g\&. in a bare repository), you can name which subdirectory to make the output relative to by giving a <path> as an argument\&.
813 \fB\-\-no\-relative\fR
814 can be used to countermand both
815 \fBdiff\&.relative\fR
816 config option and previous
817 \fB\-\-relative\fR\&.
822 Treat all files as text\&.
825 \-\-ignore\-cr\-at\-eol
827 Ignore carriage\-return at the end of line when doing a comparison\&.
830 \-\-ignore\-space\-at\-eol
832 Ignore changes in whitespace at EOL\&.
835 \-b, \-\-ignore\-space\-change
837 Ignore changes in amount of whitespace\&. This ignores whitespace at line end, and considers all other sequences of one or more whitespace characters to be equivalent\&.
840 \-w, \-\-ignore\-all\-space
842 Ignore whitespace when comparing lines\&. This ignores differences even if one line has whitespace where the other line has none\&.
845 \-\-ignore\-blank\-lines
847 Ignore changes whose lines are all blank\&.
850 \-I<regex>, \-\-ignore\-matching\-lines=<regex>
852 Ignore changes whose all lines match <regex>\&. This option may be specified more than once\&.
855 \-\-inter\-hunk\-context=<lines>
857 Show the context between diff hunks, up to the specified number of lines, thereby fusing hunks that are close to each other\&. Defaults to
858 \fBdiff\&.interHunkContext\fR
859 or 0 if the config option is unset\&.
862 \-W, \-\-function\-context
864 Show whole function as context lines for each change\&. The function names are determined in the same way as
866 works out patch hunk headers (see
867 \fIDefining a custom hunk\-header\fR
869 \fBgitattributes\fR(5))\&.
874 Make the program exit with codes similar to diff(1)\&. That is, it exits with 1 if there were differences and 0 means no differences\&.
879 Disable all output of the program\&. Implies
880 \fB\-\-exit\-code\fR\&.
885 Allow an external diff helper to be executed\&. If you set an external diff driver with
886 \fBgitattributes\fR(5), you need to use this option with
893 Disallow external diff drivers\&.
896 \-\-textconv, \-\-no\-textconv
898 Allow (or disallow) external text conversion filters to be run when comparing binary files\&. See
899 \fBgitattributes\fR(5)
900 for details\&. Because textconv filters are typically a one\-way conversion, the resulting diff is suitable for human consumption, but cannot be applied\&. For this reason, textconv filters are enabled by default only for
903 \fBgit-log\fR(1), but not for
904 \fBgit-format-patch\fR(1)
905 or diff plumbing commands\&.
908 \-\-ignore\-submodules[=<when>]
910 Ignore changes to submodules in the diff generation\&. <when> can be either "none", "untracked", "dirty" or "all", which is the default\&. Using "none" will consider the submodule modified when it either contains untracked or modified files or its HEAD differs from the commit recorded in the superproject and can be used to override any settings of the
915 \fBgitmodules\fR(5)\&. When "untracked" is used submodules are not considered dirty when they only contain untracked content (but they are still scanned for modified content)\&. Using "dirty" ignores all changes to the work tree of submodules, only changes to the commits stored in the superproject are shown (this was the behavior until 1\&.7\&.0)\&. Using "all" hides all changes to submodules\&.
918 \-\-src\-prefix=<prefix>
920 Show the given source prefix instead of "a/"\&.
923 \-\-dst\-prefix=<prefix>
925 Show the given destination prefix instead of "b/"\&.
930 Do not show any source or destination prefix\&.
935 Use the default source and destination prefixes ("a/" and "b/")\&. This is usually the default already, but may be used to override config such as
936 \fBdiff\&.noprefix\fR\&.
939 \-\-line\-prefix=<prefix>
941 Prepend an additional prefix to every line of output\&.
944 \-\-ita\-invisible\-in\-index
946 By default entries added by "git add \-N" appear as an existing empty file in "git diff" and a new file in "git diff \-\-cached"\&. This option makes the entry appear as a new file in "git diff" and non\-existent in "git diff \-\-cached"\&. This option could be reverted with
947 \fB\-\-ita\-visible\-in\-index\fR\&. Both options are experimental and could be removed in future\&.
950 For more detailed explanation on these common options, see also \fBgitdiffcore\fR(7)\&.
954 The id of a tree object to diff against\&.
959 Do not consider the on\-disk file at all\&.
964 Instead of comparing <tree\-ish> directly, use the merge base between <tree\-ish> and HEAD instead\&. <tree\-ish> must be a commit\&.
969 By default, files recorded in the index but not checked out are reported as deleted\&. This flag makes
970 \fIgit diff\-index\fR
971 say that all non\-checked\-out files are up to date\&.
973 .SH "RAW OUTPUT FORMAT"
975 The raw output format from "git\-diff\-index", "git\-diff\-tree", "git\-diff\-files" and "git diff \-\-raw" are very similar\&.
977 These commands all compare two sets of things; what is compared differs:
979 git\-diff\-index <tree\-ish>
981 compares the <tree\-ish> and the files on the filesystem\&.
984 git\-diff\-index \-\-cached <tree\-ish>
986 compares the <tree\-ish> and the index\&.
989 git\-diff\-tree [\-r] <tree\-ish\-1> <tree\-ish\-2> [<pattern>\&...]
991 compares the trees named by the two arguments\&.
994 git\-diff\-files [<pattern>\&...]
996 compares the index and the files on the filesystem\&.
999 The "git\-diff\-tree" command begins its output by printing the hash of what is being compared\&. After that, all the commands print one output line per changed file\&.
1001 An output line is formatted this way:
1007 in\-place edit :100644 100644 bcd1234 0123456 M file0
1008 copy\-edit :100644 100644 abcd123 1234567 C68 file1 file2
1009 rename\-edit :100644 100644 abcd123 1234567 R86 file1 file3
1010 create :000000 100644 0000000 1234567 A file4
1011 delete :100644 000000 1234567 0000000 D file5
1012 unmerged :000000 000000 0000000 0000000 U file6
1019 That is, from the left to the right:
1040 mode for "src"; 000000 if creation or unmerged\&.
1062 mode for "dst"; 000000 if deletion or unmerged\&.
1084 sha1 for "src"; 0{40} if creation or unmerged\&.
1106 sha1 for "dst"; 0{40} if deletion, unmerged or "work tree out of sync with the index"\&.
1128 status, followed by optional "score" number\&.
1165 option is used; only exists for C or R\&.
1176 path for "dst"; only exists for C or R\&.
1189 option is used, to terminate the record\&.
1192 Possible status letters are:
1196 \h'-04'\(bu\h'+03'\c
1202 A: addition of a file
1207 \h'-04'\(bu\h'+03'\c
1213 C: copy of a file into a new one
1218 \h'-04'\(bu\h'+03'\c
1224 D: deletion of a file
1229 \h'-04'\(bu\h'+03'\c
1235 M: modification of the contents or mode of a file
1240 \h'-04'\(bu\h'+03'\c
1246 R: renaming of a file
1251 \h'-04'\(bu\h'+03'\c
1257 T: change in the type of the file (regular file, symbolic link or submodule)
1262 \h'-04'\(bu\h'+03'\c
1268 U: file is unmerged (you must complete the merge before it can be committed)
1273 \h'-04'\(bu\h'+03'\c
1279 X: "unknown" change type (most probably a bug, please report it)
1282 Status letters C and R are always followed by a score (denoting the percentage of similarity between the source and target of the move or copy)\&. Status letter M may be followed by a score (denoting the percentage of dissimilarity) for file rewrites\&.
1284 The sha1 for "dst" is shown as all 0\(cqs if a file on the filesystem is out of sync with the index\&.
1292 :100644 100644 5be4a4a 0000000 M file\&.c
1299 Without the \fB\-z\fR option, pathnames with "unusual" characters are quoted as explained for the configuration variable \fBcore\&.quotePath\fR (see \fBgit-config\fR(1))\&. Using \fB\-z\fR the filename is output verbatim and the line is terminated by a NUL byte\&.
1300 .SH "DIFF FORMAT FOR MERGES"
1302 "git\-diff\-tree", "git\-diff\-files" and "git\-diff \-\-raw" can take \fB\-c\fR or \fB\-\-cc\fR option to generate diff output also for merge commits\&. The output differs from the format described above in the following way:
1312 there is a colon for each parent
1323 there are more "src" modes and "src" sha1
1334 status is concatenated status characters for each parent
1345 no optional "score" number
1356 tab\-separated pathname(s) of the file
1359 For \fB\-c\fR and \fB\-\-cc\fR, only the destination or final path is shown even if the file was renamed on any side of history\&. With \fB\-\-combined\-all\-paths\fR, the name of the path in each parent is shown followed by the name of the path in the merge commit\&.
1361 Examples for \fB\-c\fR and \fB\-\-cc\fR without \fB\-\-combined\-all\-paths\fR:
1367 ::100644 100644 100644 fabadb8 cc95eb0 4866510 MM desc\&.c
1368 ::100755 100755 100755 52b7a2d 6d1ac04 d2ac7d7 RM bar\&.sh
1369 ::100644 100644 100644 e07d6c5 9042e82 ee91881 RR phooey\&.c
1376 Examples when \fB\-\-combined\-all\-paths\fR added to either \fB\-c\fR or \fB\-\-cc\fR:
1382 ::100644 100644 100644 fabadb8 cc95eb0 4866510 MM desc\&.c desc\&.c desc\&.c
1383 ::100755 100755 100755 52b7a2d 6d1ac04 d2ac7d7 RM foo\&.sh bar\&.sh bar\&.sh
1384 ::100644 100644 100644 e07d6c5 9042e82 ee91881 RR fooey\&.c fuey\&.c phooey\&.c
1391 Note that \fIcombined diff\fR lists only files which were modified from all parents\&.
1392 .SH "GENERATING PATCH TEXT WITH \-P"
1394 Running \fBgit-diff\fR(1), \fBgit-log\fR(1), \fBgit-show\fR(1), \fBgit-diff-index\fR(1), \fBgit-diff-tree\fR(1), or \fBgit-diff-files\fR(1) with the \fB\-p\fR option produces patch text\&. You can customize the creation of patch text via the \fBGIT_EXTERNAL_DIFF\fR and the \fBGIT_DIFF_OPTS\fR environment variables (see \fBgit\fR(1)), and the \fBdiff\fR attribute (see \fBgitattributes\fR(5))\&.
1396 What the \-p option produces is slightly different from the traditional diff format:
1406 It is preceded by a "git diff" header that looks like this:
1412 diff \-\-git a/file1 b/file2
1422 filenames are the same unless rename/copy is involved\&. Especially, even for a creation or a deletion,
1426 used in place of the
1432 When a rename/copy is involved,
1436 show the name of the source file of the rename/copy and the name of the file that the rename/copy produces, respectively\&.
1447 It is followed by one or more extended header lines:
1455 deleted file mode <mode>
1456 new file mode <mode>
1461 similarity index <number>
1462 dissimilarity index <number>
1463 index <hash>\&.\&.<hash> <mode>
1469 File modes are printed as 6\-digit octal numbers including the file type and file permission bits\&.
1471 Path names in extended headers do not include the
1477 The similarity index is the percentage of unchanged lines, and the dissimilarity index is the percentage of changed lines\&. It is a rounded down integer, followed by a percent sign\&. The similarity index value of 100% is thus reserved for two equal files, while 100% dissimilarity means that no line from the old file made it into the new one\&.
1479 The index line includes the blob object names before and after the change\&. The <mode> is included if the file mode does not change; otherwise, separate lines indicate the old and the new mode\&.
1490 Pathnames with "unusual" characters are quoted as explained for the configuration variable
1491 \fBcore\&.quotePath\fR
1493 \fBgit-config\fR(1))\&.
1506 files in the output refer to files before the commit, and all the
1508 files refer to files after the commit\&. It is incorrect to apply each change to each file sequentially\&. For example, this patch will swap a and b:
1514 diff \-\-git a/a b/b
1517 diff \-\-git a/b b/a
1534 Hunk headers mention the name of the function to which the hunk applies\&. See "Defining a custom hunk\-header" in
1535 \fBgitattributes\fR(5)
1536 for details of how to tailor this to specific languages\&.
1538 .SH "COMBINED DIFF FORMAT"
1540 Any diff\-generating command can take the \fB\-c\fR or \fB\-\-cc\fR option to produce a \fIcombined diff\fR when showing a merge\&. This is the default format when showing merges with \fBgit-diff\fR(1) or \fBgit-show\fR(1)\&. Note also that you can give suitable \fB\-\-diff\-merges\fR option to any of these commands to force generation of diffs in a specific format\&.
1542 A "combined diff" format looks like this:
1548 diff \-\-combined describe\&.c
1549 index fabadb8,cc95eb0\&.\&.4866510
1550 \-\-\- a/describe\&.c
1552 @@@ \-98,20 \-98,12 +98,20 @@@
1553 return (a_date > b_date) ? \-1 : (a_date == b_date) ? 0 : 1;
1556 \- static void describe(char *arg)
1557 \-static void describe(struct commit *cmit, int last_one)
1558 ++static void describe(char *arg, int last_one)
1560 + unsigned char sha1[20];
1561 + struct commit *cmit;
1562 struct commit_list *list;
1563 static int initialized = 0;
1564 struct commit_name *n;
1566 + if (get_sha1(arg, sha1) < 0)
1567 + usage(describe_usage);
1568 + cmit = lookup_commit_reference(sha1);
1570 + usage(describe_usage);
1574 for_each_ref(get_name);
1590 It is preceded by a "git diff" header, that looks like this (when the
1598 diff \-\-combined file
1604 or like this (when the
1627 It is followed by one or more extended header lines (this example shows a merge with two parents):
1633 index <hash>,<hash>\&.\&.<hash>
1634 mode <mode>,<mode>\&.\&.<mode>
1635 new file mode <mode>
1636 deleted file mode <mode>,<mode>
1643 \fBmode <mode>,<mode>\&.\&.<mode>\fR
1644 line appears only if at least one of the <mode> is different from the rest\&. Extended headers with information about detected content movement (renames and copying detection) are designed to work with the diff of two <tree\-ish> and are not used by combined diff format\&.
1655 It is followed by a two\-line from\-file/to\-file header:
1668 Similar to the two\-line header for the traditional
1672 is used to signal created or deleted files\&.
1674 However, if the \-\-combined\-all\-paths option is provided, instead of a two\-line from\-file/to\-file, you get an N+1 line from\-file/to\-file header, where N is the number of parents in the merge commit:
1689 This extended format can be useful if rename or copy detection is active, to allow you to see the original name of the file in different parents\&.
1700 Chunk header format is modified to prevent people from accidentally feeding it to
1701 \fBpatch \-p1\fR\&. Combined diff format was created for review of merge commit changes, and was not meant to be applied\&. The change is similar to the change in the extended
1709 @@@ <from\-file\-range> <from\-file\-range> <to\-file\-range> @@@
1715 There are (number of parents + 1)
1717 characters in the chunk header for combined diff format\&.
1720 Unlike the traditional \fIunified\fR diff format, which shows two files A and B with a single column that has \fB\-\fR (minus \(em appears in A but removed in B), \fB+\fR (plus \(em missing in A but added to B), or \fB" "\fR (space \(em unchanged) prefix, this format compares two or more files file1, file2,\&... with one file X, and shows how X differs from each of fileN\&. One column for each of fileN is prepended to the output line to note how X\(cqs line is different from it\&.
1722 A \fB\-\fR character in the column N means that the line appears in fileN but it does not appear in the result\&. A \fB+\fR character in the column N means that the line appears in the result, and fileN does not have that line (in other words, the line was added, from the point of view of that parent)\&.
1724 In the above example output, the function signature was changed from both files (hence two \fB\-\fR removals from both file1 and file2, plus \fB++\fR to mean one line that was added does not appear in either file1 or file2)\&. Also, eight other lines are the same from file1 but do not appear in file2 (hence prefixed with \fB+\fR)\&.
1726 When shown by \fBgit diff\-tree \-c\fR, it compares the parents of a merge commit with the merge result (i\&.e\&. file1\&.\&.fileN are the parents)\&. When shown by \fBgit diff\-files \-c\fR, it compares the two unresolved merge parents with the working tree file (i\&.e\&. file1 is stage 2 aka "our version", file2 is stage 3 aka "their version")\&.
1727 .SH "OTHER DIFF FORMATS"
1729 The \fB\-\-summary\fR option describes newly added, deleted, renamed and copied files\&. The \fB\-\-stat\fR option adds diffstat(1) graph to the output\&. These options can be combined with other options, such as \fB\-p\fR, and are meant for human consumption\&.
1731 When showing a change that involves a rename or a copy, \fB\-\-stat\fR output formats the pathnames compactly by combining common prefix and suffix of the pathnames\&. For example, a change that moves \fBarch/i386/Makefile\fR to \fBarch/x86/Makefile\fR while modifying 4 lines will be shown like this:
1737 arch/{i386 => x86}/Makefile | 4 +\-\-
1744 The \fB\-\-numstat\fR option gives the diffstat(1) information but is designed for easier machine consumption\&. An entry in \fB\-\-numstat\fR output looks like this:
1751 3 1 arch/{i386 => x86}/Makefile
1758 That is, from left to right:
1768 the number of added lines;
1790 the number of deleted lines;
1812 pathname (possibly with rename/copy information);
1826 When \fB\-z\fR output option is in effect, the output is formatted this way:
1833 3 1 NUL arch/i386/Makefile NUL arch/x86/Makefile NUL
1850 the number of added lines;
1872 the number of deleted lines;
1894 a NUL (only exists if renamed/copied);
1905 pathname in preimage;
1916 a NUL (only exists if renamed/copied);
1927 pathname in postimage (only exists if renamed/copied);
1941 The extra \fBNUL\fR before the preimage path in renamed case is to allow scripts that read the output to tell if the current record being read is a single\-path record or a rename/copy record without reading ahead\&. After reading added and deleted lines, reading up to \fBNUL\fR would yield the pathname, but if that is \fBNUL\fR, the record will show two paths\&.
1942 .SH "OPERATING MODES"
1944 You can choose whether you want to trust the index file entirely (using the \fB\-\-cached\fR flag) or ask the diff logic to show any files that don\(cqt match the stat state as being "tentatively changed"\&. Both of these operations are very useful indeed\&.
1947 If \fB\-\-cached\fR is specified, it allows you to ask:
1953 show me the differences between HEAD and the current index
1954 contents (the ones I\*(Aqd write using \*(Aqgit write\-tree\*(Aq)
1960 For example, let\(cqs say that you have worked on your working directory, updated some files in the index and are ready to commit\&. You want to see exactly \fBwhat\fR you are going to commit, without having to write a new tree object and compare it that way, and to do that, you just do
1966 git diff\-index \-\-cached HEAD
1972 Example: let\(cqs say I had renamed \fBcommit\&.c\fR to \fBgit\-commit\&.c\fR, and I had done an \fBupdate\-index\fR to make that effective in the index file\&. \fBgit diff\-files\fR wouldn\(cqt show anything at all, since the index file matches my working directory\&. But doing a \fIgit diff\-index\fR does:
1978 torvalds@ppc970:~/git> git diff\-index \-\-cached HEAD
1979 :100644 000000 4161aecc6700a2eb579e842af0b7f22b98443f74 0000000000000000000000000000000000000000 D commit\&.c
1980 :000000 100644 0000000000000000000000000000000000000000 4161aecc6700a2eb579e842af0b7f22b98443f74 A git\-commit\&.c
1986 You can see easily that the above is a rename\&.
1988 In fact, \fBgit diff\-index \-\-cached\fR \fBshould\fR always be entirely equivalent to actually doing a \fIgit write\-tree\fR and comparing that\&. Except this one is much nicer for the case where you just want to check where you are\&.
1990 So doing a \fBgit diff\-index \-\-cached\fR is basically very useful when you are asking yourself "what have I already marked for being committed, and what\(cqs the difference to a previous tree"\&.
1991 .SH "NON\-CACHED MODE"
1993 The "non\-cached" mode takes a different approach, and is potentially the more useful of the two in that what it does can\(cqt be emulated with a \fIgit write\-tree\fR + \fIgit diff\-tree\fR\&. Thus that\(cqs the default mode\&. The non\-cached version asks the question:
1999 show me the differences between HEAD and the currently checked out
2000 tree \- index contents _and_ files that aren\*(Aqt up to date
2006 which is obviously a very useful question too, since that tells you what you \fBcould\fR commit\&. Again, the output matches the \fIgit diff\-tree \-r\fR output to a tee, but with a twist\&.
2008 The twist is that if some file doesn\(cqt match the index, we don\(cqt have a backing store thing for it, and we use the magic "all\-zero" sha1 to show that\&. So let\(cqs say that you have edited \fBkernel/sched\&.c\fR, but have not actually done a \fIgit update\-index\fR on it yet \- there is no "object" associated with the new state, and you get:
2014 torvalds@ppc970:~/v2\&.6/linux> git diff\-index \-\-abbrev HEAD
2015 :100644 100644 7476bb5ba 000000000 M kernel/sched\&.c
2021 i\&.e\&., it shows that the tree has changed, and that \fBkernel/sched\&.c\fR is not up to date and may contain new stuff\&. The all\-zero sha1 means that to get the real diff, you need to look at the object in the working directory directly rather than do an object\-to\-object diff\&.
2027 .nr an-no-space-flag 1
2035 As with other commands of this type, \fIgit diff\-index\fR does not actually look at the contents of the file at all\&. So maybe \fBkernel/sched\&.c\fR hasn\(cqt actually changed, and it\(cqs just that you touched it\&. In either case, it\(cqs a note that you need to \fIgit update\-index\fR it to make the index be in sync\&.
2043 .nr an-no-space-flag 1
2051 You can have a mixture of files show up as "has been updated" and "is still dirty in the working directory" together\&. You can always tell which file is in which state, since the "has been updated" ones show a valid sha1, and the "not in sync with the index" ones will always have the special all\-zero sha1\&.
2056 Part of the \fBgit\fR(1) suite