Autogenerated manpages for v2.39.1-231-ga7caae
[git-manpages.git] / man1 / git-diff-tree.1
blob1b14c79967903af5a2ef1aae7f8eec5317f80282
1 '\" t
2 .\"     Title: git-diff-tree
3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\"      Date: 01/17/2023
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.39.1.231.ga7caae2729
8 .\"  Language: English
9 .\"
10 .TH "GIT\-DIFF\-TREE" "1" "01/17/2023" "Git 2\&.39\&.1\&.231\&.ga7caae" "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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-diff-tree \- Compares the content and mode of blobs found via two tree objects
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit diff\-tree\fR [\-\-stdin] [\-m] [\-s] [\-v] [\-\-no\-commit\-id] [\-\-pretty]
36               [\-t] [\-r] [\-c | \-\-cc] [\-\-combined\-all\-paths] [\-\-root] [\-\-merge\-base]
37               [<common\-diff\-options>] <tree\-ish> [<tree\-ish>] [<path>\&...]
38 .fi
39 .sp
40 .SH "DESCRIPTION"
41 .sp
42 Compares the content and mode of the blobs found via two tree objects\&.
43 .sp
44 If there is only one <tree\-ish> given, the commit is compared with its parents (see \-\-stdin below)\&.
45 .sp
46 Note that \fIgit diff\-tree\fR can use the tree encapsulated in a commit object\&.
47 .SH "OPTIONS"
48 .PP
49 \-p, \-u, \-\-patch
50 .RS 4
51 Generate patch (see section on generating patches)\&.
52 .RE
53 .PP
54 \-s, \-\-no\-patch
55 .RS 4
56 Suppress diff output\&. Useful for commands like
57 \fBgit show\fR
58 that show the patch by default, or to cancel the effect of
59 \fB\-\-patch\fR\&.
60 .RE
61 .PP
62 \-U<n>, \-\-unified=<n>
63 .RS 4
64 Generate diffs with <n> lines of context instead of the usual three\&. Implies
65 \fB\-\-patch\fR\&.
66 .RE
67 .PP
68 \-\-output=<file>
69 .RS 4
70 Output to a specific file instead of stdout\&.
71 .RE
72 .PP
73 \-\-output\-indicator\-new=<char>, \-\-output\-indicator\-old=<char>, \-\-output\-indicator\-context=<char>
74 .RS 4
75 Specify the character used to indicate new, old or context lines in the generated patch\&. Normally they are
76 \fI+\fR,
77 \fI\-\fR
78 and \(aq \(aq respectively\&.
79 .RE
80 .PP
81 \-\-raw
82 .RS 4
83 Generate the diff in raw format\&. This is the default\&.
84 .RE
85 .PP
86 \-\-patch\-with\-raw
87 .RS 4
88 Synonym for
89 \fB\-p \-\-raw\fR\&.
90 .RE
91 .PP
92 \-\-indent\-heuristic
93 .RS 4
94 Enable the heuristic that shifts diff hunk boundaries to make patches easier to read\&. This is the default\&.
95 .RE
96 .PP
97 \-\-no\-indent\-heuristic
98 .RS 4
99 Disable the indent heuristic\&.
102 \-\-minimal
103 .RS 4
104 Spend extra time to make sure the smallest possible diff is produced\&.
107 \-\-patience
108 .RS 4
109 Generate a diff using the "patience diff" algorithm\&.
112 \-\-histogram
113 .RS 4
114 Generate a diff using the "histogram diff" algorithm\&.
117 \-\-anchored=<text>
118 .RS 4
119 Generate a diff using the "anchored diff" algorithm\&.
121 This option may be specified more than once\&.
123 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\&.
126 \-\-diff\-algorithm={patience|minimal|histogram|myers}
127 .RS 4
128 Choose a diff algorithm\&. The variants are as follows:
130 \fBdefault\fR, \fBmyers\fR
131 .RS 4
132 The basic greedy diff algorithm\&. Currently, this is the default\&.
135 \fBminimal\fR
136 .RS 4
137 Spend extra time to make sure the smallest possible diff is produced\&.
140 \fBpatience\fR
141 .RS 4
142 Use "patience diff" algorithm when generating patches\&.
145 \fBhistogram\fR
146 .RS 4
147 This algorithm extends the patience algorithm to "support low\-occurrence common elements"\&.
150 For instance, if you configured the
151 \fBdiff\&.algorithm\fR
152 variable to a non\-default value and want to use the default one, then you have to use
153 \fB\-\-diff\-algorithm=default\fR
154 option\&.
157 \-\-stat[=<width>[,<name\-width>[,<count>]]]
158 .RS 4
159 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
160 \fB<width>\fR\&. The width of the filename part can be limited by giving another width
161 \fB<name\-width>\fR
162 after a comma\&. The width of the graph part can be limited by using
163 \fB\-\-stat\-graph\-width=<width>\fR
164 (affects all commands generating a stat graph) or by setting
165 \fBdiff\&.statGraphWidth=<width>\fR
166 (does not affect
167 \fBgit format\-patch\fR)\&. By giving a third parameter
168 \fB<count>\fR, you can limit the output to the first
169 \fB<count>\fR
170 lines, followed by
171 \fB\&.\&.\&.\fR
172 if there are more\&.
174 These parameters can also be set individually with
175 \fB\-\-stat\-width=<width>\fR,
176 \fB\-\-stat\-name\-width=<name\-width>\fR
178 \fB\-\-stat\-count=<count>\fR\&.
181 \-\-compact\-summary
182 .RS 4
183 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
184 \fB\-\-stat\fR\&.
187 \-\-numstat
188 .RS 4
189 Similar to
190 \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
191 \fB\-\fR
192 instead of saying
193 \fB0 0\fR\&.
196 \-\-shortstat
197 .RS 4
198 Output only the last line of the
199 \fB\-\-stat\fR
200 format containing total number of modified files, as well as number of added and deleted lines\&.
203 \-X[<param1,param2,\&...>], \-\-dirstat[=<param1,param2,\&...>]
204 .RS 4
205 Output the distribution of relative amount of changes for each sub\-directory\&. The behavior of
206 \fB\-\-dirstat\fR
207 can be customized by passing it a comma separated list of parameters\&. The defaults are controlled by the
208 \fBdiff\&.dirstat\fR
209 configuration variable (see
210 \fBgit-config\fR(1))\&. The following parameters are available:
212 \fBchanges\fR
213 .RS 4
214 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\&.
217 \fBlines\fR
218 .RS 4
219 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
220 \fB\-\-dirstat\fR
221 behavior than the
222 \fBchanges\fR
223 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
224 \fB\-\-*stat\fR
225 options\&.
228 \fBfiles\fR
229 .RS 4
230 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
231 \fB\-\-dirstat\fR
232 behavior, since it does not have to look at the file contents at all\&.
235 \fBcumulative\fR
236 .RS 4
237 Count changes in a child directory for the parent directory as well\&. Note that when using
238 \fBcumulative\fR, the sum of the percentages reported may exceed 100%\&. The default (non\-cumulative) behavior can be specified with the
239 \fBnoncumulative\fR
240 parameter\&.
243 <limit>
244 .RS 4
245 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\&.
248 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:
249 \fB\-\-dirstat=files,10,cumulative\fR\&.
252 \-\-cumulative
253 .RS 4
254 Synonym for \-\-dirstat=cumulative
257 \-\-dirstat\-by\-file[=<param1,param2>\&...]
258 .RS 4
259 Synonym for \-\-dirstat=files,param1,param2\&...
262 \-\-summary
263 .RS 4
264 Output a condensed summary of extended header information such as creations, renames and mode changes\&.
267 \-\-patch\-with\-stat
268 .RS 4
269 Synonym for
270 \fB\-p \-\-stat\fR\&.
274 .RS 4
275 When
276 \fB\-\-raw\fR,
277 \fB\-\-numstat\fR,
278 \fB\-\-name\-only\fR
280 \fB\-\-name\-status\fR
281 has been given, do not munge pathnames and use NULs as output field terminators\&.
283 Without this option, pathnames with "unusual" characters are quoted as explained for the configuration variable
284 \fBcore\&.quotePath\fR
285 (see
286 \fBgit-config\fR(1))\&.
289 \-\-name\-only
290 .RS 4
291 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
292 \fBgit-log\fR(1)
293 manual page\&.
296 \-\-name\-status
297 .RS 4
298 Show only names and status of changed files\&. See the description of the
299 \fB\-\-diff\-filter\fR
300 option on what the status letters mean\&. Just like
301 \fB\-\-name\-only\fR
302 the file names are often encoded in UTF\-8\&.
305 \-\-submodule[=<format>]
306 .RS 4
307 Specify how differences in submodules are shown\&. When specifying
308 \fB\-\-submodule=short\fR
310 \fIshort\fR
311 format is used\&. This format just shows the names of the commits at the beginning and end of the range\&. When
312 \fB\-\-submodule\fR
314 \fB\-\-submodule=log\fR
315 is specified, the
316 \fIlog\fR
317 format is used\&. This format lists the commits in the range like
318 \fBgit-submodule\fR(1)
319 \fBsummary\fR
320 does\&. When
321 \fB\-\-submodule=diff\fR
322 is specified, the
323 \fIdiff\fR
324 format is used\&. This format shows an inline diff of the changes in the submodule contents between the commit range\&. Defaults to
325 \fBdiff\&.submodule\fR
326 or the
327 \fIshort\fR
328 format if the config option is unset\&.
331 \-\-color[=<when>]
332 .RS 4
333 Show colored diff\&.
334 \fB\-\-color\fR
335 (i\&.e\&. without
336 \fI=<when>\fR) is the same as
337 \fB\-\-color=always\fR\&.
338 \fI<when>\fR
339 can be one of
340 \fBalways\fR,
341 \fBnever\fR, or
342 \fBauto\fR\&.
345 \-\-no\-color
346 .RS 4
347 Turn off colored diff\&. It is the same as
348 \fB\-\-color=never\fR\&.
351 \-\-color\-moved[=<mode>]
352 .RS 4
353 Moved lines of code are colored differently\&. The <mode> defaults to
354 \fIno\fR
355 if the option is not given and to
356 \fIzebra\fR
357 if the option with no mode is given\&. The mode must be one of:
360 .RS 4
361 Moved lines are not highlighted\&.
364 default
365 .RS 4
366 Is a synonym for
367 \fBzebra\fR\&. This may change to a more sensible mode in the future\&.
370 plain
371 .RS 4
372 Any line that is added in one location and was removed in another location will be colored with
373 \fIcolor\&.diff\&.newMoved\fR\&. Similarly
374 \fIcolor\&.diff\&.oldMoved\fR
375 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\&.
378 blocks
379 .RS 4
380 Blocks of moved text of at least 20 alphanumeric characters are detected greedily\&. The detected blocks are painted using either the
381 \fIcolor\&.diff\&.{old,new}Moved\fR
382 color\&. Adjacent blocks cannot be told apart\&.
385 zebra
386 .RS 4
387 Blocks of moved text are detected as in
388 \fIblocks\fR
389 mode\&. The blocks are painted using either the
390 \fIcolor\&.diff\&.{old,new}Moved\fR
391 color or
392 \fIcolor\&.diff\&.{old,new}MovedAlternative\fR\&. The change between the two colors indicates that a new block was detected\&.
395 dimmed\-zebra
396 .RS 4
397 Similar to
398 \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\&.
399 \fBdimmed_zebra\fR
400 is a deprecated synonym\&.
404 \-\-no\-color\-moved
405 .RS 4
406 Turn off move detection\&. This can be used to override configuration settings\&. It is the same as
407 \fB\-\-color\-moved=no\fR\&.
410 \-\-color\-moved\-ws=<modes>
411 .RS 4
412 This configures how whitespace is ignored when performing the move detection for
413 \fB\-\-color\-moved\fR\&. These modes can be given as a comma separated list:
416 .RS 4
417 Do not ignore whitespace when performing move detection\&.
420 ignore\-space\-at\-eol
421 .RS 4
422 Ignore changes in whitespace at EOL\&.
425 ignore\-space\-change
426 .RS 4
427 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\&.
430 ignore\-all\-space
431 .RS 4
432 Ignore whitespace when comparing lines\&. This ignores differences even if one line has whitespace where the other line has none\&.
435 allow\-indentation\-change
436 .RS 4
437 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\&.
441 \-\-no\-color\-moved\-ws
442 .RS 4
443 Do not ignore whitespace when performing move detection\&. This can be used to override configuration settings\&. It is the same as
444 \fB\-\-color\-moved\-ws=no\fR\&.
447 \-\-word\-diff[=<mode>]
448 .RS 4
449 Show a word diff, using the <mode> to delimit changed words\&. By default, words are delimited by whitespace; see
450 \fB\-\-word\-diff\-regex\fR
451 below\&. The <mode> defaults to
452 \fIplain\fR, and must be one of:
454 color
455 .RS 4
456 Highlight changed words using only colors\&. Implies
457 \fB\-\-color\fR\&.
460 plain
461 .RS 4
462 Show words as
463 \fB[\-removed\-]\fR
465 \fB{+added+}\fR\&. Makes no attempts to escape the delimiters if they appear in the input, so the output may be ambiguous\&.
468 porcelain
469 .RS 4
470 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
471 \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
472 \fB~\fR
473 on a line of its own\&.
476 none
477 .RS 4
478 Disable word diff again\&.
481 Note that despite the name of the first mode, color is used to highlight the changed parts in all modes if enabled\&.
484 \-\-word\-diff\-regex=<regex>
485 .RS 4
486 Use <regex> to decide what a word is, instead of considering runs of non\-whitespace to be a word\&. Also implies
487 \fB\-\-word\-diff\fR
488 unless it was already enabled\&.
490 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
491 \fB|[^[:space:]]\fR
492 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\&.
494 For example,
495 \fB\-\-word\-diff\-regex=\&.\fR
496 will treat each character as a word and, correspondingly, show differences character by character\&.
498 The regex can also be set via a diff driver or configuration option, see
499 \fBgitattributes\fR(5)
501 \fBgit-config\fR(1)\&. Giving it explicitly overrides any diff driver or configuration setting\&. Diff drivers override configuration settings\&.
504 \-\-color\-words[=<regex>]
505 .RS 4
506 Equivalent to
507 \fB\-\-word\-diff=color\fR
508 plus (if a regex was specified)
509 \fB\-\-word\-diff\-regex=<regex>\fR\&.
512 \-\-no\-renames
513 .RS 4
514 Turn off rename detection, even when the configuration file gives the default to do so\&.
517 \-\-[no\-]rename\-empty
518 .RS 4
519 Whether to use empty blobs as rename source\&.
522 \-\-check
523 .RS 4
524 Warn if changes introduce conflict markers or whitespace errors\&. What are considered whitespace errors is controlled by
525 \fBcore\&.whitespace\fR
526 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\&.
529 \-\-ws\-error\-highlight=<kind>
530 .RS 4
531 Highlight whitespace errors in the
532 \fBcontext\fR,
533 \fBold\fR
535 \fBnew\fR
536 lines of the diff\&. Multiple values are separated by comma,
537 \fBnone\fR
538 resets previous values,
539 \fBdefault\fR
540 reset the list to
541 \fBnew\fR
543 \fBall\fR
544 is a shorthand for
545 \fBold,new,context\fR\&. When this option is not given, and the configuration variable
546 \fBdiff\&.wsErrorHighlight\fR
547 is not set, only whitespace errors in
548 \fBnew\fR
549 lines are highlighted\&. The whitespace errors are colored with
550 \fBcolor\&.diff\&.whitespace\fR\&.
553 \-\-full\-index
554 .RS 4
555 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\&.
558 \-\-binary
559 .RS 4
560 In addition to
561 \fB\-\-full\-index\fR, output a binary diff that can be applied with
562 \fBgit\-apply\fR\&. Implies
563 \fB\-\-patch\fR\&.
566 \-\-abbrev[=<n>]
567 .RS 4
568 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
569 \fI<n>\fR
570 hexdigits long that uniquely refers the object\&. In diff\-patch output format,
571 \fB\-\-full\-index\fR
572 takes higher precedence, i\&.e\&. if
573 \fB\-\-full\-index\fR
574 is specified, full blob names will be shown regardless of
575 \fB\-\-abbrev\fR\&. Non default number of digits can be specified with
576 \fB\-\-abbrev=<n>\fR\&.
579 \-B[<n>][/<m>], \-\-break\-rewrites[=[<n>][/<m>]]
580 .RS 4
581 Break complete rewrite changes into pairs of delete and create\&. This serves two purposes:
583 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
584 \fBm\fR
585 controls this aspect of the \-B option (defaults to 60%)\&.
586 \fB\-B/70%\fR
587 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)\&.
589 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
590 \fBn\fR
591 controls this aspect of the \-B option (defaults to 50%)\&.
592 \fB\-B20%\fR
593 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\&.
596 \-M[<n>], \-\-find\-renames[=<n>]
597 .RS 4
598 Detect renames\&. If
599 \fBn\fR
600 is specified, it is a threshold on the similarity index (i\&.e\&. amount of addition/deletions compared to the file\(cqs size)\&. For example,
601 \fB\-M90%\fR
602 means Git should consider a delete/add pair to be a rename if more than 90% of the file hasn\(cqt changed\&. Without a
603 \fB%\fR
604 sign, the number is to be read as a fraction, with a decimal point before it\&. I\&.e\&.,
605 \fB\-M5\fR
606 becomes 0\&.5, and is thus the same as
607 \fB\-M50%\fR\&. Similarly,
608 \fB\-M05\fR
609 is the same as
610 \fB\-M5%\fR\&. To limit detection to exact renames, use
611 \fB\-M100%\fR\&. The default similarity index is 50%\&.
614 \-C[<n>], \-\-find\-copies[=<n>]
615 .RS 4
616 Detect copies as well as renames\&. See also
617 \fB\-\-find\-copies\-harder\fR\&. If
618 \fBn\fR
619 is specified, it has the same meaning as for
620 \fB\-M<n>\fR\&.
623 \-\-find\-copies\-harder
624 .RS 4
625 For performance reasons, by default,
626 \fB\-C\fR
627 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
628 \fB\-C\fR
629 option has the same effect\&.
632 \-D, \-\-irreversible\-delete
633 .RS 4
634 Omit the preimage for deletes, i\&.e\&. print only the header but not the diff between the preimage and
635 \fB/dev/null\fR\&. The resulting patch is not meant to be applied with
636 \fBpatch\fR
638 \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\&.
640 When used together with
641 \fB\-B\fR, omit also the preimage in the deletion part of a delete/create pair\&.
644 \-l<num>
645 .RS 4
647 \fB\-M\fR
649 \fB\-C\fR
650 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\&.
653 \-\-diff\-filter=[(A|C|D|M|R|T|U|X|B)\&...[*]]
654 .RS 4
655 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
656 \fB*\fR
657 (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\&.
659 Also, these upper\-case letters can be downcased to exclude\&. E\&.g\&.
660 \fB\-\-diff\-filter=ad\fR
661 excludes added and deleted paths\&.
663 Note that not all diffs can feature all types\&. For instance, copied and renamed entries cannot appear if detection for those types is disabled\&.
666 \-S<string>
667 .RS 4
668 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\&.
670 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
671 \fB\-S\fR, and keep going until you get the very first version of the block\&.
673 Binary files are searched as well\&.
676 \-G<regex>
677 .RS 4
678 Look for differences whose patch text contains added/removed lines that match <regex>\&.
680 To illustrate the difference between
681 \fB\-S<regex> \-\-pickaxe\-regex\fR
683 \fB\-G<regex>\fR, consider a commit with the following diff in the same file:
685 .if n \{\
686 .RS 4
689 +    return frotz(nitfol, two\->ptr, 1, 0);
690 \&.\&.\&.
691 \-    hit = frotz(nitfol, mf2\&.ptr, 1, 0);
693 .if n \{\
697 While
698 \fBgit log \-G"frotz\e(nitfol"\fR
699 will show this commit,
700 \fBgit log \-S"frotz\e(nitfol" \-\-pickaxe\-regex\fR
701 will not (because the number of occurrences of that string did not change)\&.
703 Unless
704 \fB\-\-text\fR
705 is supplied patches of binary files without a textconv filter will be ignored\&.
707 See the
708 \fIpickaxe\fR
709 entry in
710 \fBgitdiffcore\fR(7)
711 for more information\&.
714 \-\-find\-object=<object\-id>
715 .RS 4
716 Look for differences that change the number of occurrences of the specified object\&. Similar to
717 \fB\-S\fR, just the argument is different in that it doesn\(cqt search for a specific string but for a specific object id\&.
719 The object can be a blob or a submodule commit\&. It implies the
720 \fB\-t\fR
721 option in
722 \fBgit\-log\fR
723 to also find trees\&.
726 \-\-pickaxe\-all
727 .RS 4
728 When
729 \fB\-S\fR
731 \fB\-G\fR
732 finds a change, show all the changes in that changeset, not just the files that contain the change in <string>\&.
735 \-\-pickaxe\-regex
736 .RS 4
737 Treat the <string> given to
738 \fB\-S\fR
739 as an extended POSIX regular expression to match\&.
742 \-O<orderfile>
743 .RS 4
744 Control the order in which files appear in the output\&. This overrides the
745 \fBdiff\&.orderFile\fR
746 configuration variable (see
747 \fBgit-config\fR(1))\&. To cancel
748 \fBdiff\&.orderFile\fR, use
749 \fB\-O/dev/null\fR\&.
751 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\&.
753 <orderfile> is parsed as follows:
755 .RS 4
756 .ie n \{\
757 \h'-04'\(bu\h'+03'\c
759 .el \{\
760 .sp -1
761 .IP \(bu 2.3
763 Blank lines are ignored, so they can be used as separators for readability\&.
766 .RS 4
767 .ie n \{\
768 \h'-04'\(bu\h'+03'\c
770 .el \{\
771 .sp -1
772 .IP \(bu 2.3
774 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\&.
777 .RS 4
778 .ie n \{\
779 \h'-04'\(bu\h'+03'\c
781 .el \{\
782 .sp -1
783 .IP \(bu 2.3
785 Each other line contains a single pattern\&.
788 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"\&.
791 \-\-skip\-to=<file>, \-\-rotate\-to=<file>
792 .RS 4
793 Discard the files before the named <file> from the output (i\&.e\&.
794 \fIskip to\fR), or move them to the end of the output (i\&.e\&.
795 \fIrotate to\fR)\&. These were invented primarily for use of the
796 \fBgit difftool\fR
797 command, and may not be very useful otherwise\&.
801 .RS 4
802 Swap two inputs; that is, show differences from index or on\-disk file to tree contents\&.
805 \-\-relative[=<path>], \-\-no\-relative
806 .RS 4
807 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\&.
808 \fB\-\-no\-relative\fR
809 can be used to countermand both
810 \fBdiff\&.relative\fR
811 config option and previous
812 \fB\-\-relative\fR\&.
815 \-a, \-\-text
816 .RS 4
817 Treat all files as text\&.
820 \-\-ignore\-cr\-at\-eol
821 .RS 4
822 Ignore carriage\-return at the end of line when doing a comparison\&.
825 \-\-ignore\-space\-at\-eol
826 .RS 4
827 Ignore changes in whitespace at EOL\&.
830 \-b, \-\-ignore\-space\-change
831 .RS 4
832 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\&.
835 \-w, \-\-ignore\-all\-space
836 .RS 4
837 Ignore whitespace when comparing lines\&. This ignores differences even if one line has whitespace where the other line has none\&.
840 \-\-ignore\-blank\-lines
841 .RS 4
842 Ignore changes whose lines are all blank\&.
845 \-I<regex>, \-\-ignore\-matching\-lines=<regex>
846 .RS 4
847 Ignore changes whose all lines match <regex>\&. This option may be specified more than once\&.
850 \-\-inter\-hunk\-context=<lines>
851 .RS 4
852 Show the context between diff hunks, up to the specified number of lines, thereby fusing hunks that are close to each other\&. Defaults to
853 \fBdiff\&.interHunkContext\fR
854 or 0 if the config option is unset\&.
857 \-W, \-\-function\-context
858 .RS 4
859 Show whole function as context lines for each change\&. The function names are determined in the same way as
860 \fBgit diff\fR
861 works out patch hunk headers (see
862 \fIDefining a custom hunk\-header\fR
864 \fBgitattributes\fR(5))\&.
867 \-\-exit\-code
868 .RS 4
869 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\&.
872 \-\-quiet
873 .RS 4
874 Disable all output of the program\&. Implies
875 \fB\-\-exit\-code\fR\&.
878 \-\-ext\-diff
879 .RS 4
880 Allow an external diff helper to be executed\&. If you set an external diff driver with
881 \fBgitattributes\fR(5), you need to use this option with
882 \fBgit-log\fR(1)
883 and friends\&.
886 \-\-no\-ext\-diff
887 .RS 4
888 Disallow external diff drivers\&.
891 \-\-textconv, \-\-no\-textconv
892 .RS 4
893 Allow (or disallow) external text conversion filters to be run when comparing binary files\&. See
894 \fBgitattributes\fR(5)
895 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
896 \fBgit-diff\fR(1)
898 \fBgit-log\fR(1), but not for
899 \fBgit-format-patch\fR(1)
900 or diff plumbing commands\&.
903 \-\-ignore\-submodules[=<when>]
904 .RS 4
905 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
906 \fIignore\fR
907 option in
908 \fBgit-config\fR(1)
910 \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\&.
913 \-\-src\-prefix=<prefix>
914 .RS 4
915 Show the given source prefix instead of "a/"\&.
918 \-\-dst\-prefix=<prefix>
919 .RS 4
920 Show the given destination prefix instead of "b/"\&.
923 \-\-no\-prefix
924 .RS 4
925 Do not show any source or destination prefix\&.
928 \-\-line\-prefix=<prefix>
929 .RS 4
930 Prepend an additional prefix to every line of output\&.
933 \-\-ita\-invisible\-in\-index
934 .RS 4
935 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
936 \fB\-\-ita\-visible\-in\-index\fR\&. Both options are experimental and could be removed in future\&.
939 For more detailed explanation on these common options, see also \fBgitdiffcore\fR(7)\&.
941 <tree\-ish>
942 .RS 4
943 The id of a tree object\&.
946 <path>\&...
947 .RS 4
948 If provided, the results are limited to a subset of files matching one of the provided pathspecs\&.
952 .RS 4
953 recurse into sub\-trees
957 .RS 4
958 show tree entry itself as well as subtrees\&. Implies \-r\&.
961 \-\-root
962 .RS 4
963 When
964 \fB\-\-root\fR
965 is specified the initial commit will be shown as a big creation event\&. This is equivalent to a diff against the NULL tree\&.
968 \-\-merge\-base
969 .RS 4
970 Instead of comparing the <tree\-ish>s directly, use the merge base between the two <tree\-ish>s as the "before" side\&. There must be two <tree\-ish>s given and they must both be commits\&.
973 \-\-stdin
974 .RS 4
975 When
976 \fB\-\-stdin\fR
977 is specified, the command does not take <tree\-ish> arguments from the command line\&. Instead, it reads lines containing either two <tree>, one <commit>, or a list of <commit> from its standard input\&. (Use a single space as separator\&.)
979 When two trees are given, it compares the first tree with the second\&. When a single commit is given, it compares the commit with its parents\&. The remaining commits, when given, are used as if they are parents of the first commit\&.
981 When comparing two trees, the ID of both trees (separated by a space and terminated by a newline) is printed before the difference\&. When comparing commits, the ID of the first (or only) commit, followed by a newline, is printed\&.
983 The following flags further affect the behavior when comparing commits (but not trees)\&.
987 .RS 4
988 By default,
989 \fIgit diff\-tree \-\-stdin\fR
990 does not show differences for merge commits\&. With this flag, it shows differences to that commit from all of its parents\&. See also
991 \fB\-c\fR\&.
995 .RS 4
996 By default,
997 \fIgit diff\-tree \-\-stdin\fR
998 shows differences, either in machine\-readable form (without
999 \fB\-p\fR) or in patch form (with
1000 \fB\-p\fR)\&. This output can be suppressed\&. It is only useful with
1001 \fB\-v\fR
1002 flag\&.
1006 .RS 4
1007 This flag causes
1008 \fIgit diff\-tree \-\-stdin\fR
1009 to also show the commit message before the differences\&.
1012 \-\-pretty[=<format>], \-\-format=<format>
1013 .RS 4
1014 Pretty\-print the contents of the commit logs in a given format, where
1015 \fI<format>\fR
1016 can be one of
1017 \fIoneline\fR,
1018 \fIshort\fR,
1019 \fImedium\fR,
1020 \fIfull\fR,
1021 \fIfuller\fR,
1022 \fIreference\fR,
1023 \fIemail\fR,
1024 \fIraw\fR,
1025 \fIformat:<string>\fR
1027 \fItformat:<string>\fR\&. When
1028 \fI<format>\fR
1029 is none of the above, and has
1030 \fI%placeholder\fR
1031 in it, it acts as if
1032 \fI\-\-pretty=tformat:<format>\fR
1033 were given\&.
1035 See the "PRETTY FORMATS" section for some additional details for each format\&. When
1036 \fI=<format>\fR
1037 part is omitted, it defaults to
1038 \fImedium\fR\&.
1040 Note: you can specify the default pretty format in the repository configuration (see
1041 \fBgit-config\fR(1))\&.
1044 \-\-abbrev\-commit
1045 .RS 4
1046 Instead of showing the full 40\-byte hexadecimal commit object name, show a prefix that names the object uniquely\&. "\-\-abbrev=<n>" (which also modifies diff output, if it is displayed) option can be used to specify the minimum length of the prefix\&.
1048 This should make "\-\-pretty=oneline" a whole lot more readable for people using 80\-column terminals\&.
1051 \-\-no\-abbrev\-commit
1052 .RS 4
1053 Show the full 40\-byte hexadecimal commit object name\&. This negates
1054 \fB\-\-abbrev\-commit\fR, either explicit or implied by other options such as "\-\-oneline"\&. It also overrides the
1055 \fBlog\&.abbrevCommit\fR
1056 variable\&.
1059 \-\-oneline
1060 .RS 4
1061 This is a shorthand for "\-\-pretty=oneline \-\-abbrev\-commit" used together\&.
1064 \-\-encoding=<encoding>
1065 .RS 4
1066 Commit objects record the character encoding used for the log message in their encoding header; this option can be used to tell the command to re\-code the commit log message in the encoding preferred by the user\&. For non plumbing commands this defaults to UTF\-8\&. Note that if an object claims to be encoded in
1067 \fBX\fR
1068 and we are outputting in
1069 \fBX\fR, we will output the object verbatim; this means that invalid sequences in the original commit may be copied to the output\&. Likewise, if iconv(3) fails to convert the commit, we will quietly output the original object verbatim\&.
1072 \-\-expand\-tabs=<n>, \-\-expand\-tabs, \-\-no\-expand\-tabs
1073 .RS 4
1074 Perform a tab expansion (replace each tab with enough spaces to fill to the next display column that is multiple of
1075 \fI<n>\fR) in the log message before showing it in the output\&.
1076 \fB\-\-expand\-tabs\fR
1077 is a short\-hand for
1078 \fB\-\-expand\-tabs=8\fR, and
1079 \fB\-\-no\-expand\-tabs\fR
1080 is a short\-hand for
1081 \fB\-\-expand\-tabs=0\fR, which disables tab expansion\&.
1083 By default, tabs are expanded in pretty formats that indent the log message by 4 spaces (i\&.e\&.
1084 \fImedium\fR, which is the default,
1085 \fIfull\fR, and
1086 \fIfuller\fR)\&.
1089 \-\-notes[=<ref>]
1090 .RS 4
1091 Show the notes (see
1092 \fBgit-notes\fR(1)) that annotate the commit, when showing the commit log message\&. This is the default for
1093 \fBgit log\fR,
1094 \fBgit show\fR
1096 \fBgit whatchanged\fR
1097 commands when there is no
1098 \fB\-\-pretty\fR,
1099 \fB\-\-format\fR, or
1100 \fB\-\-oneline\fR
1101 option given on the command line\&.
1103 By default, the notes shown are from the notes refs listed in the
1104 \fBcore\&.notesRef\fR
1106 \fBnotes\&.displayRef\fR
1107 variables (or corresponding environment overrides)\&. See
1108 \fBgit-config\fR(1)
1109 for more details\&.
1111 With an optional
1112 \fI<ref>\fR
1113 argument, use the ref to find the notes to display\&. The ref can specify the full refname when it begins with
1114 \fBrefs/notes/\fR; when it begins with
1115 \fBnotes/\fR,
1116 \fBrefs/\fR
1117 and otherwise
1118 \fBrefs/notes/\fR
1119 is prefixed to form a full name of the ref\&.
1121 Multiple \-\-notes options can be combined to control which notes are being displayed\&. Examples: "\-\-notes=foo" will show only notes from "refs/notes/foo"; "\-\-notes=foo \-\-notes" will show both notes from "refs/notes/foo" and from the default notes ref(s)\&.
1124 \-\-no\-notes
1125 .RS 4
1126 Do not show notes\&. This negates the above
1127 \fB\-\-notes\fR
1128 option, by resetting the list of notes refs from which notes are shown\&. Options are parsed in the order given on the command line, so e\&.g\&. "\-\-notes \-\-notes=foo \-\-no\-notes \-\-notes=bar" will only show notes from "refs/notes/bar"\&.
1131 \-\-show\-notes[=<ref>], \-\-[no\-]standard\-notes
1132 .RS 4
1133 These options are deprecated\&. Use the above \-\-notes/\-\-no\-notes options instead\&.
1136 \-\-show\-signature
1137 .RS 4
1138 Check the validity of a signed commit object by passing the signature to
1139 \fBgpg \-\-verify\fR
1140 and show the output\&.
1143 \-\-no\-commit\-id
1144 .RS 4
1145 \fIgit diff\-tree\fR
1146 outputs a line with the commit ID when applicable\&. This flag suppressed the commit ID output\&.
1150 .RS 4
1151 This flag changes the way a merge commit is displayed (which means it is useful only when the command is given one <tree\-ish>, or
1152 \fB\-\-stdin\fR)\&. It shows the differences from each of the parents to the merge result simultaneously instead of showing pairwise diff between a parent and the result one at a time (which is what the
1153 \fB\-m\fR
1154 option does)\&. Furthermore, it lists only files which were modified from all parents\&.
1157 \-\-cc
1158 .RS 4
1159 This flag changes the way a merge commit patch is displayed, in a similar way to the
1160 \fB\-c\fR
1161 option\&. It implies the
1162 \fB\-c\fR
1164 \fB\-p\fR
1165 options and further compresses the patch output by omitting uninteresting hunks whose the contents in the parents have only two variants and the merge result picks one of them without modification\&. When all hunks are uninteresting, the commit itself and the commit log message is not shown, just like in any other "empty diff" case\&.
1168 \-\-combined\-all\-paths
1169 .RS 4
1170 This flag causes combined diffs (used for merge commits) to list the name of the file from all parents\&. It thus only has effect when \-c or \-\-cc are specified, and is likely only useful if filename changes are detected (i\&.e\&. when either rename or copy detection have been requested)\&.
1173 \-\-always
1174 .RS 4
1175 Show the commit itself and the commit log message even if the diff itself is empty\&.
1177 .SH "PRETTY FORMATS"
1179 If the commit is a merge, and if the pretty\-format is not \fIoneline\fR, \fIemail\fR or \fIraw\fR, an additional line is inserted before the \fIAuthor:\fR line\&. This line begins with "Merge: " and the hashes of ancestral commits are printed, separated by spaces\&. Note that the listed commits may not necessarily be the list of the \fBdirect\fR parent commits if you have limited your view of history: for example, if you are only interested in changes related to a certain directory or file\&.
1181 There are several built\-in formats, and you can define additional formats by setting a pretty\&.<name> config option to either another format name, or a \fIformat:\fR string, as described below (see \fBgit-config\fR(1))\&. Here are the details of the built\-in formats:
1183 .RS 4
1184 .ie n \{\
1185 \h'-04'\(bu\h'+03'\c
1187 .el \{\
1188 .sp -1
1189 .IP \(bu 2.3
1191 \fIoneline\fR
1193 .if n \{\
1194 .RS 4
1197 <hash> <title\-line>
1199 .if n \{\
1203 This is designed to be as compact as possible\&.
1206 .RS 4
1207 .ie n \{\
1208 \h'-04'\(bu\h'+03'\c
1210 .el \{\
1211 .sp -1
1212 .IP \(bu 2.3
1214 \fIshort\fR
1216 .if n \{\
1217 .RS 4
1220 commit <hash>
1221 Author: <author>
1223 .if n \{\
1227 .if n \{\
1228 .RS 4
1231 <title\-line>
1233 .if n \{\
1238 .RS 4
1239 .ie n \{\
1240 \h'-04'\(bu\h'+03'\c
1242 .el \{\
1243 .sp -1
1244 .IP \(bu 2.3
1246 \fImedium\fR
1248 .if n \{\
1249 .RS 4
1252 commit <hash>
1253 Author: <author>
1254 Date:   <author\-date>
1256 .if n \{\
1260 .if n \{\
1261 .RS 4
1264 <title\-line>
1266 .if n \{\
1270 .if n \{\
1271 .RS 4
1274 <full\-commit\-message>
1276 .if n \{\
1281 .RS 4
1282 .ie n \{\
1283 \h'-04'\(bu\h'+03'\c
1285 .el \{\
1286 .sp -1
1287 .IP \(bu 2.3
1289 \fIfull\fR
1291 .if n \{\
1292 .RS 4
1295 commit <hash>
1296 Author: <author>
1297 Commit: <committer>
1299 .if n \{\
1303 .if n \{\
1304 .RS 4
1307 <title\-line>
1309 .if n \{\
1313 .if n \{\
1314 .RS 4
1317 <full\-commit\-message>
1319 .if n \{\
1324 .RS 4
1325 .ie n \{\
1326 \h'-04'\(bu\h'+03'\c
1328 .el \{\
1329 .sp -1
1330 .IP \(bu 2.3
1332 \fIfuller\fR
1334 .if n \{\
1335 .RS 4
1338 commit <hash>
1339 Author:     <author>
1340 AuthorDate: <author\-date>
1341 Commit:     <committer>
1342 CommitDate: <committer\-date>
1344 .if n \{\
1348 .if n \{\
1349 .RS 4
1352 <title\-line>
1354 .if n \{\
1358 .if n \{\
1359 .RS 4
1362 <full\-commit\-message>
1364 .if n \{\
1369 .RS 4
1370 .ie n \{\
1371 \h'-04'\(bu\h'+03'\c
1373 .el \{\
1374 .sp -1
1375 .IP \(bu 2.3
1377 \fIreference\fR
1379 .if n \{\
1380 .RS 4
1383 <abbrev\-hash> (<title\-line>, <short\-author\-date>)
1385 .if n \{\
1389 This format is used to refer to another commit in a commit message and is the same as
1390 \fB\-\-pretty=\(aqformat:%C(auto)%h (%s, %ad)\(aq\fR\&. By default, the date is formatted with
1391 \fB\-\-date=short\fR
1392 unless another
1393 \fB\-\-date\fR
1394 option is explicitly specified\&. As with any
1395 \fBformat:\fR
1396 with format placeholders, its output is not affected by other options like
1397 \fB\-\-decorate\fR
1399 \fB\-\-walk\-reflogs\fR\&.
1402 .RS 4
1403 .ie n \{\
1404 \h'-04'\(bu\h'+03'\c
1406 .el \{\
1407 .sp -1
1408 .IP \(bu 2.3
1410 \fIemail\fR
1412 .if n \{\
1413 .RS 4
1416 From <hash> <date>
1417 From: <author>
1418 Date: <author\-date>
1419 Subject: [PATCH] <title\-line>
1421 .if n \{\
1425 .if n \{\
1426 .RS 4
1429 <full\-commit\-message>
1431 .if n \{\
1436 .RS 4
1437 .ie n \{\
1438 \h'-04'\(bu\h'+03'\c
1440 .el \{\
1441 .sp -1
1442 .IP \(bu 2.3
1444 \fImboxrd\fR
1446 Like
1447 \fIemail\fR, but lines in the commit message starting with "From " (preceded by zero or more ">") are quoted with ">" so they aren\(cqt confused as starting a new commit\&.
1450 .RS 4
1451 .ie n \{\
1452 \h'-04'\(bu\h'+03'\c
1454 .el \{\
1455 .sp -1
1456 .IP \(bu 2.3
1458 \fIraw\fR
1461 \fIraw\fR
1462 format shows the entire commit exactly as stored in the commit object\&. Notably, the hashes are displayed in full, regardless of whether \-\-abbrev or \-\-no\-abbrev are used, and
1463 \fIparents\fR
1464 information show the true parent commits, without taking grafts or history simplification into account\&. Note that this format affects the way commits are displayed, but not the way the diff is shown e\&.g\&. with
1465 \fBgit log \-\-raw\fR\&. To get full object names in a raw diff format, use
1466 \fB\-\-no\-abbrev\fR\&.
1469 .RS 4
1470 .ie n \{\
1471 \h'-04'\(bu\h'+03'\c
1473 .el \{\
1474 .sp -1
1475 .IP \(bu 2.3
1477 \fIformat:<format\-string>\fR
1480 \fIformat:<format\-string>\fR
1481 format allows you to specify which information you want to show\&. It works a little bit like printf format, with the notable exception that you get a newline with
1482 \fI%n\fR
1483 instead of
1484 \fI\en\fR\&.
1486 E\&.g,
1487 \fIformat:"The author of %h was %an, %ar%nThe title was >>%s<<%n"\fR
1488 would show something like this:
1490 .if n \{\
1491 .RS 4
1494 The author of fe6e0ee was Junio C Hamano, 23 hours ago
1495 The title was >>t4119: test autocomputing \-p<n> for traditional diff input\&.<<
1497 .if n \{\
1501 The placeholders are:
1503 .RS 4
1504 .ie n \{\
1505 \h'-04'\(bu\h'+03'\c
1507 .el \{\
1508 .sp -1
1509 .IP \(bu 2.3
1511 Placeholders that expand to a single literal character:
1513 \fI%n\fR
1514 .RS 4
1515 newline
1518 \fI%%\fR
1519 .RS 4
1520 a raw
1521 \fI%\fR
1524 \fI%x00\fR
1525 .RS 4
1526 print a byte from a hex code
1530 .RS 4
1531 .ie n \{\
1532 \h'-04'\(bu\h'+03'\c
1534 .el \{\
1535 .sp -1
1536 .IP \(bu 2.3
1538 Placeholders that affect formatting of later placeholders:
1540 \fI%Cred\fR
1541 .RS 4
1542 switch color to red
1545 \fI%Cgreen\fR
1546 .RS 4
1547 switch color to green
1550 \fI%Cblue\fR
1551 .RS 4
1552 switch color to blue
1555 \fI%Creset\fR
1556 .RS 4
1557 reset color
1560 \fI%C(\&...)\fR
1561 .RS 4
1562 color specification, as described under Values in the "CONFIGURATION FILE" section of
1563 \fBgit-config\fR(1)\&. By default, colors are shown only when enabled for log output (by
1564 \fBcolor\&.diff\fR,
1565 \fBcolor\&.ui\fR, or
1566 \fB\-\-color\fR, and respecting the
1567 \fBauto\fR
1568 settings of the former if we are going to a terminal)\&.
1569 \fB%C(auto,\&.\&.\&.)\fR
1570 is accepted as a historical synonym for the default (e\&.g\&.,
1571 \fB%C(auto,red)\fR)\&. Specifying
1572 \fB%C(always,\&.\&.\&.)\fR
1573 will show the colors even when color is not otherwise enabled (though consider just using
1574 \fB\-\-color=always\fR
1575 to enable color for the whole output, including this format and anything else git might color)\&.
1576 \fBauto\fR
1577 alone (i\&.e\&.
1578 \fB%C(auto)\fR) will turn on auto coloring on the next placeholders until the color is switched again\&.
1581 \fI%m\fR
1582 .RS 4
1583 left (\fB<\fR), right (\fB>\fR) or boundary (\fB\-\fR) mark
1586 \fI%w([<w>[,<i1>[,<i2>]]])\fR
1587 .RS 4
1588 switch line wrapping, like the \-w option of
1589 \fBgit-shortlog\fR(1)\&.
1592 \fI%<(<N>[,trunc|ltrunc|mtrunc])\fR
1593 .RS 4
1594 make the next placeholder take at least N columns, padding spaces on the right if necessary\&. Optionally truncate at the beginning (ltrunc), the middle (mtrunc) or the end (trunc) if the output is longer than N columns\&. Note that truncating only works correctly with N >= 2\&.
1597 \fI%<|(<N>)\fR
1598 .RS 4
1599 make the next placeholder take at least until Nth columns, padding spaces on the right if necessary
1602 \fI%>(<N>)\fR, \fI%>|(<N>)\fR
1603 .RS 4
1604 similar to
1605 \fI%<(<N>)\fR,
1606 \fI%<|(<N>)\fR
1607 respectively, but padding spaces on the left
1610 \fI%>>(<N>)\fR, \fI%>>|(<N>)\fR
1611 .RS 4
1612 similar to
1613 \fI%>(<N>)\fR,
1614 \fI%>|(<N>)\fR
1615 respectively, except that if the next placeholder takes more spaces than given and there are spaces on its left, use those spaces
1618 \fI%><(<N>)\fR, \fI%><|(<N>)\fR
1619 .RS 4
1620 similar to
1621 \fI%<(<N>)\fR,
1622 \fI%<|(<N>)\fR
1623 respectively, but padding both sides (i\&.e\&. the text is centered)
1627 .RS 4
1628 .ie n \{\
1629 \h'-04'\(bu\h'+03'\c
1631 .el \{\
1632 .sp -1
1633 .IP \(bu 2.3
1635 Placeholders that expand to information extracted from the commit:
1637 \fI%H\fR
1638 .RS 4
1639 commit hash
1642 \fI%h\fR
1643 .RS 4
1644 abbreviated commit hash
1647 \fI%T\fR
1648 .RS 4
1649 tree hash
1652 \fI%t\fR
1653 .RS 4
1654 abbreviated tree hash
1657 \fI%P\fR
1658 .RS 4
1659 parent hashes
1662 \fI%p\fR
1663 .RS 4
1664 abbreviated parent hashes
1667 \fI%an\fR
1668 .RS 4
1669 author name
1672 \fI%aN\fR
1673 .RS 4
1674 author name (respecting \&.mailmap, see
1675 \fBgit-shortlog\fR(1)
1677 \fBgit-blame\fR(1))
1680 \fI%ae\fR
1681 .RS 4
1682 author email
1685 \fI%aE\fR
1686 .RS 4
1687 author email (respecting \&.mailmap, see
1688 \fBgit-shortlog\fR(1)
1690 \fBgit-blame\fR(1))
1693 \fI%al\fR
1694 .RS 4
1695 author email local\-part (the part before the
1696 \fI@\fR
1697 sign)
1700 \fI%aL\fR
1701 .RS 4
1702 author local\-part (see
1703 \fI%al\fR) respecting \&.mailmap, see
1704 \fBgit-shortlog\fR(1)
1706 \fBgit-blame\fR(1))
1709 \fI%ad\fR
1710 .RS 4
1711 author date (format respects \-\-date= option)
1714 \fI%aD\fR
1715 .RS 4
1716 author date, RFC2822 style
1719 \fI%ar\fR
1720 .RS 4
1721 author date, relative
1724 \fI%at\fR
1725 .RS 4
1726 author date, UNIX timestamp
1729 \fI%ai\fR
1730 .RS 4
1731 author date, ISO 8601\-like format
1734 \fI%aI\fR
1735 .RS 4
1736 author date, strict ISO 8601 format
1739 \fI%as\fR
1740 .RS 4
1741 author date, short format (\fBYYYY\-MM\-DD\fR)
1744 \fI%ah\fR
1745 .RS 4
1746 author date, human style (like the
1747 \fB\-\-date=human\fR
1748 option of
1749 \fBgit-rev-list\fR(1))
1752 \fI%cn\fR
1753 .RS 4
1754 committer name
1757 \fI%cN\fR
1758 .RS 4
1759 committer name (respecting \&.mailmap, see
1760 \fBgit-shortlog\fR(1)
1762 \fBgit-blame\fR(1))
1765 \fI%ce\fR
1766 .RS 4
1767 committer email
1770 \fI%cE\fR
1771 .RS 4
1772 committer email (respecting \&.mailmap, see
1773 \fBgit-shortlog\fR(1)
1775 \fBgit-blame\fR(1))
1778 \fI%cl\fR
1779 .RS 4
1780 committer email local\-part (the part before the
1781 \fI@\fR
1782 sign)
1785 \fI%cL\fR
1786 .RS 4
1787 committer local\-part (see
1788 \fI%cl\fR) respecting \&.mailmap, see
1789 \fBgit-shortlog\fR(1)
1791 \fBgit-blame\fR(1))
1794 \fI%cd\fR
1795 .RS 4
1796 committer date (format respects \-\-date= option)
1799 \fI%cD\fR
1800 .RS 4
1801 committer date, RFC2822 style
1804 \fI%cr\fR
1805 .RS 4
1806 committer date, relative
1809 \fI%ct\fR
1810 .RS 4
1811 committer date, UNIX timestamp
1814 \fI%ci\fR
1815 .RS 4
1816 committer date, ISO 8601\-like format
1819 \fI%cI\fR
1820 .RS 4
1821 committer date, strict ISO 8601 format
1824 \fI%cs\fR
1825 .RS 4
1826 committer date, short format (\fBYYYY\-MM\-DD\fR)
1829 \fI%ch\fR
1830 .RS 4
1831 committer date, human style (like the
1832 \fB\-\-date=human\fR
1833 option of
1834 \fBgit-rev-list\fR(1))
1837 \fI%d\fR
1838 .RS 4
1839 ref names, like the \-\-decorate option of
1840 \fBgit-log\fR(1)
1843 \fI%D\fR
1844 .RS 4
1845 ref names without the " (", ")" wrapping\&.
1848 \fI%(describe[:options])\fR
1849 .RS 4
1850 human\-readable name, like
1851 \fBgit-describe\fR(1); empty string for undescribable commits\&. The
1852 \fBdescribe\fR
1853 string may be followed by a colon and zero or more comma\-separated options\&. Descriptions can be inconsistent when tags are added or removed at the same time\&.
1855 .RS 4
1856 .ie n \{\
1857 \h'-04'\(bu\h'+03'\c
1859 .el \{\
1860 .sp -1
1861 .IP \(bu 2.3
1863 \fItags[=<bool\-value>]\fR: Instead of only considering annotated tags, consider lightweight tags as well\&.
1866 .RS 4
1867 .ie n \{\
1868 \h'-04'\(bu\h'+03'\c
1870 .el \{\
1871 .sp -1
1872 .IP \(bu 2.3
1874 \fIabbrev=<number>\fR: Instead of using the default number of hexadecimal digits (which will vary according to the number of objects in the repository with a default of 7) of the abbreviated object name, use <number> digits, or as many digits as needed to form a unique object name\&.
1877 .RS 4
1878 .ie n \{\
1879 \h'-04'\(bu\h'+03'\c
1881 .el \{\
1882 .sp -1
1883 .IP \(bu 2.3
1885 \fImatch=<pattern>\fR: Only consider tags matching the given
1886 \fBglob(7)\fR
1887 pattern, excluding the "refs/tags/" prefix\&.
1890 .RS 4
1891 .ie n \{\
1892 \h'-04'\(bu\h'+03'\c
1894 .el \{\
1895 .sp -1
1896 .IP \(bu 2.3
1898 \fIexclude=<pattern>\fR: Do not consider tags matching the given
1899 \fBglob(7)\fR
1900 pattern, excluding the "refs/tags/" prefix\&.
1904 \fI%S\fR
1905 .RS 4
1906 ref name given on the command line by which the commit was reached (like
1907 \fBgit log \-\-source\fR), only works with
1908 \fBgit log\fR
1911 \fI%e\fR
1912 .RS 4
1913 encoding
1916 \fI%s\fR
1917 .RS 4
1918 subject
1921 \fI%f\fR
1922 .RS 4
1923 sanitized subject line, suitable for a filename
1926 \fI%b\fR
1927 .RS 4
1928 body
1931 \fI%B\fR
1932 .RS 4
1933 raw body (unwrapped subject and body)
1936 \fI%N\fR
1937 .RS 4
1938 commit notes
1941 \fI%GG\fR
1942 .RS 4
1943 raw verification message from GPG for a signed commit
1946 \fI%G?\fR
1947 .RS 4
1948 show "G" for a good (valid) signature, "B" for a bad signature, "U" for a good signature with unknown validity, "X" for a good signature that has expired, "Y" for a good signature made by an expired key, "R" for a good signature made by a revoked key, "E" if the signature cannot be checked (e\&.g\&. missing key) and "N" for no signature
1951 \fI%GS\fR
1952 .RS 4
1953 show the name of the signer for a signed commit
1956 \fI%GK\fR
1957 .RS 4
1958 show the key used to sign a signed commit
1961 \fI%GF\fR
1962 .RS 4
1963 show the fingerprint of the key used to sign a signed commit
1966 \fI%GP\fR
1967 .RS 4
1968 show the fingerprint of the primary key whose subkey was used to sign a signed commit
1971 \fI%GT\fR
1972 .RS 4
1973 show the trust level for the key used to sign a signed commit
1976 \fI%gD\fR
1977 .RS 4
1978 reflog selector, e\&.g\&.,
1979 \fBrefs/stash@{1}\fR
1981 \fBrefs/stash@{2 minutes ago}\fR; the format follows the rules described for the
1982 \fB\-g\fR
1983 option\&. The portion before the
1984 \fB@\fR
1985 is the refname as given on the command line (so
1986 \fBgit log \-g refs/heads/master\fR
1987 would yield
1988 \fBrefs/heads/master@{0}\fR)\&.
1991 \fI%gd\fR
1992 .RS 4
1993 shortened reflog selector; same as
1994 \fB%gD\fR, but the refname portion is shortened for human readability (so
1995 \fBrefs/heads/master\fR
1996 becomes just
1997 \fBmaster\fR)\&.
2000 \fI%gn\fR
2001 .RS 4
2002 reflog identity name
2005 \fI%gN\fR
2006 .RS 4
2007 reflog identity name (respecting \&.mailmap, see
2008 \fBgit-shortlog\fR(1)
2010 \fBgit-blame\fR(1))
2013 \fI%ge\fR
2014 .RS 4
2015 reflog identity email
2018 \fI%gE\fR
2019 .RS 4
2020 reflog identity email (respecting \&.mailmap, see
2021 \fBgit-shortlog\fR(1)
2023 \fBgit-blame\fR(1))
2026 \fI%gs\fR
2027 .RS 4
2028 reflog subject
2031 \fI%(trailers[:options])\fR
2032 .RS 4
2033 display the trailers of the body as interpreted by
2034 \fBgit-interpret-trailers\fR(1)\&. The
2035 \fBtrailers\fR
2036 string may be followed by a colon and zero or more comma\-separated options\&. If any option is provided multiple times the last occurrence wins\&.
2038 .RS 4
2039 .ie n \{\
2040 \h'-04'\(bu\h'+03'\c
2042 .el \{\
2043 .sp -1
2044 .IP \(bu 2.3
2046 \fIkey=<key>\fR: only show trailers with specified <key>\&. Matching is done case\-insensitively and trailing colon is optional\&. If option is given multiple times trailer lines matching any of the keys are shown\&. This option automatically enables the
2047 \fBonly\fR
2048 option so that non\-trailer lines in the trailer block are hidden\&. If that is not desired it can be disabled with
2049 \fBonly=false\fR\&. E\&.g\&.,
2050 \fB%(trailers:key=Reviewed\-by)\fR
2051 shows trailer lines with key
2052 \fBReviewed\-by\fR\&.
2055 .RS 4
2056 .ie n \{\
2057 \h'-04'\(bu\h'+03'\c
2059 .el \{\
2060 .sp -1
2061 .IP \(bu 2.3
2063 \fIonly[=<bool>]\fR: select whether non\-trailer lines from the trailer block should be included\&.
2066 .RS 4
2067 .ie n \{\
2068 \h'-04'\(bu\h'+03'\c
2070 .el \{\
2071 .sp -1
2072 .IP \(bu 2.3
2074 \fIseparator=<sep>\fR: specify a separator inserted between trailer lines\&. When this option is not given each trailer line is terminated with a line feed character\&. The string <sep> may contain the literal formatting codes described above\&. To use comma as separator one must use
2075 \fB%x2C\fR
2076 as it would otherwise be parsed as next option\&. E\&.g\&.,
2077 \fB%(trailers:key=Ticket,separator=%x2C )\fR
2078 shows all trailer lines whose key is "Ticket" separated by a comma and a space\&.
2081 .RS 4
2082 .ie n \{\
2083 \h'-04'\(bu\h'+03'\c
2085 .el \{\
2086 .sp -1
2087 .IP \(bu 2.3
2089 \fIunfold[=<bool>]\fR: make it behave as if interpret\-trailer\(cqs
2090 \fB\-\-unfold\fR
2091 option was given\&. E\&.g\&.,
2092 \fB%(trailers:only,unfold=true)\fR
2093 unfolds and shows all trailer lines\&.
2096 .RS 4
2097 .ie n \{\
2098 \h'-04'\(bu\h'+03'\c
2100 .el \{\
2101 .sp -1
2102 .IP \(bu 2.3
2104 \fIkeyonly[=<bool>]\fR: only show the key part of the trailer\&.
2107 .RS 4
2108 .ie n \{\
2109 \h'-04'\(bu\h'+03'\c
2111 .el \{\
2112 .sp -1
2113 .IP \(bu 2.3
2115 \fIvalueonly[=<bool>]\fR: only show the value part of the trailer\&.
2118 .RS 4
2119 .ie n \{\
2120 \h'-04'\(bu\h'+03'\c
2122 .el \{\
2123 .sp -1
2124 .IP \(bu 2.3
2126 \fIkey_value_separator=<sep>\fR: specify a separator inserted between trailer lines\&. When this option is not given each trailer key\-value pair is separated by ": "\&. Otherwise it shares the same semantics as
2127 \fIseparator=<sep>\fR
2128 above\&.
2133 .if n \{\
2136 .RS 4
2137 .it 1 an-trap
2138 .nr an-no-space-flag 1
2139 .nr an-break-flag 1
2141 .ps +1
2142 \fBNote\fR
2143 .ps -1
2146 Some placeholders may depend on other options given to the revision traversal engine\&. For example, the \fB%g*\fR reflog options will insert an empty string unless we are traversing reflog entries (e\&.g\&., by \fBgit log \-g\fR)\&. The \fB%d\fR and \fB%D\fR placeholders will use the "short" decoration format if \fB\-\-decorate\fR was not already provided on the command line\&.
2147 .sp .5v
2150 The boolean options accept an optional value \fB[=<bool\-value>]\fR\&. The values \fBtrue\fR, \fBfalse\fR, \fBon\fR, \fBoff\fR etc\&. are all accepted\&. See the "boolean" sub\-section in "EXAMPLES" in \fBgit-config\fR(1)\&. If a boolean option is given with no value, it\(cqs enabled\&.
2152 If you add a \fB+\fR (plus sign) after \fI%\fR of a placeholder, a line\-feed is inserted immediately before the expansion if and only if the placeholder expands to a non\-empty string\&.
2154 If you add a \fB\-\fR (minus sign) after \fI%\fR of a placeholder, all consecutive line\-feeds immediately preceding the expansion are deleted if and only if the placeholder expands to an empty string\&.
2156 If you add a ` ` (space) after \fI%\fR of a placeholder, a space is inserted immediately before the expansion if and only if the placeholder expands to a non\-empty string\&.
2158 .RS 4
2159 .ie n \{\
2160 \h'-04'\(bu\h'+03'\c
2162 .el \{\
2163 .sp -1
2164 .IP \(bu 2.3
2166 \fItformat:\fR
2169 \fItformat:\fR
2170 format works exactly like
2171 \fIformat:\fR, except that it provides "terminator" semantics instead of "separator" semantics\&. In other words, each commit has the message terminator character (usually a newline) appended, rather than a separator placed between entries\&. This means that the final entry of a single\-line format will be properly terminated with a new line, just as the "oneline" format does\&. For example:
2173 .if n \{\
2174 .RS 4
2177 $ git log \-2 \-\-pretty=format:%h 4da45bef \e
2178   | perl \-pe \(aq$_ \&.= " \-\- NO NEWLINE\en" unless /\en/\(aq
2179 4da45be
2180 7134973 \-\- NO NEWLINE
2182 $ git log \-2 \-\-pretty=tformat:%h 4da45bef \e
2183   | perl \-pe \(aq$_ \&.= " \-\- NO NEWLINE\en" unless /\en/\(aq
2184 4da45be
2185 7134973
2187 .if n \{\
2191 In addition, any unrecognized string that has a
2192 \fB%\fR
2193 in it is interpreted as if it has
2194 \fBtformat:\fR
2195 in front of it\&. For example, these two are equivalent:
2197 .if n \{\
2198 .RS 4
2201 $ git log \-2 \-\-pretty=tformat:%h 4da45bef
2202 $ git log \-2 \-\-pretty=%h 4da45bef
2204 .if n \{\
2209 .SH "RAW OUTPUT FORMAT"
2211 The raw output format from "git\-diff\-index", "git\-diff\-tree", "git\-diff\-files" and "git diff \-\-raw" are very similar\&.
2213 These commands all compare two sets of things; what is compared differs:
2215 git\-diff\-index <tree\-ish>
2216 .RS 4
2217 compares the <tree\-ish> and the files on the filesystem\&.
2220 git\-diff\-index \-\-cached <tree\-ish>
2221 .RS 4
2222 compares the <tree\-ish> and the index\&.
2225 git\-diff\-tree [\-r] <tree\-ish\-1> <tree\-ish\-2> [<pattern>\&...]
2226 .RS 4
2227 compares the trees named by the two arguments\&.
2230 git\-diff\-files [<pattern>\&...]
2231 .RS 4
2232 compares the index and the files on the filesystem\&.
2235 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\&.
2237 An output line is formatted this way:
2239 .if n \{\
2240 .RS 4
2243 in\-place edit  :100644 100644 bcd1234 0123456 M file0
2244 copy\-edit      :100644 100644 abcd123 1234567 C68 file1 file2
2245 rename\-edit    :100644 100644 abcd123 1234567 R86 file1 file3
2246 create         :000000 100644 0000000 1234567 A file4
2247 delete         :100644 000000 1234567 0000000 D file5
2248 unmerged       :000000 000000 0000000 0000000 U file6
2250 .if n \{\
2255 That is, from the left to the right:
2257 .RS 4
2258 .ie n \{\
2259 \h'-04' 1.\h'+01'\c
2261 .el \{\
2262 .sp -1
2263 .IP "  1." 4.2
2265 a colon\&.
2268 .RS 4
2269 .ie n \{\
2270 \h'-04' 2.\h'+01'\c
2272 .el \{\
2273 .sp -1
2274 .IP "  2." 4.2
2276 mode for "src"; 000000 if creation or unmerged\&.
2279 .RS 4
2280 .ie n \{\
2281 \h'-04' 3.\h'+01'\c
2283 .el \{\
2284 .sp -1
2285 .IP "  3." 4.2
2287 a space\&.
2290 .RS 4
2291 .ie n \{\
2292 \h'-04' 4.\h'+01'\c
2294 .el \{\
2295 .sp -1
2296 .IP "  4." 4.2
2298 mode for "dst"; 000000 if deletion or unmerged\&.
2301 .RS 4
2302 .ie n \{\
2303 \h'-04' 5.\h'+01'\c
2305 .el \{\
2306 .sp -1
2307 .IP "  5." 4.2
2309 a space\&.
2312 .RS 4
2313 .ie n \{\
2314 \h'-04' 6.\h'+01'\c
2316 .el \{\
2317 .sp -1
2318 .IP "  6." 4.2
2320 sha1 for "src"; 0{40} if creation or unmerged\&.
2323 .RS 4
2324 .ie n \{\
2325 \h'-04' 7.\h'+01'\c
2327 .el \{\
2328 .sp -1
2329 .IP "  7." 4.2
2331 a space\&.
2334 .RS 4
2335 .ie n \{\
2336 \h'-04' 8.\h'+01'\c
2338 .el \{\
2339 .sp -1
2340 .IP "  8." 4.2
2342 sha1 for "dst"; 0{40} if deletion, unmerged or "work tree out of sync with the index"\&.
2345 .RS 4
2346 .ie n \{\
2347 \h'-04' 9.\h'+01'\c
2349 .el \{\
2350 .sp -1
2351 .IP "  9." 4.2
2353 a space\&.
2356 .RS 4
2357 .ie n \{\
2358 \h'-04'10.\h'+01'\c
2360 .el \{\
2361 .sp -1
2362 .IP "10." 4.2
2364 status, followed by optional "score" number\&.
2367 .RS 4
2368 .ie n \{\
2369 \h'-04'11.\h'+01'\c
2371 .el \{\
2372 .sp -1
2373 .IP "11." 4.2
2375 a tab or a NUL when
2376 \fB\-z\fR
2377 option is used\&.
2380 .RS 4
2381 .ie n \{\
2382 \h'-04'12.\h'+01'\c
2384 .el \{\
2385 .sp -1
2386 .IP "12." 4.2
2388 path for "src"
2391 .RS 4
2392 .ie n \{\
2393 \h'-04'13.\h'+01'\c
2395 .el \{\
2396 .sp -1
2397 .IP "13." 4.2
2399 a tab or a NUL when
2400 \fB\-z\fR
2401 option is used; only exists for C or R\&.
2404 .RS 4
2405 .ie n \{\
2406 \h'-04'14.\h'+01'\c
2408 .el \{\
2409 .sp -1
2410 .IP "14." 4.2
2412 path for "dst"; only exists for C or R\&.
2415 .RS 4
2416 .ie n \{\
2417 \h'-04'15.\h'+01'\c
2419 .el \{\
2420 .sp -1
2421 .IP "15." 4.2
2423 an LF or a NUL when
2424 \fB\-z\fR
2425 option is used, to terminate the record\&.
2428 Possible status letters are:
2430 .RS 4
2431 .ie n \{\
2432 \h'-04'\(bu\h'+03'\c
2434 .el \{\
2435 .sp -1
2436 .IP \(bu 2.3
2438 A: addition of a file
2441 .RS 4
2442 .ie n \{\
2443 \h'-04'\(bu\h'+03'\c
2445 .el \{\
2446 .sp -1
2447 .IP \(bu 2.3
2449 C: copy of a file into a new one
2452 .RS 4
2453 .ie n \{\
2454 \h'-04'\(bu\h'+03'\c
2456 .el \{\
2457 .sp -1
2458 .IP \(bu 2.3
2460 D: deletion of a file
2463 .RS 4
2464 .ie n \{\
2465 \h'-04'\(bu\h'+03'\c
2467 .el \{\
2468 .sp -1
2469 .IP \(bu 2.3
2471 M: modification of the contents or mode of a file
2474 .RS 4
2475 .ie n \{\
2476 \h'-04'\(bu\h'+03'\c
2478 .el \{\
2479 .sp -1
2480 .IP \(bu 2.3
2482 R: renaming of a file
2485 .RS 4
2486 .ie n \{\
2487 \h'-04'\(bu\h'+03'\c
2489 .el \{\
2490 .sp -1
2491 .IP \(bu 2.3
2493 T: change in the type of the file (regular file, symbolic link or submodule)
2496 .RS 4
2497 .ie n \{\
2498 \h'-04'\(bu\h'+03'\c
2500 .el \{\
2501 .sp -1
2502 .IP \(bu 2.3
2504 U: file is unmerged (you must complete the merge before it can be committed)
2507 .RS 4
2508 .ie n \{\
2509 \h'-04'\(bu\h'+03'\c
2511 .el \{\
2512 .sp -1
2513 .IP \(bu 2.3
2515 X: "unknown" change type (most probably a bug, please report it)
2518 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\&.
2520 The sha1 for "dst" is shown as all 0\(cqs if a file on the filesystem is out of sync with the index\&.
2522 Example:
2524 .if n \{\
2525 .RS 4
2528 :100644 100644 5be4a4a 0000000 M file\&.c
2530 .if n \{\
2535 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\&.
2536 .SH "DIFF FORMAT FOR MERGES"
2538 "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:
2540 .RS 4
2541 .ie n \{\
2542 \h'-04' 1.\h'+01'\c
2544 .el \{\
2545 .sp -1
2546 .IP "  1." 4.2
2548 there is a colon for each parent
2551 .RS 4
2552 .ie n \{\
2553 \h'-04' 2.\h'+01'\c
2555 .el \{\
2556 .sp -1
2557 .IP "  2." 4.2
2559 there are more "src" modes and "src" sha1
2562 .RS 4
2563 .ie n \{\
2564 \h'-04' 3.\h'+01'\c
2566 .el \{\
2567 .sp -1
2568 .IP "  3." 4.2
2570 status is concatenated status characters for each parent
2573 .RS 4
2574 .ie n \{\
2575 \h'-04' 4.\h'+01'\c
2577 .el \{\
2578 .sp -1
2579 .IP "  4." 4.2
2581 no optional "score" number
2584 .RS 4
2585 .ie n \{\
2586 \h'-04' 5.\h'+01'\c
2588 .el \{\
2589 .sp -1
2590 .IP "  5." 4.2
2592 tab\-separated pathname(s) of the file
2595 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\&.
2597 Examples for \fB\-c\fR and \fB\-\-cc\fR without \fB\-\-combined\-all\-paths\fR:
2599 .if n \{\
2600 .RS 4
2603 ::100644 100644 100644 fabadb8 cc95eb0 4866510 MM       desc\&.c
2604 ::100755 100755 100755 52b7a2d 6d1ac04 d2ac7d7 RM       bar\&.sh
2605 ::100644 100644 100644 e07d6c5 9042e82 ee91881 RR       phooey\&.c
2607 .if n \{\
2612 Examples when \fB\-\-combined\-all\-paths\fR added to either \fB\-c\fR or \fB\-\-cc\fR:
2614 .if n \{\
2615 .RS 4
2618 ::100644 100644 100644 fabadb8 cc95eb0 4866510 MM       desc\&.c  desc\&.c  desc\&.c
2619 ::100755 100755 100755 52b7a2d 6d1ac04 d2ac7d7 RM       foo\&.sh  bar\&.sh  bar\&.sh
2620 ::100644 100644 100644 e07d6c5 9042e82 ee91881 RR       fooey\&.c fuey\&.c  phooey\&.c
2622 .if n \{\
2627 Note that \fIcombined diff\fR lists only files which were modified from all parents\&.
2628 .SH "GENERATING PATCH TEXT WITH \-P"
2630 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))\&.
2632 What the \-p option produces is slightly different from the traditional diff format:
2634 .RS 4
2635 .ie n \{\
2636 \h'-04' 1.\h'+01'\c
2638 .el \{\
2639 .sp -1
2640 .IP "  1." 4.2
2642 It is preceded with a "git diff" header that looks like this:
2644 .if n \{\
2645 .RS 4
2648 diff \-\-git a/file1 b/file2
2650 .if n \{\
2655 \fBa/\fR
2657 \fBb/\fR
2658 filenames are the same unless rename/copy is involved\&. Especially, even for a creation or a deletion,
2659 \fB/dev/null\fR
2661 \fInot\fR
2662 used in place of the
2663 \fBa/\fR
2665 \fBb/\fR
2666 filenames\&.
2668 When rename/copy is involved,
2669 \fBfile1\fR
2671 \fBfile2\fR
2672 show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively\&.
2675 .RS 4
2676 .ie n \{\
2677 \h'-04' 2.\h'+01'\c
2679 .el \{\
2680 .sp -1
2681 .IP "  2." 4.2
2683 It is followed by one or more extended header lines:
2685 .if n \{\
2686 .RS 4
2689 old mode <mode>
2690 new mode <mode>
2691 deleted file mode <mode>
2692 new file mode <mode>
2693 copy from <path>
2694 copy to <path>
2695 rename from <path>
2696 rename to <path>
2697 similarity index <number>
2698 dissimilarity index <number>
2699 index <hash>\&.\&.<hash> <mode>
2701 .if n \{\
2705 File modes are printed as 6\-digit octal numbers including the file type and file permission bits\&.
2707 Path names in extended headers do not include the
2708 \fBa/\fR
2710 \fBb/\fR
2711 prefixes\&.
2713 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\&.
2715 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\&.
2718 .RS 4
2719 .ie n \{\
2720 \h'-04' 3.\h'+01'\c
2722 .el \{\
2723 .sp -1
2724 .IP "  3." 4.2
2726 Pathnames with "unusual" characters are quoted as explained for the configuration variable
2727 \fBcore\&.quotePath\fR
2728 (see
2729 \fBgit-config\fR(1))\&.
2732 .RS 4
2733 .ie n \{\
2734 \h'-04' 4.\h'+01'\c
2736 .el \{\
2737 .sp -1
2738 .IP "  4." 4.2
2740 All the
2741 \fBfile1\fR
2742 files in the output refer to files before the commit, and all the
2743 \fBfile2\fR
2744 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:
2746 .if n \{\
2747 .RS 4
2750 diff \-\-git a/a b/b
2751 rename from a
2752 rename to b
2753 diff \-\-git a/b b/a
2754 rename from b
2755 rename to a
2757 .if n \{\
2762 .RS 4
2763 .ie n \{\
2764 \h'-04' 5.\h'+01'\c
2766 .el \{\
2767 .sp -1
2768 .IP "  5." 4.2
2770 Hunk headers mention the name of the function to which the hunk applies\&. See "Defining a custom hunk\-header" in
2771 \fBgitattributes\fR(5)
2772 for details of how to tailor to this to specific languages\&.
2774 .SH "COMBINED DIFF FORMAT"
2776 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 specific format\&.
2778 A "combined diff" format looks like this:
2780 .if n \{\
2781 .RS 4
2784 diff \-\-combined describe\&.c
2785 index fabadb8,cc95eb0\&.\&.4866510
2786 \-\-\- a/describe\&.c
2787 +++ b/describe\&.c
2788 @@@ \-98,20 \-98,12 +98,20 @@@
2789         return (a_date > b_date) ? \-1 : (a_date == b_date) ? 0 : 1;
2790   }
2792 \- static void describe(char *arg)
2793  \-static void describe(struct commit *cmit, int last_one)
2794 ++static void describe(char *arg, int last_one)
2795   {
2796  +      unsigned char sha1[20];
2797  +      struct commit *cmit;
2798         struct commit_list *list;
2799         static int initialized = 0;
2800         struct commit_name *n;
2802  +      if (get_sha1(arg, sha1) < 0)
2803  +              usage(describe_usage);
2804  +      cmit = lookup_commit_reference(sha1);
2805  +      if (!cmit)
2806  +              usage(describe_usage);
2808         if (!initialized) {
2809                 initialized = 1;
2810                 for_each_ref(get_name);
2812 .if n \{\
2818 .RS 4
2819 .ie n \{\
2820 \h'-04' 1.\h'+01'\c
2822 .el \{\
2823 .sp -1
2824 .IP "  1." 4.2
2826 It is preceded with a "git diff" header, that looks like this (when the
2827 \fB\-c\fR
2828 option is used):
2830 .if n \{\
2831 .RS 4
2834 diff \-\-combined file
2836 .if n \{\
2840 or like this (when the
2841 \fB\-\-cc\fR
2842 option is used):
2844 .if n \{\
2845 .RS 4
2848 diff \-\-cc file
2850 .if n \{\
2855 .RS 4
2856 .ie n \{\
2857 \h'-04' 2.\h'+01'\c
2859 .el \{\
2860 .sp -1
2861 .IP "  2." 4.2
2863 It is followed by one or more extended header lines (this example shows a merge with two parents):
2865 .if n \{\
2866 .RS 4
2869 index <hash>,<hash>\&.\&.<hash>
2870 mode <mode>,<mode>\&.\&.<mode>
2871 new file mode <mode>
2872 deleted file mode <mode>,<mode>
2874 .if n \{\
2879 \fBmode <mode>,<mode>\&.\&.<mode>\fR
2880 line appears only if at least one of the <mode> is different from the rest\&. Extended headers with information about detected contents movement (renames and copying detection) are designed to work with diff of two <tree\-ish> and are not used by combined diff format\&.
2883 .RS 4
2884 .ie n \{\
2885 \h'-04' 3.\h'+01'\c
2887 .el \{\
2888 .sp -1
2889 .IP "  3." 4.2
2891 It is followed by two\-line from\-file/to\-file header
2893 .if n \{\
2894 .RS 4
2897 \-\-\- a/file
2898 +++ b/file
2900 .if n \{\
2904 Similar to two\-line header for traditional
2905 \fIunified\fR
2906 diff format,
2907 \fB/dev/null\fR
2908 is used to signal created or deleted files\&.
2910 However, if the \-\-combined\-all\-paths option is provided, instead of a two\-line from\-file/to\-file you get a N+1 line from\-file/to\-file header, where N is the number of parents in the merge commit
2912 .if n \{\
2913 .RS 4
2916 \-\-\- a/file
2917 \-\-\- a/file
2918 \-\-\- a/file
2919 +++ b/file
2921 .if n \{\
2925 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\&.
2928 .RS 4
2929 .ie n \{\
2930 \h'-04' 4.\h'+01'\c
2932 .el \{\
2933 .sp -1
2934 .IP "  4." 4.2
2936 Chunk header format is modified to prevent people from accidentally feeding it to
2937 \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
2938 \fIindex\fR
2939 header:
2941 .if n \{\
2942 .RS 4
2945 @@@ <from\-file\-range> <from\-file\-range> <to\-file\-range> @@@
2947 .if n \{\
2951 There are (number of parents + 1)
2952 \fB@\fR
2953 characters in the chunk header for combined diff format\&.
2956 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\&.
2958 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)\&.
2960 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)\&.
2962 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")\&.
2963 .SH "OTHER DIFF FORMATS"
2965 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\&.
2967 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:
2969 .if n \{\
2970 .RS 4
2973 arch/{i386 => x86}/Makefile    |   4 +\-\-
2975 .if n \{\
2980 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:
2982 .if n \{\
2983 .RS 4
2986 1       2       README
2987 3       1       arch/{i386 => x86}/Makefile
2989 .if n \{\
2994 That is, from left to right:
2996 .RS 4
2997 .ie n \{\
2998 \h'-04' 1.\h'+01'\c
3000 .el \{\
3001 .sp -1
3002 .IP "  1." 4.2
3004 the number of added lines;
3007 .RS 4
3008 .ie n \{\
3009 \h'-04' 2.\h'+01'\c
3011 .el \{\
3012 .sp -1
3013 .IP "  2." 4.2
3015 a tab;
3018 .RS 4
3019 .ie n \{\
3020 \h'-04' 3.\h'+01'\c
3022 .el \{\
3023 .sp -1
3024 .IP "  3." 4.2
3026 the number of deleted lines;
3029 .RS 4
3030 .ie n \{\
3031 \h'-04' 4.\h'+01'\c
3033 .el \{\
3034 .sp -1
3035 .IP "  4." 4.2
3037 a tab;
3040 .RS 4
3041 .ie n \{\
3042 \h'-04' 5.\h'+01'\c
3044 .el \{\
3045 .sp -1
3046 .IP "  5." 4.2
3048 pathname (possibly with rename/copy information);
3051 .RS 4
3052 .ie n \{\
3053 \h'-04' 6.\h'+01'\c
3055 .el \{\
3056 .sp -1
3057 .IP "  6." 4.2
3059 a newline\&.
3062 When \fB\-z\fR output option is in effect, the output is formatted this way:
3064 .if n \{\
3065 .RS 4
3068 1       2       README NUL
3069 3       1       NUL arch/i386/Makefile NUL arch/x86/Makefile NUL
3071 .if n \{\
3076 That is:
3078 .RS 4
3079 .ie n \{\
3080 \h'-04' 1.\h'+01'\c
3082 .el \{\
3083 .sp -1
3084 .IP "  1." 4.2
3086 the number of added lines;
3089 .RS 4
3090 .ie n \{\
3091 \h'-04' 2.\h'+01'\c
3093 .el \{\
3094 .sp -1
3095 .IP "  2." 4.2
3097 a tab;
3100 .RS 4
3101 .ie n \{\
3102 \h'-04' 3.\h'+01'\c
3104 .el \{\
3105 .sp -1
3106 .IP "  3." 4.2
3108 the number of deleted lines;
3111 .RS 4
3112 .ie n \{\
3113 \h'-04' 4.\h'+01'\c
3115 .el \{\
3116 .sp -1
3117 .IP "  4." 4.2
3119 a tab;
3122 .RS 4
3123 .ie n \{\
3124 \h'-04' 5.\h'+01'\c
3126 .el \{\
3127 .sp -1
3128 .IP "  5." 4.2
3130 a NUL (only exists if renamed/copied);
3133 .RS 4
3134 .ie n \{\
3135 \h'-04' 6.\h'+01'\c
3137 .el \{\
3138 .sp -1
3139 .IP "  6." 4.2
3141 pathname in preimage;
3144 .RS 4
3145 .ie n \{\
3146 \h'-04' 7.\h'+01'\c
3148 .el \{\
3149 .sp -1
3150 .IP "  7." 4.2
3152 a NUL (only exists if renamed/copied);
3155 .RS 4
3156 .ie n \{\
3157 \h'-04' 8.\h'+01'\c
3159 .el \{\
3160 .sp -1
3161 .IP "  8." 4.2
3163 pathname in postimage (only exists if renamed/copied);
3166 .RS 4
3167 .ie n \{\
3168 \h'-04' 9.\h'+01'\c
3170 .el \{\
3171 .sp -1
3172 .IP "  9." 4.2
3174 a NUL\&.
3177 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\&.
3178 .SH "GIT"
3180 Part of the \fBgit\fR(1) suite