Autogenerated manpages for v2.45.2-648-g1e158
[git-manpages.git] / man1 / git-diff-tree.1
blobbcc16edbe274a5b8752f674fe7c549a8f5ae38fd
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: 2024-06-24
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.45.2.648.g1e1586e4ed
8 .\"  Language: English
9 .\"
10 .TH "GIT\-DIFF\-TREE" "1" "2024\-06\-24" "Git 2\&.45\&.2\&.648\&.g1e1586" "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 Compare the content and mode of 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
52 the section called \(lqGENERATING PATCH TEXT WITH \-P\(rq)\&.
53 .RE
54 .PP
55 \-s, \-\-no\-patch
56 .RS 4
57 Suppress all output from the diff machinery\&. Useful for commands like
58 \fBgit show\fR
59 that show the patch by default to squelch their output, or to cancel the effect of options like
60 \fB\-\-patch\fR,
61 \fB\-\-stat\fR
62 earlier on the command line in an alias\&.
63 .RE
64 .PP
65 \-U<n>, \-\-unified=<n>
66 .RS 4
67 Generate diffs with <n> lines of context instead of the usual three\&. Implies
68 \fB\-\-patch\fR\&.
69 .RE
70 .PP
71 \-\-output=<file>
72 .RS 4
73 Output to a specific file instead of stdout\&.
74 .RE
75 .PP
76 \-\-output\-indicator\-new=<char>, \-\-output\-indicator\-old=<char>, \-\-output\-indicator\-context=<char>
77 .RS 4
78 Specify the character used to indicate new, old or context lines in the generated patch\&. Normally they are
79 \fI+\fR,
80 \fI\-\fR
81 and \*(Aq \*(Aq respectively\&.
82 .RE
83 .PP
84 \-\-raw
85 .RS 4
86 Generate the diff in raw format\&. This is the default\&.
87 .RE
88 .PP
89 \-\-patch\-with\-raw
90 .RS 4
91 Synonym for
92 \fB\-p \-\-raw\fR\&.
93 .RE
94 .PP
95 \-\-indent\-heuristic
96 .RS 4
97 Enable the heuristic that shifts diff hunk boundaries to make patches easier to read\&. This is the default\&.
98 .RE
99 .PP
100 \-\-no\-indent\-heuristic
101 .RS 4
102 Disable the indent heuristic\&.
105 \-\-minimal
106 .RS 4
107 Spend extra time to make sure the smallest possible diff is produced\&.
110 \-\-patience
111 .RS 4
112 Generate a diff using the "patience diff" algorithm\&.
115 \-\-histogram
116 .RS 4
117 Generate a diff using the "histogram diff" algorithm\&.
120 \-\-anchored=<text>
121 .RS 4
122 Generate a diff using the "anchored diff" algorithm\&.
124 This option may be specified more than once\&.
126 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\&.
129 \-\-diff\-algorithm={patience|minimal|histogram|myers}
130 .RS 4
131 Choose a diff algorithm\&. The variants are as follows:
133 \fBdefault\fR, \fBmyers\fR
134 .RS 4
135 The basic greedy diff algorithm\&. Currently, this is the default\&.
138 \fBminimal\fR
139 .RS 4
140 Spend extra time to make sure the smallest possible diff is produced\&.
143 \fBpatience\fR
144 .RS 4
145 Use "patience diff" algorithm when generating patches\&.
148 \fBhistogram\fR
149 .RS 4
150 This algorithm extends the patience algorithm to "support low\-occurrence common elements"\&.
153 For instance, if you configured the
154 \fBdiff\&.algorithm\fR
155 variable to a non\-default value and want to use the default one, then you have to use
156 \fB\-\-diff\-algorithm=default\fR
157 option\&.
160 \-\-stat[=<width>[,<name\-width>[,<count>]]]
161 .RS 4
162 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
163 \fB<width>\fR\&. The width of the filename part can be limited by giving another width
164 \fB<name\-width>\fR
165 after a comma or by setting
166 \fBdiff\&.statNameWidth=<width>\fR\&. The width of the graph part can be limited by using
167 \fB\-\-stat\-graph\-width=<width>\fR
168 or by setting
169 \fBdiff\&.statGraphWidth=<width>\fR\&. Using
170 \fB\-\-stat\fR
172 \fB\-\-stat\-graph\-width\fR
173 affects all commands generating a stat graph, while setting
174 \fBdiff\&.statNameWidth\fR
176 \fBdiff\&.statGraphWidth\fR
177 does not affect
178 \fBgit format\-patch\fR\&. By giving a third parameter
179 \fB<count>\fR, you can limit the output to the first
180 \fB<count>\fR
181 lines, followed by
182 \fB\&.\&.\&.\fR
183 if there are more\&.
185 These parameters can also be set individually with
186 \fB\-\-stat\-width=<width>\fR,
187 \fB\-\-stat\-name\-width=<name\-width>\fR
189 \fB\-\-stat\-count=<count>\fR\&.
192 \-\-compact\-summary
193 .RS 4
194 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\&.
198 \-\-numstat
199 .RS 4
200 Similar to
201 \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
202 \fB\-\fR
203 instead of saying
204 \fB0 0\fR\&.
207 \-\-shortstat
208 .RS 4
209 Output only the last line of the
210 \fB\-\-stat\fR
211 format containing total number of modified files, as well as number of added and deleted lines\&.
214 \-X[<param1,param2,\&...>], \-\-dirstat[=<param1,param2,\&...>]
215 .RS 4
216 Output the distribution of relative amount of changes for each sub\-directory\&. The behavior of
217 \fB\-\-dirstat\fR
218 can be customized by passing it a comma separated list of parameters\&. The defaults are controlled by the
219 \fBdiff\&.dirstat\fR
220 configuration variable (see
221 \fBgit-config\fR(1))\&. The following parameters are available:
223 \fBchanges\fR
224 .RS 4
225 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\&.
228 \fBlines\fR
229 .RS 4
230 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
231 \fB\-\-dirstat\fR
232 behavior than the
233 \fBchanges\fR
234 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 \fB\-\-*stat\fR
236 options\&.
239 \fBfiles\fR
240 .RS 4
241 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
242 \fB\-\-dirstat\fR
243 behavior, since it does not have to look at the file contents at all\&.
246 \fBcumulative\fR
247 .RS 4
248 Count changes in a child directory for the parent directory as well\&. Note that when using
249 \fBcumulative\fR, the sum of the percentages reported may exceed 100%\&. The default (non\-cumulative) behavior can be specified with the
250 \fBnoncumulative\fR
251 parameter\&.
254 <limit>
255 .RS 4
256 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\&.
259 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:
260 \fB\-\-dirstat=files,10,cumulative\fR\&.
263 \-\-cumulative
264 .RS 4
265 Synonym for \-\-dirstat=cumulative
268 \-\-dirstat\-by\-file[=<param1,param2>\&...]
269 .RS 4
270 Synonym for \-\-dirstat=files,<param1>,<param2>\&...
273 \-\-summary
274 .RS 4
275 Output a condensed summary of extended header information such as creations, renames and mode changes\&.
278 \-\-patch\-with\-stat
279 .RS 4
280 Synonym for
281 \fB\-p \-\-stat\fR\&.
285 .RS 4
286 When
287 \fB\-\-raw\fR,
288 \fB\-\-numstat\fR,
289 \fB\-\-name\-only\fR
291 \fB\-\-name\-status\fR
292 has been given, do not munge pathnames and use NULs as output field terminators\&.
294 Without this option, pathnames with "unusual" characters are quoted as explained for the configuration variable
295 \fBcore\&.quotePath\fR
296 (see
297 \fBgit-config\fR(1))\&.
300 \-\-name\-only
301 .RS 4
302 Show only the name of each changed file in the post\-image tree\&. The file names are often encoded in UTF\-8\&. For more information see the discussion about encoding in the
303 \fBgit-log\fR(1)
304 manual page\&.
307 \-\-name\-status
308 .RS 4
309 Show only the name(s) and status of each changed file\&. See the description of the
310 \fB\-\-diff\-filter\fR
311 option on what the status letters mean\&. Just like
312 \fB\-\-name\-only\fR
313 the file names are often encoded in UTF\-8\&.
316 \-\-submodule[=<format>]
317 .RS 4
318 Specify how differences in submodules are shown\&. When specifying
319 \fB\-\-submodule=short\fR
321 \fIshort\fR
322 format is used\&. This format just shows the names of the commits at the beginning and end of the range\&. When
323 \fB\-\-submodule\fR
325 \fB\-\-submodule=log\fR
326 is specified, the
327 \fIlog\fR
328 format is used\&. This format lists the commits in the range like
329 \fBgit-submodule\fR(1)
330 \fBsummary\fR
331 does\&. When
332 \fB\-\-submodule=diff\fR
333 is specified, the
334 \fIdiff\fR
335 format is used\&. This format shows an inline diff of the changes in the submodule contents between the commit range\&. Defaults to
336 \fBdiff\&.submodule\fR
337 or the
338 \fIshort\fR
339 format if the config option is unset\&.
342 \-\-color[=<when>]
343 .RS 4
344 Show colored diff\&.
345 \fB\-\-color\fR
346 (i\&.e\&. without
347 \fI=<when>\fR) is the same as
348 \fB\-\-color=always\fR\&.
349 \fI<when>\fR
350 can be one of
351 \fBalways\fR,
352 \fBnever\fR, or
353 \fBauto\fR\&.
356 \-\-no\-color
357 .RS 4
358 Turn off colored diff\&. It is the same as
359 \fB\-\-color=never\fR\&.
362 \-\-color\-moved[=<mode>]
363 .RS 4
364 Moved lines of code are colored differently\&. The <mode> defaults to
365 \fIno\fR
366 if the option is not given and to
367 \fIzebra\fR
368 if the option with no mode is given\&. The mode must be one of:
371 .RS 4
372 Moved lines are not highlighted\&.
375 default
376 .RS 4
377 Is a synonym for
378 \fBzebra\fR\&. This may change to a more sensible mode in the future\&.
381 plain
382 .RS 4
383 Any line that is added in one location and was removed in another location will be colored with
384 \fIcolor\&.diff\&.newMoved\fR\&. Similarly
385 \fIcolor\&.diff\&.oldMoved\fR
386 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\&.
389 blocks
390 .RS 4
391 Blocks of moved text of at least 20 alphanumeric characters are detected greedily\&. The detected blocks are painted using either the
392 \fIcolor\&.diff\&.{old,new}Moved\fR
393 color\&. Adjacent blocks cannot be told apart\&.
396 zebra
397 .RS 4
398 Blocks of moved text are detected as in
399 \fIblocks\fR
400 mode\&. The blocks are painted using either the
401 \fIcolor\&.diff\&.{old,new}Moved\fR
402 color or
403 \fIcolor\&.diff\&.{old,new}MovedAlternative\fR\&. The change between the two colors indicates that a new block was detected\&.
406 dimmed\-zebra
407 .RS 4
408 Similar to
409 \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\&.
410 \fBdimmed_zebra\fR
411 is a deprecated synonym\&.
415 \-\-no\-color\-moved
416 .RS 4
417 Turn off move detection\&. This can be used to override configuration settings\&. It is the same as
418 \fB\-\-color\-moved=no\fR\&.
421 \-\-color\-moved\-ws=<modes>
422 .RS 4
423 This configures how whitespace is ignored when performing the move detection for
424 \fB\-\-color\-moved\fR\&. These modes can be given as a comma separated list:
427 .RS 4
428 Do not ignore whitespace when performing move detection\&.
431 ignore\-space\-at\-eol
432 .RS 4
433 Ignore changes in whitespace at EOL\&.
436 ignore\-space\-change
437 .RS 4
438 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\&.
441 ignore\-all\-space
442 .RS 4
443 Ignore whitespace when comparing lines\&. This ignores differences even if one line has whitespace where the other line has none\&.
446 allow\-indentation\-change
447 .RS 4
448 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\&.
452 \-\-no\-color\-moved\-ws
453 .RS 4
454 Do not ignore whitespace when performing move detection\&. This can be used to override configuration settings\&. It is the same as
455 \fB\-\-color\-moved\-ws=no\fR\&.
458 \-\-word\-diff[=<mode>]
459 .RS 4
460 Show a word diff, using the <mode> to delimit changed words\&. By default, words are delimited by whitespace; see
461 \fB\-\-word\-diff\-regex\fR
462 below\&. The <mode> defaults to
463 \fIplain\fR, and must be one of:
465 color
466 .RS 4
467 Highlight changed words using only colors\&. Implies
468 \fB\-\-color\fR\&.
471 plain
472 .RS 4
473 Show words as
474 \fB[\-removed\-]\fR
476 \fB{+added+}\fR\&. Makes no attempts to escape the delimiters if they appear in the input, so the output may be ambiguous\&.
479 porcelain
480 .RS 4
481 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
482 \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
483 \fB~\fR
484 on a line of its own\&.
487 none
488 .RS 4
489 Disable word diff again\&.
492 Note that despite the name of the first mode, color is used to highlight the changed parts in all modes if enabled\&.
495 \-\-word\-diff\-regex=<regex>
496 .RS 4
497 Use <regex> to decide what a word is, instead of considering runs of non\-whitespace to be a word\&. Also implies
498 \fB\-\-word\-diff\fR
499 unless it was already enabled\&.
501 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
502 \fB|[^[:space:]]\fR
503 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\&.
505 For example,
506 \fB\-\-word\-diff\-regex=\&.\fR
507 will treat each character as a word and, correspondingly, show differences character by character\&.
509 The regex can also be set via a diff driver or configuration option, see
510 \fBgitattributes\fR(5)
512 \fBgit-config\fR(1)\&. Giving it explicitly overrides any diff driver or configuration setting\&. Diff drivers override configuration settings\&.
515 \-\-color\-words[=<regex>]
516 .RS 4
517 Equivalent to
518 \fB\-\-word\-diff=color\fR
519 plus (if a regex was specified)
520 \fB\-\-word\-diff\-regex=<regex>\fR\&.
523 \-\-no\-renames
524 .RS 4
525 Turn off rename detection, even when the configuration file gives the default to do so\&.
528 \-\-[no\-]rename\-empty
529 .RS 4
530 Whether to use empty blobs as rename source\&.
533 \-\-check
534 .RS 4
535 Warn if changes introduce conflict markers or whitespace errors\&. What are considered whitespace errors is controlled by
536 \fBcore\&.whitespace\fR
537 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\&.
540 \-\-ws\-error\-highlight=<kind>
541 .RS 4
542 Highlight whitespace errors in the
543 \fBcontext\fR,
544 \fBold\fR
546 \fBnew\fR
547 lines of the diff\&. Multiple values are separated by comma,
548 \fBnone\fR
549 resets previous values,
550 \fBdefault\fR
551 reset the list to
552 \fBnew\fR
554 \fBall\fR
555 is a shorthand for
556 \fBold,new,context\fR\&. When this option is not given, and the configuration variable
557 \fBdiff\&.wsErrorHighlight\fR
558 is not set, only whitespace errors in
559 \fBnew\fR
560 lines are highlighted\&. The whitespace errors are colored with
561 \fBcolor\&.diff\&.whitespace\fR\&.
564 \-\-full\-index
565 .RS 4
566 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\&.
569 \-\-binary
570 .RS 4
571 In addition to
572 \fB\-\-full\-index\fR, output a binary diff that can be applied with
573 \fBgit\-apply\fR\&. Implies
574 \fB\-\-patch\fR\&.
577 \-\-abbrev[=<n>]
578 .RS 4
579 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
580 \fI<n>\fR
581 hexdigits long that uniquely refers the object\&. In diff\-patch output format,
582 \fB\-\-full\-index\fR
583 takes higher precedence, i\&.e\&. if
584 \fB\-\-full\-index\fR
585 is specified, full blob names will be shown regardless of
586 \fB\-\-abbrev\fR\&. Non default number of digits can be specified with
587 \fB\-\-abbrev=<n>\fR\&.
590 \-B[<n>][/<m>], \-\-break\-rewrites[=[<n>][/<m>]]
591 .RS 4
592 Break complete rewrite changes into pairs of delete and create\&. This serves two purposes:
594 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
595 \fBm\fR
596 controls this aspect of the \-B option (defaults to 60%)\&.
597 \fB\-B/70%\fR
598 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)\&.
600 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
601 \fBn\fR
602 controls this aspect of the \-B option (defaults to 50%)\&.
603 \fB\-B20%\fR
604 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\&.
607 \-M[<n>], \-\-find\-renames[=<n>]
608 .RS 4
609 Detect renames\&. If
610 \fBn\fR
611 is specified, it is a threshold on the similarity index (i\&.e\&. amount of addition/deletions compared to the file\(cqs size)\&. For example,
612 \fB\-M90%\fR
613 means Git should consider a delete/add pair to be a rename if more than 90% of the file hasn\(cqt changed\&. Without a
614 \fB%\fR
615 sign, the number is to be read as a fraction, with a decimal point before it\&. I\&.e\&.,
616 \fB\-M5\fR
617 becomes 0\&.5, and is thus the same as
618 \fB\-M50%\fR\&. Similarly,
619 \fB\-M05\fR
620 is the same as
621 \fB\-M5%\fR\&. To limit detection to exact renames, use
622 \fB\-M100%\fR\&. The default similarity index is 50%\&.
625 \-C[<n>], \-\-find\-copies[=<n>]
626 .RS 4
627 Detect copies as well as renames\&. See also
628 \fB\-\-find\-copies\-harder\fR\&. If
629 \fBn\fR
630 is specified, it has the same meaning as for
631 \fB\-M<n>\fR\&.
634 \-\-find\-copies\-harder
635 .RS 4
636 For performance reasons, by default,
637 \fB\-C\fR
638 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
639 \fB\-C\fR
640 option has the same effect\&.
643 \-D, \-\-irreversible\-delete
644 .RS 4
645 Omit the preimage for deletes, i\&.e\&. print only the header but not the diff between the preimage and
646 \fB/dev/null\fR\&. The resulting patch is not meant to be applied with
647 \fBpatch\fR
649 \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\&.
651 When used together with
652 \fB\-B\fR, omit also the preimage in the deletion part of a delete/create pair\&.
655 \-l<num>
656 .RS 4
658 \fB\-M\fR
660 \fB\-C\fR
661 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\&.
664 \-\-diff\-filter=[(A|C|D|M|R|T|U|X|B)\&...[*]]
665 .RS 4
666 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
667 \fB*\fR
668 (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\&.
670 Also, these upper\-case letters can be downcased to exclude\&. E\&.g\&.
671 \fB\-\-diff\-filter=ad\fR
672 excludes added and deleted paths\&.
674 Note that not all diffs can feature all types\&. For instance, copied and renamed entries cannot appear if detection for those types is disabled\&.
677 \-S<string>
678 .RS 4
679 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\&.
681 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
682 \fB\-S\fR, and keep going until you get the very first version of the block\&.
684 Binary files are searched as well\&.
687 \-G<regex>
688 .RS 4
689 Look for differences whose patch text contains added/removed lines that match <regex>\&.
691 To illustrate the difference between
692 \fB\-S<regex> \-\-pickaxe\-regex\fR
694 \fB\-G<regex>\fR, consider a commit with the following diff in the same file:
696 .if n \{\
697 .RS 4
700 +    return frotz(nitfol, two\->ptr, 1, 0);
701 \&.\&.\&.
702 \-    hit = frotz(nitfol, mf2\&.ptr, 1, 0);
704 .if n \{\
708 While
709 \fBgit log \-G"frotz\e(nitfol"\fR
710 will show this commit,
711 \fBgit log \-S"frotz\e(nitfol" \-\-pickaxe\-regex\fR
712 will not (because the number of occurrences of that string did not change)\&.
714 Unless
715 \fB\-\-text\fR
716 is supplied patches of binary files without a textconv filter will be ignored\&.
718 See the
719 \fIpickaxe\fR
720 entry in
721 \fBgitdiffcore\fR(7)
722 for more information\&.
725 \-\-find\-object=<object\-id>
726 .RS 4
727 Look for differences that change the number of occurrences of the specified object\&. Similar to
728 \fB\-S\fR, just the argument is different in that it doesn\(cqt search for a specific string but for a specific object id\&.
730 The object can be a blob or a submodule commit\&. It implies the
731 \fB\-t\fR
732 option in
733 \fBgit\-log\fR
734 to also find trees\&.
737 \-\-pickaxe\-all
738 .RS 4
739 When
740 \fB\-S\fR
742 \fB\-G\fR
743 finds a change, show all the changes in that changeset, not just the files that contain the change in <string>\&.
746 \-\-pickaxe\-regex
747 .RS 4
748 Treat the <string> given to
749 \fB\-S\fR
750 as an extended POSIX regular expression to match\&.
753 \-O<orderfile>
754 .RS 4
755 Control the order in which files appear in the output\&. This overrides the
756 \fBdiff\&.orderFile\fR
757 configuration variable (see
758 \fBgit-config\fR(1))\&. To cancel
759 \fBdiff\&.orderFile\fR, use
760 \fB\-O/dev/null\fR\&.
762 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\&.
764 <orderfile> is parsed as follows:
766 .RS 4
767 .ie n \{\
768 \h'-04'\(bu\h'+03'\c
770 .el \{\
771 .sp -1
772 .IP \(bu 2.3
774 Blank lines are ignored, so they can be used as separators for readability\&.
777 .RS 4
778 .ie n \{\
779 \h'-04'\(bu\h'+03'\c
781 .el \{\
782 .sp -1
783 .IP \(bu 2.3
785 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\&.
788 .RS 4
789 .ie n \{\
790 \h'-04'\(bu\h'+03'\c
792 .el \{\
793 .sp -1
794 .IP \(bu 2.3
796 Each other line contains a single pattern\&.
799 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"\&.
802 \-\-skip\-to=<file>, \-\-rotate\-to=<file>
803 .RS 4
804 Discard the files before the named <file> from the output (i\&.e\&.
805 \fIskip to\fR), or move them to the end of the output (i\&.e\&.
806 \fIrotate to\fR)\&. These options were invented primarily for the use of the
807 \fBgit difftool\fR
808 command, and may not be very useful otherwise\&.
812 .RS 4
813 Swap two inputs; that is, show differences from index or on\-disk file to tree contents\&.
816 \-\-relative[=<path>], \-\-no\-relative
817 .RS 4
818 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\&.
819 \fB\-\-no\-relative\fR
820 can be used to countermand both
821 \fBdiff\&.relative\fR
822 config option and previous
823 \fB\-\-relative\fR\&.
826 \-a, \-\-text
827 .RS 4
828 Treat all files as text\&.
831 \-\-ignore\-cr\-at\-eol
832 .RS 4
833 Ignore carriage\-return at the end of line when doing a comparison\&.
836 \-\-ignore\-space\-at\-eol
837 .RS 4
838 Ignore changes in whitespace at EOL\&.
841 \-b, \-\-ignore\-space\-change
842 .RS 4
843 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\&.
846 \-w, \-\-ignore\-all\-space
847 .RS 4
848 Ignore whitespace when comparing lines\&. This ignores differences even if one line has whitespace where the other line has none\&.
851 \-\-ignore\-blank\-lines
852 .RS 4
853 Ignore changes whose lines are all blank\&.
856 \-I<regex>, \-\-ignore\-matching\-lines=<regex>
857 .RS 4
858 Ignore changes whose all lines match <regex>\&. This option may be specified more than once\&.
861 \-\-inter\-hunk\-context=<lines>
862 .RS 4
863 Show the context between diff hunks, up to the specified number of lines, thereby fusing hunks that are close to each other\&. Defaults to
864 \fBdiff\&.interHunkContext\fR
865 or 0 if the config option is unset\&.
868 \-W, \-\-function\-context
869 .RS 4
870 Show whole function as context lines for each change\&. The function names are determined in the same way as
871 \fBgit diff\fR
872 works out patch hunk headers (see
873 \fIDefining a custom hunk\-header\fR
875 \fBgitattributes\fR(5))\&.
878 \-\-exit\-code
879 .RS 4
880 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\&.
883 \-\-quiet
884 .RS 4
885 Disable all output of the program\&. Implies
886 \fB\-\-exit\-code\fR\&. Disables execution of external diff helpers whose exit code is not trusted, i\&.e\&. their respective configuration option
887 \fBdiff\&.trustExitCode\fR
889 \fBdiff\&.<driver>\&.trustExitCode\fR
890 or environment variable
891 \fBGIT_EXTERNAL_DIFF_TRUST_EXIT_CODE\fR
892 is false\&.
895 \-\-ext\-diff
896 .RS 4
897 Allow an external diff helper to be executed\&. If you set an external diff driver with
898 \fBgitattributes\fR(5), you need to use this option with
899 \fBgit-log\fR(1)
900 and friends\&.
903 \-\-no\-ext\-diff
904 .RS 4
905 Disallow external diff drivers\&.
908 \-\-textconv, \-\-no\-textconv
909 .RS 4
910 Allow (or disallow) external text conversion filters to be run when comparing binary files\&. See
911 \fBgitattributes\fR(5)
912 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
913 \fBgit-diff\fR(1)
915 \fBgit-log\fR(1), but not for
916 \fBgit-format-patch\fR(1)
917 or diff plumbing commands\&.
920 \-\-ignore\-submodules[=<when>]
921 .RS 4
922 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
923 \fIignore\fR
924 option in
925 \fBgit-config\fR(1)
927 \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\&.
930 \-\-src\-prefix=<prefix>
931 .RS 4
932 Show the given source prefix instead of "a/"\&.
935 \-\-dst\-prefix=<prefix>
936 .RS 4
937 Show the given destination prefix instead of "b/"\&.
940 \-\-no\-prefix
941 .RS 4
942 Do not show any source or destination prefix\&.
945 \-\-default\-prefix
946 .RS 4
947 Use the default source and destination prefixes ("a/" and "b/")\&. This overrides configuration variables such as
948 \fBdiff\&.noprefix\fR,
949 \fBdiff\&.srcPrefix\fR,
950 \fBdiff\&.dstPrefix\fR, and
951 \fBdiff\&.mnemonicPrefix\fR
952 (see
953 \fBgit\-config\fR(1))\&.
956 \-\-line\-prefix=<prefix>
957 .RS 4
958 Prepend an additional prefix to every line of output\&.
961 \-\-ita\-invisible\-in\-index
962 .RS 4
963 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
964 \fB\-\-ita\-visible\-in\-index\fR\&. Both options are experimental and could be removed in future\&.
967 For more detailed explanation on these common options, see also \fBgitdiffcore\fR(7)\&.
969 <tree\-ish>
970 .RS 4
971 The id of a tree object\&.
974 <path>\&...
975 .RS 4
976 If provided, the results are limited to a subset of files matching one of the provided pathspecs\&.
980 .RS 4
981 Recurse into sub\-trees\&.
985 .RS 4
986 Show tree entry itself as well as subtrees\&. Implies \-r\&.
989 \-\-root
990 .RS 4
991 When
992 \fB\-\-root\fR
993 is specified the initial commit will be shown as a big creation event\&. This is equivalent to a diff against the NULL tree\&.
996 \-\-merge\-base
997 .RS 4
998 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\&.
1001 \-\-stdin
1002 .RS 4
1003 When
1004 \fB\-\-stdin\fR
1005 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\&.)
1007 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\&.
1009 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\&.
1011 The following flags further affect the behavior when comparing commits (but not trees)\&.
1015 .RS 4
1016 By default,
1017 \fIgit diff\-tree \-\-stdin\fR
1018 does not show differences for merge commits\&. With this flag, it shows differences to that commit from all of its parents\&. See also
1019 \fB\-c\fR\&.
1023 .RS 4
1024 By default,
1025 \fIgit diff\-tree \-\-stdin\fR
1026 shows differences, either in machine\-readable form (without
1027 \fB\-p\fR) or in patch form (with
1028 \fB\-p\fR)\&. This output can be suppressed\&. It is only useful with the
1029 \fB\-v\fR
1030 flag\&.
1034 .RS 4
1035 This flag causes
1036 \fIgit diff\-tree \-\-stdin\fR
1037 to also show the commit message before the differences\&.
1040 \-\-pretty[=<format>], \-\-format=<format>
1041 .RS 4
1042 Pretty\-print the contents of the commit logs in a given format, where
1043 \fI<format>\fR
1044 can be one of
1045 \fIoneline\fR,
1046 \fIshort\fR,
1047 \fImedium\fR,
1048 \fIfull\fR,
1049 \fIfuller\fR,
1050 \fIreference\fR,
1051 \fIemail\fR,
1052 \fIraw\fR,
1053 \fIformat:<string>\fR
1055 \fItformat:<string>\fR\&. When
1056 \fI<format>\fR
1057 is none of the above, and has
1058 \fI%placeholder\fR
1059 in it, it acts as if
1060 \fI\-\-pretty=tformat:<format>\fR
1061 were given\&.
1063 See the "PRETTY FORMATS" section for some additional details for each format\&. When
1064 \fI=<format>\fR
1065 part is omitted, it defaults to
1066 \fImedium\fR\&.
1068 Note: you can specify the default pretty format in the repository configuration (see
1069 \fBgit-config\fR(1))\&.
1072 \-\-abbrev\-commit
1073 .RS 4
1074 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\&.
1076 This should make "\-\-pretty=oneline" a whole lot more readable for people using 80\-column terminals\&.
1079 \-\-no\-abbrev\-commit
1080 .RS 4
1081 Show the full 40\-byte hexadecimal commit object name\&. This negates
1082 \fB\-\-abbrev\-commit\fR, either explicit or implied by other options such as "\-\-oneline"\&. It also overrides the
1083 \fBlog\&.abbrevCommit\fR
1084 variable\&.
1087 \-\-oneline
1088 .RS 4
1089 This is a shorthand for "\-\-pretty=oneline \-\-abbrev\-commit" used together\&.
1092 \-\-encoding=<encoding>
1093 .RS 4
1094 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
1095 \fBX\fR
1096 and we are outputting in
1097 \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\&.
1100 \-\-expand\-tabs=<n>, \-\-expand\-tabs, \-\-no\-expand\-tabs
1101 .RS 4
1102 Perform a tab expansion (replace each tab with enough spaces to fill to the next display column that is a multiple of
1103 \fI<n>\fR) in the log message before showing it in the output\&.
1104 \fB\-\-expand\-tabs\fR
1105 is a short\-hand for
1106 \fB\-\-expand\-tabs=8\fR, and
1107 \fB\-\-no\-expand\-tabs\fR
1108 is a short\-hand for
1109 \fB\-\-expand\-tabs=0\fR, which disables tab expansion\&.
1111 By default, tabs are expanded in pretty formats that indent the log message by 4 spaces (i\&.e\&.
1112 \fImedium\fR, which is the default,
1113 \fIfull\fR, and
1114 \fIfuller\fR)\&.
1117 \-\-notes[=<ref>]
1118 .RS 4
1119 Show the notes (see
1120 \fBgit-notes\fR(1)) that annotate the commit, when showing the commit log message\&. This is the default for
1121 \fBgit log\fR,
1122 \fBgit show\fR
1124 \fBgit whatchanged\fR
1125 commands when there is no
1126 \fB\-\-pretty\fR,
1127 \fB\-\-format\fR, or
1128 \fB\-\-oneline\fR
1129 option given on the command line\&.
1131 By default, the notes shown are from the notes refs listed in the
1132 \fBcore\&.notesRef\fR
1134 \fBnotes\&.displayRef\fR
1135 variables (or corresponding environment overrides)\&. See
1136 \fBgit-config\fR(1)
1137 for more details\&.
1139 With an optional
1140 \fI<ref>\fR
1141 argument, use the ref to find the notes to display\&. The ref can specify the full refname when it begins with
1142 \fBrefs/notes/\fR; when it begins with
1143 \fBnotes/\fR,
1144 \fBrefs/\fR
1145 and otherwise
1146 \fBrefs/notes/\fR
1147 is prefixed to form the full name of the ref\&.
1149 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)\&.
1152 \-\-no\-notes
1153 .RS 4
1154 Do not show notes\&. This negates the above
1155 \fB\-\-notes\fR
1156 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"\&.
1159 \-\-show\-notes\-by\-default
1160 .RS 4
1161 Show the default notes unless options for displaying specific notes are given\&.
1164 \-\-show\-notes[=<ref>], \-\-[no\-]standard\-notes
1165 .RS 4
1166 These options are deprecated\&. Use the above \-\-notes/\-\-no\-notes options instead\&.
1169 \-\-show\-signature
1170 .RS 4
1171 Check the validity of a signed commit object by passing the signature to
1172 \fBgpg \-\-verify\fR
1173 and show the output\&.
1176 \-\-no\-commit\-id
1177 .RS 4
1178 \fIgit diff\-tree\fR
1179 outputs a line with the commit ID when applicable\&. This flag suppressed the commit ID output\&.
1183 .RS 4
1184 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
1185 \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
1186 \fB\-m\fR
1187 option does)\&. Furthermore, it lists only files which were modified from all parents\&.
1190 \-\-cc
1191 .RS 4
1192 This flag changes the way a merge commit patch is displayed, in a similar way to the
1193 \fB\-c\fR
1194 option\&. It implies the
1195 \fB\-c\fR
1197 \fB\-p\fR
1198 options and further compresses the patch output by omitting uninteresting hunks whose 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 are not shown, just like in any other "empty diff" case\&.
1201 \-\-combined\-all\-paths
1202 .RS 4
1203 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)\&.
1206 \-\-always
1207 .RS 4
1208 Show the commit itself and the commit log message even if the diff itself is empty\&.
1210 .SH "PRETTY FORMATS"
1212 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\&.
1214 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:
1216 .RS 4
1217 .ie n \{\
1218 \h'-04'\(bu\h'+03'\c
1220 .el \{\
1221 .sp -1
1222 .IP \(bu 2.3
1224 \fIoneline\fR
1226 .if n \{\
1227 .RS 4
1230 <hash> <title\-line>
1232 .if n \{\
1236 This is designed to be as compact as possible\&.
1239 .RS 4
1240 .ie n \{\
1241 \h'-04'\(bu\h'+03'\c
1243 .el \{\
1244 .sp -1
1245 .IP \(bu 2.3
1247 \fIshort\fR
1249 .if n \{\
1250 .RS 4
1253 commit <hash>
1254 Author: <author>
1256 .if n \{\
1260 .if n \{\
1261 .RS 4
1264 <title\-line>
1266 .if n \{\
1271 .RS 4
1272 .ie n \{\
1273 \h'-04'\(bu\h'+03'\c
1275 .el \{\
1276 .sp -1
1277 .IP \(bu 2.3
1279 \fImedium\fR
1281 .if n \{\
1282 .RS 4
1285 commit <hash>
1286 Author: <author>
1287 Date:   <author\-date>
1289 .if n \{\
1293 .if n \{\
1294 .RS 4
1297 <title\-line>
1299 .if n \{\
1303 .if n \{\
1304 .RS 4
1307 <full\-commit\-message>
1309 .if n \{\
1314 .RS 4
1315 .ie n \{\
1316 \h'-04'\(bu\h'+03'\c
1318 .el \{\
1319 .sp -1
1320 .IP \(bu 2.3
1322 \fIfull\fR
1324 .if n \{\
1325 .RS 4
1328 commit <hash>
1329 Author: <author>
1330 Commit: <committer>
1332 .if n \{\
1336 .if n \{\
1337 .RS 4
1340 <title\-line>
1342 .if n \{\
1346 .if n \{\
1347 .RS 4
1350 <full\-commit\-message>
1352 .if n \{\
1357 .RS 4
1358 .ie n \{\
1359 \h'-04'\(bu\h'+03'\c
1361 .el \{\
1362 .sp -1
1363 .IP \(bu 2.3
1365 \fIfuller\fR
1367 .if n \{\
1368 .RS 4
1371 commit <hash>
1372 Author:     <author>
1373 AuthorDate: <author\-date>
1374 Commit:     <committer>
1375 CommitDate: <committer\-date>
1377 .if n \{\
1381 .if n \{\
1382 .RS 4
1385 <title\-line>
1387 .if n \{\
1391 .if n \{\
1392 .RS 4
1395 <full\-commit\-message>
1397 .if n \{\
1402 .RS 4
1403 .ie n \{\
1404 \h'-04'\(bu\h'+03'\c
1406 .el \{\
1407 .sp -1
1408 .IP \(bu 2.3
1410 \fIreference\fR
1412 .if n \{\
1413 .RS 4
1416 <abbrev\-hash> (<title\-line>, <short\-author\-date>)
1418 .if n \{\
1422 This format is used to refer to another commit in a commit message and is the same as
1423 \fB\-\-pretty=\*(Aqformat:%C(auto)%h (%s, %ad)\*(Aq\fR\&. By default, the date is formatted with
1424 \fB\-\-date=short\fR
1425 unless another
1426 \fB\-\-date\fR
1427 option is explicitly specified\&. As with any
1428 \fBformat:\fR
1429 with format placeholders, its output is not affected by other options like
1430 \fB\-\-decorate\fR
1432 \fB\-\-walk\-reflogs\fR\&.
1435 .RS 4
1436 .ie n \{\
1437 \h'-04'\(bu\h'+03'\c
1439 .el \{\
1440 .sp -1
1441 .IP \(bu 2.3
1443 \fIemail\fR
1445 .if n \{\
1446 .RS 4
1449 From <hash> <date>
1450 From: <author>
1451 Date: <author\-date>
1452 Subject: [PATCH] <title\-line>
1454 .if n \{\
1458 .if n \{\
1459 .RS 4
1462 <full\-commit\-message>
1464 .if n \{\
1469 .RS 4
1470 .ie n \{\
1471 \h'-04'\(bu\h'+03'\c
1473 .el \{\
1474 .sp -1
1475 .IP \(bu 2.3
1477 \fImboxrd\fR
1479 Like
1480 \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\&.
1483 .RS 4
1484 .ie n \{\
1485 \h'-04'\(bu\h'+03'\c
1487 .el \{\
1488 .sp -1
1489 .IP \(bu 2.3
1491 \fIraw\fR
1494 \fIraw\fR
1495 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
1496 \fIparents\fR
1497 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
1498 \fBgit log \-\-raw\fR\&. To get full object names in a raw diff format, use
1499 \fB\-\-no\-abbrev\fR\&.
1502 .RS 4
1503 .ie n \{\
1504 \h'-04'\(bu\h'+03'\c
1506 .el \{\
1507 .sp -1
1508 .IP \(bu 2.3
1510 \fIformat:<format\-string>\fR
1513 \fIformat:<format\-string>\fR
1514 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
1515 \fI%n\fR
1516 instead of
1517 \fI\en\fR\&.
1519 E\&.g,
1520 \fIformat:"The author of %h was %an, %ar%nThe title was >>%s<<%n"\fR
1521 would show something like this:
1523 .if n \{\
1524 .RS 4
1527 The author of fe6e0ee was Junio C Hamano, 23 hours ago
1528 The title was >>t4119: test autocomputing \-p<n> for traditional diff input\&.<<
1530 .if n \{\
1534 The placeholders are:
1536 .RS 4
1537 .ie n \{\
1538 \h'-04'\(bu\h'+03'\c
1540 .el \{\
1541 .sp -1
1542 .IP \(bu 2.3
1544 Placeholders that expand to a single literal character:
1546 \fI%n\fR
1547 .RS 4
1548 newline
1551 \fI%%\fR
1552 .RS 4
1553 a raw
1554 \fI%\fR
1557 \fI%x00\fR
1558 .RS 4
1559 \fI%x\fR
1560 followed by two hexadecimal digits is replaced with a byte with the hexadecimal digits\*(Aq value (we will call this "literal formatting code" in the rest of this document)\&.
1564 .RS 4
1565 .ie n \{\
1566 \h'-04'\(bu\h'+03'\c
1568 .el \{\
1569 .sp -1
1570 .IP \(bu 2.3
1572 Placeholders that affect formatting of later placeholders:
1574 \fI%Cred\fR
1575 .RS 4
1576 switch color to red
1579 \fI%Cgreen\fR
1580 .RS 4
1581 switch color to green
1584 \fI%Cblue\fR
1585 .RS 4
1586 switch color to blue
1589 \fI%Creset\fR
1590 .RS 4
1591 reset color
1594 \fI%C(\&...)\fR
1595 .RS 4
1596 color specification, as described under Values in the "CONFIGURATION FILE" section of
1597 \fBgit-config\fR(1)\&. By default, colors are shown only when enabled for log output (by
1598 \fBcolor\&.diff\fR,
1599 \fBcolor\&.ui\fR, or
1600 \fB\-\-color\fR, and respecting the
1601 \fBauto\fR
1602 settings of the former if we are going to a terminal)\&.
1603 \fB%C(auto,\&.\&.\&.)\fR
1604 is accepted as a historical synonym for the default (e\&.g\&.,
1605 \fB%C(auto,red)\fR)\&. Specifying
1606 \fB%C(always,\&.\&.\&.)\fR
1607 will show the colors even when color is not otherwise enabled (though consider just using
1608 \fB\-\-color=always\fR
1609 to enable color for the whole output, including this format and anything else git might color)\&.
1610 \fBauto\fR
1611 alone (i\&.e\&.
1612 \fB%C(auto)\fR) will turn on auto coloring on the next placeholders until the color is switched again\&.
1615 \fI%m\fR
1616 .RS 4
1617 left (\fB<\fR), right (\fB>\fR) or boundary (\fB\-\fR) mark
1620 \fI%w([<w>[,<i1>[,<i2>]]])\fR
1621 .RS 4
1622 switch line wrapping, like the \-w option of
1623 \fBgit-shortlog\fR(1)\&.
1626 \fI%<( <N> [,trunc|ltrunc|mtrunc])\fR
1627 .RS 4
1628 make the next placeholder take at least N column widths, padding spaces on the right if necessary\&. Optionally truncate (with ellipsis
1629 \fI\&.\&.\fR) at the left (ltrunc)
1630 \fB\&.\&.ft\fR, the middle (mtrunc)
1631 \fBmi\&.\&.le\fR, or the end (trunc)
1632 \fBrig\&.\&.\fR, if the output is longer than N columns\&. Note 1: that truncating only works correctly with N >= 2\&. Note 2: spaces around the N and M (see below) values are optional\&. Note 3: Emojis and other wide characters will take two display columns, which may over\-run column boundaries\&. Note 4: decomposed character combining marks may be misplaced at padding boundaries\&.
1635 \fI%<|( <M> )\fR
1636 .RS 4
1637 make the next placeholder take at least until Mth display column, padding spaces on the right if necessary\&. Use negative M values for column positions measured from the right hand edge of the terminal window\&.
1640 \fI%>( <N> )\fR, \fI%>|( <M> )\fR
1641 .RS 4
1642 similar to
1643 \fI%<( <N> )\fR,
1644 \fI%<|( <M> )\fR
1645 respectively, but padding spaces on the left
1648 \fI%>>( <N> )\fR, \fI%>>|( <M> )\fR
1649 .RS 4
1650 similar to
1651 \fI%>( <N> )\fR,
1652 \fI%>|( <M> )\fR
1653 respectively, except that if the next placeholder takes more spaces than given and there are spaces on its left, use those spaces
1656 \fI%><( <N> )\fR, \fI%><|( <M> )\fR
1657 .RS 4
1658 similar to
1659 \fI%<( <N> )\fR,
1660 \fI%<|( <M> )\fR
1661 respectively, but padding both sides (i\&.e\&. the text is centered)
1665 .RS 4
1666 .ie n \{\
1667 \h'-04'\(bu\h'+03'\c
1669 .el \{\
1670 .sp -1
1671 .IP \(bu 2.3
1673 Placeholders that expand to information extracted from the commit:
1675 \fI%H\fR
1676 .RS 4
1677 commit hash
1680 \fI%h\fR
1681 .RS 4
1682 abbreviated commit hash
1685 \fI%T\fR
1686 .RS 4
1687 tree hash
1690 \fI%t\fR
1691 .RS 4
1692 abbreviated tree hash
1695 \fI%P\fR
1696 .RS 4
1697 parent hashes
1700 \fI%p\fR
1701 .RS 4
1702 abbreviated parent hashes
1705 \fI%an\fR
1706 .RS 4
1707 author name
1710 \fI%aN\fR
1711 .RS 4
1712 author name (respecting \&.mailmap, see
1713 \fBgit-shortlog\fR(1)
1715 \fBgit-blame\fR(1))
1718 \fI%ae\fR
1719 .RS 4
1720 author email
1723 \fI%aE\fR
1724 .RS 4
1725 author email (respecting \&.mailmap, see
1726 \fBgit-shortlog\fR(1)
1728 \fBgit-blame\fR(1))
1731 \fI%al\fR
1732 .RS 4
1733 author email local\-part (the part before the
1734 \fI@\fR
1735 sign)
1738 \fI%aL\fR
1739 .RS 4
1740 author local\-part (see
1741 \fI%al\fR) respecting \&.mailmap, see
1742 \fBgit-shortlog\fR(1)
1744 \fBgit-blame\fR(1))
1747 \fI%ad\fR
1748 .RS 4
1749 author date (format respects \-\-date= option)
1752 \fI%aD\fR
1753 .RS 4
1754 author date, RFC2822 style
1757 \fI%ar\fR
1758 .RS 4
1759 author date, relative
1762 \fI%at\fR
1763 .RS 4
1764 author date, UNIX timestamp
1767 \fI%ai\fR
1768 .RS 4
1769 author date, ISO 8601\-like format
1772 \fI%aI\fR
1773 .RS 4
1774 author date, strict ISO 8601 format
1777 \fI%as\fR
1778 .RS 4
1779 author date, short format (\fBYYYY\-MM\-DD\fR)
1782 \fI%ah\fR
1783 .RS 4
1784 author date, human style (like the
1785 \fB\-\-date=human\fR
1786 option of
1787 \fBgit-rev-list\fR(1))
1790 \fI%cn\fR
1791 .RS 4
1792 committer name
1795 \fI%cN\fR
1796 .RS 4
1797 committer name (respecting \&.mailmap, see
1798 \fBgit-shortlog\fR(1)
1800 \fBgit-blame\fR(1))
1803 \fI%ce\fR
1804 .RS 4
1805 committer email
1808 \fI%cE\fR
1809 .RS 4
1810 committer email (respecting \&.mailmap, see
1811 \fBgit-shortlog\fR(1)
1813 \fBgit-blame\fR(1))
1816 \fI%cl\fR
1817 .RS 4
1818 committer email local\-part (the part before the
1819 \fI@\fR
1820 sign)
1823 \fI%cL\fR
1824 .RS 4
1825 committer local\-part (see
1826 \fI%cl\fR) respecting \&.mailmap, see
1827 \fBgit-shortlog\fR(1)
1829 \fBgit-blame\fR(1))
1832 \fI%cd\fR
1833 .RS 4
1834 committer date (format respects \-\-date= option)
1837 \fI%cD\fR
1838 .RS 4
1839 committer date, RFC2822 style
1842 \fI%cr\fR
1843 .RS 4
1844 committer date, relative
1847 \fI%ct\fR
1848 .RS 4
1849 committer date, UNIX timestamp
1852 \fI%ci\fR
1853 .RS 4
1854 committer date, ISO 8601\-like format
1857 \fI%cI\fR
1858 .RS 4
1859 committer date, strict ISO 8601 format
1862 \fI%cs\fR
1863 .RS 4
1864 committer date, short format (\fBYYYY\-MM\-DD\fR)
1867 \fI%ch\fR
1868 .RS 4
1869 committer date, human style (like the
1870 \fB\-\-date=human\fR
1871 option of
1872 \fBgit-rev-list\fR(1))
1875 \fI%d\fR
1876 .RS 4
1877 ref names, like the \-\-decorate option of
1878 \fBgit-log\fR(1)
1881 \fI%D\fR
1882 .RS 4
1883 ref names without the " (", ")" wrapping\&.
1886 \fI%(decorate[:<options>])\fR
1887 .RS 4
1888 ref names with custom decorations\&. The
1889 \fBdecorate\fR
1890 string may be followed by a colon and zero or more comma\-separated options\&. Option values may contain literal formatting codes\&. These must be used for commas (\fB%x2C\fR) and closing parentheses (\fB%x29\fR), due to their role in the option syntax\&.
1892 .RS 4
1893 .ie n \{\
1894 \h'-04'\(bu\h'+03'\c
1896 .el \{\
1897 .sp -1
1898 .IP \(bu 2.3
1900 \fIprefix=<value>\fR: Shown before the list of ref names\&. Defaults to "\ \&\fB(\fR"\&.
1903 .RS 4
1904 .ie n \{\
1905 \h'-04'\(bu\h'+03'\c
1907 .el \{\
1908 .sp -1
1909 .IP \(bu 2.3
1911 \fIsuffix=<value>\fR: Shown after the list of ref names\&. Defaults to "\fB)\fR"\&.
1914 .RS 4
1915 .ie n \{\
1916 \h'-04'\(bu\h'+03'\c
1918 .el \{\
1919 .sp -1
1920 .IP \(bu 2.3
1922 \fIseparator=<value>\fR: Shown between ref names\&. Defaults to "\fB,\fR\ \&"\&.
1925 .RS 4
1926 .ie n \{\
1927 \h'-04'\(bu\h'+03'\c
1929 .el \{\
1930 .sp -1
1931 .IP \(bu 2.3
1933 \fIpointer=<value>\fR: Shown between HEAD and the branch it points to, if any\&. Defaults to "\ \&\fB\->\fR\ \&"\&.
1936 .RS 4
1937 .ie n \{\
1938 \h'-04'\(bu\h'+03'\c
1940 .el \{\
1941 .sp -1
1942 .IP \(bu 2.3
1944 \fItag=<value>\fR: Shown before tag names\&. Defaults to "\fBtag:\fR\ \&"\&.
1947 For example, to produce decorations with no wrapping or tag annotations, and spaces as separators:
1949 \fB%(decorate:prefix=,suffix=,tag=,separator= )\fR
1952 \fI%(describe[:<options>])\fR
1953 .RS 4
1954 human\-readable name, like
1955 \fBgit-describe\fR(1); empty string for undescribable commits\&. The
1956 \fBdescribe\fR
1957 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\&.
1959 .RS 4
1960 .ie n \{\
1961 \h'-04'\(bu\h'+03'\c
1963 .el \{\
1964 .sp -1
1965 .IP \(bu 2.3
1967 \fItags[=<bool\-value>]\fR: Instead of only considering annotated tags, consider lightweight tags as well\&.
1970 .RS 4
1971 .ie n \{\
1972 \h'-04'\(bu\h'+03'\c
1974 .el \{\
1975 .sp -1
1976 .IP \(bu 2.3
1978 \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\&.
1981 .RS 4
1982 .ie n \{\
1983 \h'-04'\(bu\h'+03'\c
1985 .el \{\
1986 .sp -1
1987 .IP \(bu 2.3
1989 \fImatch=<pattern>\fR: Only consider tags matching the given
1990 \fBglob(7)\fR
1991 pattern, excluding the "refs/tags/" prefix\&.
1994 .RS 4
1995 .ie n \{\
1996 \h'-04'\(bu\h'+03'\c
1998 .el \{\
1999 .sp -1
2000 .IP \(bu 2.3
2002 \fIexclude=<pattern>\fR: Do not consider tags matching the given
2003 \fBglob(7)\fR
2004 pattern, excluding the "refs/tags/" prefix\&.
2008 \fI%S\fR
2009 .RS 4
2010 ref name given on the command line by which the commit was reached (like
2011 \fBgit log \-\-source\fR), only works with
2012 \fBgit log\fR
2015 \fI%e\fR
2016 .RS 4
2017 encoding
2020 \fI%s\fR
2021 .RS 4
2022 subject
2025 \fI%f\fR
2026 .RS 4
2027 sanitized subject line, suitable for a filename
2030 \fI%b\fR
2031 .RS 4
2032 body
2035 \fI%B\fR
2036 .RS 4
2037 raw body (unwrapped subject and body)
2040 \fI%N\fR
2041 .RS 4
2042 commit notes
2045 \fI%GG\fR
2046 .RS 4
2047 raw verification message from GPG for a signed commit
2050 \fI%G?\fR
2051 .RS 4
2052 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
2055 \fI%GS\fR
2056 .RS 4
2057 show the name of the signer for a signed commit
2060 \fI%GK\fR
2061 .RS 4
2062 show the key used to sign a signed commit
2065 \fI%GF\fR
2066 .RS 4
2067 show the fingerprint of the key used to sign a signed commit
2070 \fI%GP\fR
2071 .RS 4
2072 show the fingerprint of the primary key whose subkey was used to sign a signed commit
2075 \fI%GT\fR
2076 .RS 4
2077 show the trust level for the key used to sign a signed commit
2080 \fI%gD\fR
2081 .RS 4
2082 reflog selector, e\&.g\&.,
2083 \fBrefs/stash@{1}\fR
2085 \fBrefs/stash@{2 minutes ago}\fR; the format follows the rules described for the
2086 \fB\-g\fR
2087 option\&. The portion before the
2088 \fB@\fR
2089 is the refname as given on the command line (so
2090 \fBgit log \-g refs/heads/master\fR
2091 would yield
2092 \fBrefs/heads/master@{0}\fR)\&.
2095 \fI%gd\fR
2096 .RS 4
2097 shortened reflog selector; same as
2098 \fB%gD\fR, but the refname portion is shortened for human readability (so
2099 \fBrefs/heads/master\fR
2100 becomes just
2101 \fBmaster\fR)\&.
2104 \fI%gn\fR
2105 .RS 4
2106 reflog identity name
2109 \fI%gN\fR
2110 .RS 4
2111 reflog identity name (respecting \&.mailmap, see
2112 \fBgit-shortlog\fR(1)
2114 \fBgit-blame\fR(1))
2117 \fI%ge\fR
2118 .RS 4
2119 reflog identity email
2122 \fI%gE\fR
2123 .RS 4
2124 reflog identity email (respecting \&.mailmap, see
2125 \fBgit-shortlog\fR(1)
2127 \fBgit-blame\fR(1))
2130 \fI%gs\fR
2131 .RS 4
2132 reflog subject
2135 \fI%(trailers[:<options>])\fR
2136 .RS 4
2137 display the trailers of the body as interpreted by
2138 \fBgit-interpret-trailers\fR(1)\&. The
2139 \fBtrailers\fR
2140 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\&.
2142 .RS 4
2143 .ie n \{\
2144 \h'-04'\(bu\h'+03'\c
2146 .el \{\
2147 .sp -1
2148 .IP \(bu 2.3
2150 \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
2151 \fBonly\fR
2152 option so that non\-trailer lines in the trailer block are hidden\&. If that is not desired it can be disabled with
2153 \fBonly=false\fR\&. E\&.g\&.,
2154 \fB%(trailers:key=Reviewed\-by)\fR
2155 shows trailer lines with key
2156 \fBReviewed\-by\fR\&.
2159 .RS 4
2160 .ie n \{\
2161 \h'-04'\(bu\h'+03'\c
2163 .el \{\
2164 .sp -1
2165 .IP \(bu 2.3
2167 \fIonly[=<bool>]\fR: select whether non\-trailer lines from the trailer block should be included\&.
2170 .RS 4
2171 .ie n \{\
2172 \h'-04'\(bu\h'+03'\c
2174 .el \{\
2175 .sp -1
2176 .IP \(bu 2.3
2178 \fIseparator=<sep>\fR: specify the separator inserted between trailer lines\&. Defaults to a line feed character\&. The string <sep> may contain the literal formatting codes described above\&. To use comma as separator one must use
2179 \fB%x2C\fR
2180 as it would otherwise be parsed as next option\&. E\&.g\&.,
2181 \fB%(trailers:key=Ticket,separator=%x2C )\fR
2182 shows all trailer lines whose key is "Ticket" separated by a comma and a space\&.
2185 .RS 4
2186 .ie n \{\
2187 \h'-04'\(bu\h'+03'\c
2189 .el \{\
2190 .sp -1
2191 .IP \(bu 2.3
2193 \fIunfold[=<bool>]\fR: make it behave as if interpret\-trailer\(cqs
2194 \fB\-\-unfold\fR
2195 option was given\&. E\&.g\&.,
2196 \fB%(trailers:only,unfold=true)\fR
2197 unfolds and shows all trailer lines\&.
2200 .RS 4
2201 .ie n \{\
2202 \h'-04'\(bu\h'+03'\c
2204 .el \{\
2205 .sp -1
2206 .IP \(bu 2.3
2208 \fIkeyonly[=<bool>]\fR: only show the key part of the trailer\&.
2211 .RS 4
2212 .ie n \{\
2213 \h'-04'\(bu\h'+03'\c
2215 .el \{\
2216 .sp -1
2217 .IP \(bu 2.3
2219 \fIvalueonly[=<bool>]\fR: only show the value part of the trailer\&.
2222 .RS 4
2223 .ie n \{\
2224 \h'-04'\(bu\h'+03'\c
2226 .el \{\
2227 .sp -1
2228 .IP \(bu 2.3
2230 \fIkey_value_separator=<sep>\fR: specify the separator inserted between the key and value of each trailer\&. Defaults to ": "\&. Otherwise it shares the same semantics as
2231 \fIseparator=<sep>\fR
2232 above\&.
2237 .if n \{\
2240 .RS 4
2241 .it 1 an-trap
2242 .nr an-no-space-flag 1
2243 .nr an-break-flag 1
2245 .ps +1
2246 \fBNote\fR
2247 .ps -1
2250 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\&.
2251 .sp .5v
2254 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\&.
2256 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\&.
2258 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\&.
2260 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\&.
2262 .RS 4
2263 .ie n \{\
2264 \h'-04'\(bu\h'+03'\c
2266 .el \{\
2267 .sp -1
2268 .IP \(bu 2.3
2270 \fItformat:\fR
2273 \fItformat:\fR
2274 format works exactly like
2275 \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:
2277 .if n \{\
2278 .RS 4
2281 $ git log \-2 \-\-pretty=format:%h 4da45bef \e
2282   | perl \-pe \*(Aq$_ \&.= " \-\- NO NEWLINE\en" unless /\en/\*(Aq
2283 4da45be
2284 7134973 \-\- NO NEWLINE
2286 $ git log \-2 \-\-pretty=tformat:%h 4da45bef \e
2287   | perl \-pe \*(Aq$_ \&.= " \-\- NO NEWLINE\en" unless /\en/\*(Aq
2288 4da45be
2289 7134973
2291 .if n \{\
2295 In addition, any unrecognized string that has a
2296 \fB%\fR
2297 in it is interpreted as if it has
2298 \fBtformat:\fR
2299 in front of it\&. For example, these two are equivalent:
2301 .if n \{\
2302 .RS 4
2305 $ git log \-2 \-\-pretty=tformat:%h 4da45bef
2306 $ git log \-2 \-\-pretty=%h 4da45bef
2308 .if n \{\
2313 .SH "RAW OUTPUT FORMAT"
2315 The raw output format from "git\-diff\-index", "git\-diff\-tree", "git\-diff\-files" and "git diff \-\-raw" are very similar\&.
2317 These commands all compare two sets of things; what is compared differs:
2319 git\-diff\-index <tree\-ish>
2320 .RS 4
2321 compares the <tree\-ish> and the files on the filesystem\&.
2324 git\-diff\-index \-\-cached <tree\-ish>
2325 .RS 4
2326 compares the <tree\-ish> and the index\&.
2329 git\-diff\-tree [\-r] <tree\-ish\-1> <tree\-ish\-2> [<pattern>\&...]
2330 .RS 4
2331 compares the trees named by the two arguments\&.
2334 git\-diff\-files [<pattern>\&...]
2335 .RS 4
2336 compares the index and the files on the filesystem\&.
2339 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\&.
2341 An output line is formatted this way:
2343 .if n \{\
2344 .RS 4
2347 in\-place edit  :100644 100644 bcd1234 0123456 M file0
2348 copy\-edit      :100644 100644 abcd123 1234567 C68 file1 file2
2349 rename\-edit    :100644 100644 abcd123 1234567 R86 file1 file3
2350 create         :000000 100644 0000000 1234567 A file4
2351 delete         :100644 000000 1234567 0000000 D file5
2352 unmerged       :000000 000000 0000000 0000000 U file6
2354 .if n \{\
2359 That is, from the left to the right:
2361 .RS 4
2362 .ie n \{\
2363 \h'-04' 1.\h'+01'\c
2365 .el \{\
2366 .sp -1
2367 .IP "  1." 4.2
2369 a colon\&.
2372 .RS 4
2373 .ie n \{\
2374 \h'-04' 2.\h'+01'\c
2376 .el \{\
2377 .sp -1
2378 .IP "  2." 4.2
2380 mode for "src"; 000000 if creation or unmerged\&.
2383 .RS 4
2384 .ie n \{\
2385 \h'-04' 3.\h'+01'\c
2387 .el \{\
2388 .sp -1
2389 .IP "  3." 4.2
2391 a space\&.
2394 .RS 4
2395 .ie n \{\
2396 \h'-04' 4.\h'+01'\c
2398 .el \{\
2399 .sp -1
2400 .IP "  4." 4.2
2402 mode for "dst"; 000000 if deletion or unmerged\&.
2405 .RS 4
2406 .ie n \{\
2407 \h'-04' 5.\h'+01'\c
2409 .el \{\
2410 .sp -1
2411 .IP "  5." 4.2
2413 a space\&.
2416 .RS 4
2417 .ie n \{\
2418 \h'-04' 6.\h'+01'\c
2420 .el \{\
2421 .sp -1
2422 .IP "  6." 4.2
2424 sha1 for "src"; 0{40} if creation or unmerged\&.
2427 .RS 4
2428 .ie n \{\
2429 \h'-04' 7.\h'+01'\c
2431 .el \{\
2432 .sp -1
2433 .IP "  7." 4.2
2435 a space\&.
2438 .RS 4
2439 .ie n \{\
2440 \h'-04' 8.\h'+01'\c
2442 .el \{\
2443 .sp -1
2444 .IP "  8." 4.2
2446 sha1 for "dst"; 0{40} if deletion, unmerged or "work tree out of sync with the index"\&.
2449 .RS 4
2450 .ie n \{\
2451 \h'-04' 9.\h'+01'\c
2453 .el \{\
2454 .sp -1
2455 .IP "  9." 4.2
2457 a space\&.
2460 .RS 4
2461 .ie n \{\
2462 \h'-04'10.\h'+01'\c
2464 .el \{\
2465 .sp -1
2466 .IP "10." 4.2
2468 status, followed by optional "score" number\&.
2471 .RS 4
2472 .ie n \{\
2473 \h'-04'11.\h'+01'\c
2475 .el \{\
2476 .sp -1
2477 .IP "11." 4.2
2479 a tab or a NUL when
2480 \fB\-z\fR
2481 option is used\&.
2484 .RS 4
2485 .ie n \{\
2486 \h'-04'12.\h'+01'\c
2488 .el \{\
2489 .sp -1
2490 .IP "12." 4.2
2492 path for "src"
2495 .RS 4
2496 .ie n \{\
2497 \h'-04'13.\h'+01'\c
2499 .el \{\
2500 .sp -1
2501 .IP "13." 4.2
2503 a tab or a NUL when
2504 \fB\-z\fR
2505 option is used; only exists for C or R\&.
2508 .RS 4
2509 .ie n \{\
2510 \h'-04'14.\h'+01'\c
2512 .el \{\
2513 .sp -1
2514 .IP "14." 4.2
2516 path for "dst"; only exists for C or R\&.
2519 .RS 4
2520 .ie n \{\
2521 \h'-04'15.\h'+01'\c
2523 .el \{\
2524 .sp -1
2525 .IP "15." 4.2
2527 an LF or a NUL when
2528 \fB\-z\fR
2529 option is used, to terminate the record\&.
2532 Possible status letters are:
2534 .RS 4
2535 .ie n \{\
2536 \h'-04'\(bu\h'+03'\c
2538 .el \{\
2539 .sp -1
2540 .IP \(bu 2.3
2542 A: addition of a file
2545 .RS 4
2546 .ie n \{\
2547 \h'-04'\(bu\h'+03'\c
2549 .el \{\
2550 .sp -1
2551 .IP \(bu 2.3
2553 C: copy of a file into a new one
2556 .RS 4
2557 .ie n \{\
2558 \h'-04'\(bu\h'+03'\c
2560 .el \{\
2561 .sp -1
2562 .IP \(bu 2.3
2564 D: deletion of a file
2567 .RS 4
2568 .ie n \{\
2569 \h'-04'\(bu\h'+03'\c
2571 .el \{\
2572 .sp -1
2573 .IP \(bu 2.3
2575 M: modification of the contents or mode of a file
2578 .RS 4
2579 .ie n \{\
2580 \h'-04'\(bu\h'+03'\c
2582 .el \{\
2583 .sp -1
2584 .IP \(bu 2.3
2586 R: renaming of a file
2589 .RS 4
2590 .ie n \{\
2591 \h'-04'\(bu\h'+03'\c
2593 .el \{\
2594 .sp -1
2595 .IP \(bu 2.3
2597 T: change in the type of the file (regular file, symbolic link or submodule)
2600 .RS 4
2601 .ie n \{\
2602 \h'-04'\(bu\h'+03'\c
2604 .el \{\
2605 .sp -1
2606 .IP \(bu 2.3
2608 U: file is unmerged (you must complete the merge before it can be committed)
2611 .RS 4
2612 .ie n \{\
2613 \h'-04'\(bu\h'+03'\c
2615 .el \{\
2616 .sp -1
2617 .IP \(bu 2.3
2619 X: "unknown" change type (most probably a bug, please report it)
2622 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\&.
2624 The sha1 for "dst" is shown as all 0\(cqs if a file on the filesystem is out of sync with the index\&.
2626 Example:
2628 .if n \{\
2629 .RS 4
2632 :100644 100644 5be4a4a 0000000 M file\&.c
2634 .if n \{\
2639 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\&.
2640 .SH "DIFF FORMAT FOR MERGES"
2642 "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:
2644 .RS 4
2645 .ie n \{\
2646 \h'-04' 1.\h'+01'\c
2648 .el \{\
2649 .sp -1
2650 .IP "  1." 4.2
2652 there is a colon for each parent
2655 .RS 4
2656 .ie n \{\
2657 \h'-04' 2.\h'+01'\c
2659 .el \{\
2660 .sp -1
2661 .IP "  2." 4.2
2663 there are more "src" modes and "src" sha1
2666 .RS 4
2667 .ie n \{\
2668 \h'-04' 3.\h'+01'\c
2670 .el \{\
2671 .sp -1
2672 .IP "  3." 4.2
2674 status is concatenated status characters for each parent
2677 .RS 4
2678 .ie n \{\
2679 \h'-04' 4.\h'+01'\c
2681 .el \{\
2682 .sp -1
2683 .IP "  4." 4.2
2685 no optional "score" number
2688 .RS 4
2689 .ie n \{\
2690 \h'-04' 5.\h'+01'\c
2692 .el \{\
2693 .sp -1
2694 .IP "  5." 4.2
2696 tab\-separated pathname(s) of the file
2699 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\&.
2701 Examples for \fB\-c\fR and \fB\-\-cc\fR without \fB\-\-combined\-all\-paths\fR:
2703 .if n \{\
2704 .RS 4
2707 ::100644 100644 100644 fabadb8 cc95eb0 4866510 MM       desc\&.c
2708 ::100755 100755 100755 52b7a2d 6d1ac04 d2ac7d7 RM       bar\&.sh
2709 ::100644 100644 100644 e07d6c5 9042e82 ee91881 RR       phooey\&.c
2711 .if n \{\
2716 Examples when \fB\-\-combined\-all\-paths\fR added to either \fB\-c\fR or \fB\-\-cc\fR:
2718 .if n \{\
2719 .RS 4
2722 ::100644 100644 100644 fabadb8 cc95eb0 4866510 MM       desc\&.c  desc\&.c  desc\&.c
2723 ::100755 100755 100755 52b7a2d 6d1ac04 d2ac7d7 RM       foo\&.sh  bar\&.sh  bar\&.sh
2724 ::100644 100644 100644 e07d6c5 9042e82 ee91881 RR       fooey\&.c fuey\&.c  phooey\&.c
2726 .if n \{\
2731 Note that \fIcombined diff\fR lists only files which were modified from all parents\&.
2732 .SH "GENERATING PATCH TEXT WITH \-P"
2734 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))\&.
2736 What the \-p option produces is slightly different from the traditional diff format:
2738 .RS 4
2739 .ie n \{\
2740 \h'-04' 1.\h'+01'\c
2742 .el \{\
2743 .sp -1
2744 .IP "  1." 4.2
2746 It is preceded by a "git diff" header that looks like this:
2748 .if n \{\
2749 .RS 4
2752 diff \-\-git a/file1 b/file2
2754 .if n \{\
2759 \fBa/\fR
2761 \fBb/\fR
2762 filenames are the same unless rename/copy is involved\&. Especially, even for a creation or a deletion,
2763 \fB/dev/null\fR
2765 \fInot\fR
2766 used in place of the
2767 \fBa/\fR
2769 \fBb/\fR
2770 filenames\&.
2772 When a rename/copy is involved,
2773 \fBfile1\fR
2775 \fBfile2\fR
2776 show the name of the source file of the rename/copy and the name of the file that the rename/copy produces, respectively\&.
2779 .RS 4
2780 .ie n \{\
2781 \h'-04' 2.\h'+01'\c
2783 .el \{\
2784 .sp -1
2785 .IP "  2." 4.2
2787 It is followed by one or more extended header lines:
2789 .if n \{\
2790 .RS 4
2793 old mode <mode>
2794 new mode <mode>
2795 deleted file mode <mode>
2796 new file mode <mode>
2797 copy from <path>
2798 copy to <path>
2799 rename from <path>
2800 rename to <path>
2801 similarity index <number>
2802 dissimilarity index <number>
2803 index <hash>\&.\&.<hash> <mode>
2805 .if n \{\
2809 File modes are printed as 6\-digit octal numbers including the file type and file permission bits\&.
2811 Path names in extended headers do not include the
2812 \fBa/\fR
2814 \fBb/\fR
2815 prefixes\&.
2817 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\&.
2819 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\&.
2822 .RS 4
2823 .ie n \{\
2824 \h'-04' 3.\h'+01'\c
2826 .el \{\
2827 .sp -1
2828 .IP "  3." 4.2
2830 Pathnames with "unusual" characters are quoted as explained for the configuration variable
2831 \fBcore\&.quotePath\fR
2832 (see
2833 \fBgit-config\fR(1))\&.
2836 .RS 4
2837 .ie n \{\
2838 \h'-04' 4.\h'+01'\c
2840 .el \{\
2841 .sp -1
2842 .IP "  4." 4.2
2844 All the
2845 \fBfile1\fR
2846 files in the output refer to files before the commit, and all the
2847 \fBfile2\fR
2848 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:
2850 .if n \{\
2851 .RS 4
2854 diff \-\-git a/a b/b
2855 rename from a
2856 rename to b
2857 diff \-\-git a/b b/a
2858 rename from b
2859 rename to a
2861 .if n \{\
2866 .RS 4
2867 .ie n \{\
2868 \h'-04' 5.\h'+01'\c
2870 .el \{\
2871 .sp -1
2872 .IP "  5." 4.2
2874 Hunk headers mention the name of the function to which the hunk applies\&. See "Defining a custom hunk\-header" in
2875 \fBgitattributes\fR(5)
2876 for details of how to tailor this to specific languages\&.
2878 .SH "COMBINED DIFF FORMAT"
2880 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\&.
2882 A "combined diff" format looks like this:
2884 .if n \{\
2885 .RS 4
2888 diff \-\-combined describe\&.c
2889 index fabadb8,cc95eb0\&.\&.4866510
2890 \-\-\- a/describe\&.c
2891 +++ b/describe\&.c
2892 @@@ \-98,20 \-98,12 +98,20 @@@
2893         return (a_date > b_date) ? \-1 : (a_date == b_date) ? 0 : 1;
2894   }
2896 \- static void describe(char *arg)
2897  \-static void describe(struct commit *cmit, int last_one)
2898 ++static void describe(char *arg, int last_one)
2899   {
2900  +      unsigned char sha1[20];
2901  +      struct commit *cmit;
2902         struct commit_list *list;
2903         static int initialized = 0;
2904         struct commit_name *n;
2906  +      if (get_sha1(arg, sha1) < 0)
2907  +              usage(describe_usage);
2908  +      cmit = lookup_commit_reference(sha1);
2909  +      if (!cmit)
2910  +              usage(describe_usage);
2912         if (!initialized) {
2913                 initialized = 1;
2914                 for_each_ref(get_name);
2916 .if n \{\
2922 .RS 4
2923 .ie n \{\
2924 \h'-04' 1.\h'+01'\c
2926 .el \{\
2927 .sp -1
2928 .IP "  1." 4.2
2930 It is preceded by a "git diff" header, that looks like this (when the
2931 \fB\-c\fR
2932 option is used):
2934 .if n \{\
2935 .RS 4
2938 diff \-\-combined file
2940 .if n \{\
2944 or like this (when the
2945 \fB\-\-cc\fR
2946 option is used):
2948 .if n \{\
2949 .RS 4
2952 diff \-\-cc file
2954 .if n \{\
2959 .RS 4
2960 .ie n \{\
2961 \h'-04' 2.\h'+01'\c
2963 .el \{\
2964 .sp -1
2965 .IP "  2." 4.2
2967 It is followed by one or more extended header lines (this example shows a merge with two parents):
2969 .if n \{\
2970 .RS 4
2973 index <hash>,<hash>\&.\&.<hash>
2974 mode <mode>,<mode>\&.\&.<mode>
2975 new file mode <mode>
2976 deleted file mode <mode>,<mode>
2978 .if n \{\
2983 \fBmode <mode>,<mode>\&.\&.<mode>\fR
2984 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\&.
2987 .RS 4
2988 .ie n \{\
2989 \h'-04' 3.\h'+01'\c
2991 .el \{\
2992 .sp -1
2993 .IP "  3." 4.2
2995 It is followed by a two\-line from\-file/to\-file header:
2997 .if n \{\
2998 .RS 4
3001 \-\-\- a/file
3002 +++ b/file
3004 .if n \{\
3008 Similar to the two\-line header for the traditional
3009 \fIunified\fR
3010 diff format,
3011 \fB/dev/null\fR
3012 is used to signal created or deleted files\&.
3014 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:
3016 .if n \{\
3017 .RS 4
3020 \-\-\- a/file
3021 \-\-\- a/file
3022 \-\-\- a/file
3023 +++ b/file
3025 .if n \{\
3029 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\&.
3032 .RS 4
3033 .ie n \{\
3034 \h'-04' 4.\h'+01'\c
3036 .el \{\
3037 .sp -1
3038 .IP "  4." 4.2
3040 Chunk header format is modified to prevent people from accidentally feeding it to
3041 \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
3042 \fIindex\fR
3043 header:
3045 .if n \{\
3046 .RS 4
3049 @@@ <from\-file\-range> <from\-file\-range> <to\-file\-range> @@@
3051 .if n \{\
3055 There are (number of parents + 1)
3056 \fB@\fR
3057 characters in the chunk header for combined diff format\&.
3060 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\&.
3062 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)\&.
3064 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)\&.
3066 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")\&.
3067 .SH "OTHER DIFF FORMATS"
3069 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\&.
3071 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:
3073 .if n \{\
3074 .RS 4
3077 arch/{i386 => x86}/Makefile    |   4 +\-\-
3079 .if n \{\
3084 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:
3086 .if n \{\
3087 .RS 4
3090 1       2       README
3091 3       1       arch/{i386 => x86}/Makefile
3093 .if n \{\
3098 That is, from left to right:
3100 .RS 4
3101 .ie n \{\
3102 \h'-04' 1.\h'+01'\c
3104 .el \{\
3105 .sp -1
3106 .IP "  1." 4.2
3108 the number of added lines;
3111 .RS 4
3112 .ie n \{\
3113 \h'-04' 2.\h'+01'\c
3115 .el \{\
3116 .sp -1
3117 .IP "  2." 4.2
3119 a tab;
3122 .RS 4
3123 .ie n \{\
3124 \h'-04' 3.\h'+01'\c
3126 .el \{\
3127 .sp -1
3128 .IP "  3." 4.2
3130 the number of deleted lines;
3133 .RS 4
3134 .ie n \{\
3135 \h'-04' 4.\h'+01'\c
3137 .el \{\
3138 .sp -1
3139 .IP "  4." 4.2
3141 a tab;
3144 .RS 4
3145 .ie n \{\
3146 \h'-04' 5.\h'+01'\c
3148 .el \{\
3149 .sp -1
3150 .IP "  5." 4.2
3152 pathname (possibly with rename/copy information);
3155 .RS 4
3156 .ie n \{\
3157 \h'-04' 6.\h'+01'\c
3159 .el \{\
3160 .sp -1
3161 .IP "  6." 4.2
3163 a newline\&.
3166 When \fB\-z\fR output option is in effect, the output is formatted this way:
3168 .if n \{\
3169 .RS 4
3172 1       2       README NUL
3173 3       1       NUL arch/i386/Makefile NUL arch/x86/Makefile NUL
3175 .if n \{\
3180 That is:
3182 .RS 4
3183 .ie n \{\
3184 \h'-04' 1.\h'+01'\c
3186 .el \{\
3187 .sp -1
3188 .IP "  1." 4.2
3190 the number of added lines;
3193 .RS 4
3194 .ie n \{\
3195 \h'-04' 2.\h'+01'\c
3197 .el \{\
3198 .sp -1
3199 .IP "  2." 4.2
3201 a tab;
3204 .RS 4
3205 .ie n \{\
3206 \h'-04' 3.\h'+01'\c
3208 .el \{\
3209 .sp -1
3210 .IP "  3." 4.2
3212 the number of deleted lines;
3215 .RS 4
3216 .ie n \{\
3217 \h'-04' 4.\h'+01'\c
3219 .el \{\
3220 .sp -1
3221 .IP "  4." 4.2
3223 a tab;
3226 .RS 4
3227 .ie n \{\
3228 \h'-04' 5.\h'+01'\c
3230 .el \{\
3231 .sp -1
3232 .IP "  5." 4.2
3234 a NUL (only exists if renamed/copied);
3237 .RS 4
3238 .ie n \{\
3239 \h'-04' 6.\h'+01'\c
3241 .el \{\
3242 .sp -1
3243 .IP "  6." 4.2
3245 pathname in preimage;
3248 .RS 4
3249 .ie n \{\
3250 \h'-04' 7.\h'+01'\c
3252 .el \{\
3253 .sp -1
3254 .IP "  7." 4.2
3256 a NUL (only exists if renamed/copied);
3259 .RS 4
3260 .ie n \{\
3261 \h'-04' 8.\h'+01'\c
3263 .el \{\
3264 .sp -1
3265 .IP "  8." 4.2
3267 pathname in postimage (only exists if renamed/copied);
3270 .RS 4
3271 .ie n \{\
3272 \h'-04' 9.\h'+01'\c
3274 .el \{\
3275 .sp -1
3276 .IP "  9." 4.2
3278 a NUL\&.
3281 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\&.
3282 .SH "GIT"
3284 Part of the \fBgit\fR(1) suite