Autogenerated manpages for v2.42.0-rc1-11-gfc6bb
[git-manpages.git] / man1 / git-show.1
blobf8111a360eda52001fc87ecbab3f382238393cc9
1 '\" t
2 .\"     Title: git-show
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: 2023-08-14
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.42.0.rc1.11.gfc6bba66bc
8 .\"  Language: English
9 .\"
10 .TH "GIT\-SHOW" "1" "2023\-08\-14" "Git 2\&.42\&.0\&.rc1\&.11\&.gf" "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-show \- Show various types of objects
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit show\fR [<options>] [<object>\&...]
36 .fi
37 .sp
38 .SH "DESCRIPTION"
39 .sp
40 Shows one or more objects (blobs, trees, tags and commits)\&.
41 .sp
42 For commits it shows the log message and textual diff\&. It also presents the merge commit in a special format as produced by \fIgit diff\-tree \-\-cc\fR\&.
43 .sp
44 For tags, it shows the tag message and the referenced objects\&.
45 .sp
46 For trees, it shows the names (equivalent to \fIgit ls\-tree\fR with \-\-name\-only)\&.
47 .sp
48 For plain blobs, it shows the plain contents\&.
49 .sp
50 The command takes options applicable to the \fIgit diff\-tree\fR command to control how the changes the commit introduces are shown\&.
51 .sp
52 This manual page describes only the most frequently used options\&.
53 .SH "OPTIONS"
54 .PP
55 <object>\&...
56 .RS 4
57 The names of objects to show (defaults to
58 \fIHEAD\fR)\&. For a more complete list of ways to spell object names, see "SPECIFYING REVISIONS" section in
59 \fBgitrevisions\fR(7)\&.
60 .RE
61 .PP
62 \-\-pretty[=<format>], \-\-format=<format>
63 .RS 4
64 Pretty\-print the contents of the commit logs in a given format, where
65 \fI<format>\fR
66 can be one of
67 \fIoneline\fR,
68 \fIshort\fR,
69 \fImedium\fR,
70 \fIfull\fR,
71 \fIfuller\fR,
72 \fIreference\fR,
73 \fIemail\fR,
74 \fIraw\fR,
75 \fIformat:<string>\fR
76 and
77 \fItformat:<string>\fR\&. When
78 \fI<format>\fR
79 is none of the above, and has
80 \fI%placeholder\fR
81 in it, it acts as if
82 \fI\-\-pretty=tformat:<format>\fR
83 were given\&.
84 .sp
85 See the "PRETTY FORMATS" section for some additional details for each format\&. When
86 \fI=<format>\fR
87 part is omitted, it defaults to
88 \fImedium\fR\&.
89 .sp
90 Note: you can specify the default pretty format in the repository configuration (see
91 \fBgit-config\fR(1))\&.
92 .RE
93 .PP
94 \-\-abbrev\-commit
95 .RS 4
96 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\&.
97 .sp
98 This should make "\-\-pretty=oneline" a whole lot more readable for people using 80\-column terminals\&.
99 .RE
101 \-\-no\-abbrev\-commit
102 .RS 4
103 Show the full 40\-byte hexadecimal commit object name\&. This negates
104 \fB\-\-abbrev\-commit\fR, either explicit or implied by other options such as "\-\-oneline"\&. It also overrides the
105 \fBlog\&.abbrevCommit\fR
106 variable\&.
109 \-\-oneline
110 .RS 4
111 This is a shorthand for "\-\-pretty=oneline \-\-abbrev\-commit" used together\&.
114 \-\-encoding=<encoding>
115 .RS 4
116 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
117 \fBX\fR
118 and we are outputting in
119 \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\&.
122 \-\-expand\-tabs=<n>, \-\-expand\-tabs, \-\-no\-expand\-tabs
123 .RS 4
124 Perform a tab expansion (replace each tab with enough spaces to fill to the next display column that is multiple of
125 \fI<n>\fR) in the log message before showing it in the output\&.
126 \fB\-\-expand\-tabs\fR
127 is a short\-hand for
128 \fB\-\-expand\-tabs=8\fR, and
129 \fB\-\-no\-expand\-tabs\fR
130 is a short\-hand for
131 \fB\-\-expand\-tabs=0\fR, which disables tab expansion\&.
133 By default, tabs are expanded in pretty formats that indent the log message by 4 spaces (i\&.e\&.
134 \fImedium\fR, which is the default,
135 \fIfull\fR, and
136 \fIfuller\fR)\&.
139 \-\-notes[=<ref>]
140 .RS 4
141 Show the notes (see
142 \fBgit-notes\fR(1)) that annotate the commit, when showing the commit log message\&. This is the default for
143 \fBgit log\fR,
144 \fBgit show\fR
146 \fBgit whatchanged\fR
147 commands when there is no
148 \fB\-\-pretty\fR,
149 \fB\-\-format\fR, or
150 \fB\-\-oneline\fR
151 option given on the command line\&.
153 By default, the notes shown are from the notes refs listed in the
154 \fBcore\&.notesRef\fR
156 \fBnotes\&.displayRef\fR
157 variables (or corresponding environment overrides)\&. See
158 \fBgit-config\fR(1)
159 for more details\&.
161 With an optional
162 \fI<ref>\fR
163 argument, use the ref to find the notes to display\&. The ref can specify the full refname when it begins with
164 \fBrefs/notes/\fR; when it begins with
165 \fBnotes/\fR,
166 \fBrefs/\fR
167 and otherwise
168 \fBrefs/notes/\fR
169 is prefixed to form a full name of the ref\&.
171 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)\&.
174 \-\-no\-notes
175 .RS 4
176 Do not show notes\&. This negates the above
177 \fB\-\-notes\fR
178 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"\&.
181 \-\-show\-notes[=<ref>], \-\-[no\-]standard\-notes
182 .RS 4
183 These options are deprecated\&. Use the above \-\-notes/\-\-no\-notes options instead\&.
186 \-\-show\-signature
187 .RS 4
188 Check the validity of a signed commit object by passing the signature to
189 \fBgpg \-\-verify\fR
190 and show the output\&.
192 .SH "PRETTY FORMATS"
194 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\&.
196 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:
198 .RS 4
199 .ie n \{\
200 \h'-04'\(bu\h'+03'\c
202 .el \{\
203 .sp -1
204 .IP \(bu 2.3
206 \fIoneline\fR
208 .if n \{\
209 .RS 4
212 <hash> <title\-line>
214 .if n \{\
218 This is designed to be as compact as possible\&.
221 .RS 4
222 .ie n \{\
223 \h'-04'\(bu\h'+03'\c
225 .el \{\
226 .sp -1
227 .IP \(bu 2.3
229 \fIshort\fR
231 .if n \{\
232 .RS 4
235 commit <hash>
236 Author: <author>
238 .if n \{\
242 .if n \{\
243 .RS 4
246 <title\-line>
248 .if n \{\
253 .RS 4
254 .ie n \{\
255 \h'-04'\(bu\h'+03'\c
257 .el \{\
258 .sp -1
259 .IP \(bu 2.3
261 \fImedium\fR
263 .if n \{\
264 .RS 4
267 commit <hash>
268 Author: <author>
269 Date:   <author\-date>
271 .if n \{\
275 .if n \{\
276 .RS 4
279 <title\-line>
281 .if n \{\
285 .if n \{\
286 .RS 4
289 <full\-commit\-message>
291 .if n \{\
296 .RS 4
297 .ie n \{\
298 \h'-04'\(bu\h'+03'\c
300 .el \{\
301 .sp -1
302 .IP \(bu 2.3
304 \fIfull\fR
306 .if n \{\
307 .RS 4
310 commit <hash>
311 Author: <author>
312 Commit: <committer>
314 .if n \{\
318 .if n \{\
319 .RS 4
322 <title\-line>
324 .if n \{\
328 .if n \{\
329 .RS 4
332 <full\-commit\-message>
334 .if n \{\
339 .RS 4
340 .ie n \{\
341 \h'-04'\(bu\h'+03'\c
343 .el \{\
344 .sp -1
345 .IP \(bu 2.3
347 \fIfuller\fR
349 .if n \{\
350 .RS 4
353 commit <hash>
354 Author:     <author>
355 AuthorDate: <author\-date>
356 Commit:     <committer>
357 CommitDate: <committer\-date>
359 .if n \{\
363 .if n \{\
364 .RS 4
367 <title\-line>
369 .if n \{\
373 .if n \{\
374 .RS 4
377 <full\-commit\-message>
379 .if n \{\
384 .RS 4
385 .ie n \{\
386 \h'-04'\(bu\h'+03'\c
388 .el \{\
389 .sp -1
390 .IP \(bu 2.3
392 \fIreference\fR
394 .if n \{\
395 .RS 4
398 <abbrev\-hash> (<title\-line>, <short\-author\-date>)
400 .if n \{\
404 This format is used to refer to another commit in a commit message and is the same as
405 \fB\-\-pretty=\*(Aqformat:%C(auto)%h (%s, %ad)\*(Aq\fR\&. By default, the date is formatted with
406 \fB\-\-date=short\fR
407 unless another
408 \fB\-\-date\fR
409 option is explicitly specified\&. As with any
410 \fBformat:\fR
411 with format placeholders, its output is not affected by other options like
412 \fB\-\-decorate\fR
414 \fB\-\-walk\-reflogs\fR\&.
417 .RS 4
418 .ie n \{\
419 \h'-04'\(bu\h'+03'\c
421 .el \{\
422 .sp -1
423 .IP \(bu 2.3
425 \fIemail\fR
427 .if n \{\
428 .RS 4
431 From <hash> <date>
432 From: <author>
433 Date: <author\-date>
434 Subject: [PATCH] <title\-line>
436 .if n \{\
440 .if n \{\
441 .RS 4
444 <full\-commit\-message>
446 .if n \{\
451 .RS 4
452 .ie n \{\
453 \h'-04'\(bu\h'+03'\c
455 .el \{\
456 .sp -1
457 .IP \(bu 2.3
459 \fImboxrd\fR
461 Like
462 \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\&.
465 .RS 4
466 .ie n \{\
467 \h'-04'\(bu\h'+03'\c
469 .el \{\
470 .sp -1
471 .IP \(bu 2.3
473 \fIraw\fR
476 \fIraw\fR
477 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
478 \fIparents\fR
479 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
480 \fBgit log \-\-raw\fR\&. To get full object names in a raw diff format, use
481 \fB\-\-no\-abbrev\fR\&.
484 .RS 4
485 .ie n \{\
486 \h'-04'\(bu\h'+03'\c
488 .el \{\
489 .sp -1
490 .IP \(bu 2.3
492 \fIformat:<format\-string>\fR
495 \fIformat:<format\-string>\fR
496 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
497 \fI%n\fR
498 instead of
499 \fI\en\fR\&.
501 E\&.g,
502 \fIformat:"The author of %h was %an, %ar%nThe title was >>%s<<%n"\fR
503 would show something like this:
505 .if n \{\
506 .RS 4
509 The author of fe6e0ee was Junio C Hamano, 23 hours ago
510 The title was >>t4119: test autocomputing \-p<n> for traditional diff input\&.<<
512 .if n \{\
516 The placeholders are:
518 .RS 4
519 .ie n \{\
520 \h'-04'\(bu\h'+03'\c
522 .el \{\
523 .sp -1
524 .IP \(bu 2.3
526 Placeholders that expand to a single literal character:
528 \fI%n\fR
529 .RS 4
530 newline
533 \fI%%\fR
534 .RS 4
535 a raw
536 \fI%\fR
539 \fI%x00\fR
540 .RS 4
541 print a byte from a hex code
545 .RS 4
546 .ie n \{\
547 \h'-04'\(bu\h'+03'\c
549 .el \{\
550 .sp -1
551 .IP \(bu 2.3
553 Placeholders that affect formatting of later placeholders:
555 \fI%Cred\fR
556 .RS 4
557 switch color to red
560 \fI%Cgreen\fR
561 .RS 4
562 switch color to green
565 \fI%Cblue\fR
566 .RS 4
567 switch color to blue
570 \fI%Creset\fR
571 .RS 4
572 reset color
575 \fI%C(\&...)\fR
576 .RS 4
577 color specification, as described under Values in the "CONFIGURATION FILE" section of
578 \fBgit-config\fR(1)\&. By default, colors are shown only when enabled for log output (by
579 \fBcolor\&.diff\fR,
580 \fBcolor\&.ui\fR, or
581 \fB\-\-color\fR, and respecting the
582 \fBauto\fR
583 settings of the former if we are going to a terminal)\&.
584 \fB%C(auto,\&.\&.\&.)\fR
585 is accepted as a historical synonym for the default (e\&.g\&.,
586 \fB%C(auto,red)\fR)\&. Specifying
587 \fB%C(always,\&.\&.\&.)\fR
588 will show the colors even when color is not otherwise enabled (though consider just using
589 \fB\-\-color=always\fR
590 to enable color for the whole output, including this format and anything else git might color)\&.
591 \fBauto\fR
592 alone (i\&.e\&.
593 \fB%C(auto)\fR) will turn on auto coloring on the next placeholders until the color is switched again\&.
596 \fI%m\fR
597 .RS 4
598 left (\fB<\fR), right (\fB>\fR) or boundary (\fB\-\fR) mark
601 \fI%w([<w>[,<i1>[,<i2>]]])\fR
602 .RS 4
603 switch line wrapping, like the \-w option of
604 \fBgit-shortlog\fR(1)\&.
607 \fI%<( <N> [,trunc|ltrunc|mtrunc])\fR
608 .RS 4
609 make the next placeholder take at least N column widths, padding spaces on the right if necessary\&. Optionally truncate (with ellipsis
610 \fI\&.\&.\fR) at the left (ltrunc)
611 \fB\&.\&.ft\fR, the middle (mtrunc)
612 \fBmi\&.\&.le\fR, or the end (trunc)
613 \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\&.
616 \fI%<|( <M> )\fR
617 .RS 4
618 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\&.
621 \fI%>( <N> )\fR, \fI%>|( <M> )\fR
622 .RS 4
623 similar to
624 \fI%<( <N> )\fR,
625 \fI%<|( <M> )\fR
626 respectively, but padding spaces on the left
629 \fI%>>( <N> )\fR, \fI%>>|( <M> )\fR
630 .RS 4
631 similar to
632 \fI%>( <N> )\fR,
633 \fI%>|( <M> )\fR
634 respectively, except that if the next placeholder takes more spaces than given and there are spaces on its left, use those spaces
637 \fI%><( <N> )\fR, \fI%><|( <M> )\fR
638 .RS 4
639 similar to
640 \fI%<( <N> )\fR,
641 \fI%<|( <M> )\fR
642 respectively, but padding both sides (i\&.e\&. the text is centered)
646 .RS 4
647 .ie n \{\
648 \h'-04'\(bu\h'+03'\c
650 .el \{\
651 .sp -1
652 .IP \(bu 2.3
654 Placeholders that expand to information extracted from the commit:
656 \fI%H\fR
657 .RS 4
658 commit hash
661 \fI%h\fR
662 .RS 4
663 abbreviated commit hash
666 \fI%T\fR
667 .RS 4
668 tree hash
671 \fI%t\fR
672 .RS 4
673 abbreviated tree hash
676 \fI%P\fR
677 .RS 4
678 parent hashes
681 \fI%p\fR
682 .RS 4
683 abbreviated parent hashes
686 \fI%an\fR
687 .RS 4
688 author name
691 \fI%aN\fR
692 .RS 4
693 author name (respecting \&.mailmap, see
694 \fBgit-shortlog\fR(1)
696 \fBgit-blame\fR(1))
699 \fI%ae\fR
700 .RS 4
701 author email
704 \fI%aE\fR
705 .RS 4
706 author email (respecting \&.mailmap, see
707 \fBgit-shortlog\fR(1)
709 \fBgit-blame\fR(1))
712 \fI%al\fR
713 .RS 4
714 author email local\-part (the part before the
715 \fI@\fR
716 sign)
719 \fI%aL\fR
720 .RS 4
721 author local\-part (see
722 \fI%al\fR) respecting \&.mailmap, see
723 \fBgit-shortlog\fR(1)
725 \fBgit-blame\fR(1))
728 \fI%ad\fR
729 .RS 4
730 author date (format respects \-\-date= option)
733 \fI%aD\fR
734 .RS 4
735 author date, RFC2822 style
738 \fI%ar\fR
739 .RS 4
740 author date, relative
743 \fI%at\fR
744 .RS 4
745 author date, UNIX timestamp
748 \fI%ai\fR
749 .RS 4
750 author date, ISO 8601\-like format
753 \fI%aI\fR
754 .RS 4
755 author date, strict ISO 8601 format
758 \fI%as\fR
759 .RS 4
760 author date, short format (\fBYYYY\-MM\-DD\fR)
763 \fI%ah\fR
764 .RS 4
765 author date, human style (like the
766 \fB\-\-date=human\fR
767 option of
768 \fBgit-rev-list\fR(1))
771 \fI%cn\fR
772 .RS 4
773 committer name
776 \fI%cN\fR
777 .RS 4
778 committer name (respecting \&.mailmap, see
779 \fBgit-shortlog\fR(1)
781 \fBgit-blame\fR(1))
784 \fI%ce\fR
785 .RS 4
786 committer email
789 \fI%cE\fR
790 .RS 4
791 committer email (respecting \&.mailmap, see
792 \fBgit-shortlog\fR(1)
794 \fBgit-blame\fR(1))
797 \fI%cl\fR
798 .RS 4
799 committer email local\-part (the part before the
800 \fI@\fR
801 sign)
804 \fI%cL\fR
805 .RS 4
806 committer local\-part (see
807 \fI%cl\fR) respecting \&.mailmap, see
808 \fBgit-shortlog\fR(1)
810 \fBgit-blame\fR(1))
813 \fI%cd\fR
814 .RS 4
815 committer date (format respects \-\-date= option)
818 \fI%cD\fR
819 .RS 4
820 committer date, RFC2822 style
823 \fI%cr\fR
824 .RS 4
825 committer date, relative
828 \fI%ct\fR
829 .RS 4
830 committer date, UNIX timestamp
833 \fI%ci\fR
834 .RS 4
835 committer date, ISO 8601\-like format
838 \fI%cI\fR
839 .RS 4
840 committer date, strict ISO 8601 format
843 \fI%cs\fR
844 .RS 4
845 committer date, short format (\fBYYYY\-MM\-DD\fR)
848 \fI%ch\fR
849 .RS 4
850 committer date, human style (like the
851 \fB\-\-date=human\fR
852 option of
853 \fBgit-rev-list\fR(1))
856 \fI%d\fR
857 .RS 4
858 ref names, like the \-\-decorate option of
859 \fBgit-log\fR(1)
862 \fI%D\fR
863 .RS 4
864 ref names without the " (", ")" wrapping\&.
867 \fI%(describe[:options])\fR
868 .RS 4
869 human\-readable name, like
870 \fBgit-describe\fR(1); empty string for undescribable commits\&. The
871 \fBdescribe\fR
872 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\&.
874 .RS 4
875 .ie n \{\
876 \h'-04'\(bu\h'+03'\c
878 .el \{\
879 .sp -1
880 .IP \(bu 2.3
882 \fItags[=<bool\-value>]\fR: Instead of only considering annotated tags, consider lightweight tags as well\&.
885 .RS 4
886 .ie n \{\
887 \h'-04'\(bu\h'+03'\c
889 .el \{\
890 .sp -1
891 .IP \(bu 2.3
893 \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\&.
896 .RS 4
897 .ie n \{\
898 \h'-04'\(bu\h'+03'\c
900 .el \{\
901 .sp -1
902 .IP \(bu 2.3
904 \fImatch=<pattern>\fR: Only consider tags matching the given
905 \fBglob(7)\fR
906 pattern, excluding the "refs/tags/" prefix\&.
909 .RS 4
910 .ie n \{\
911 \h'-04'\(bu\h'+03'\c
913 .el \{\
914 .sp -1
915 .IP \(bu 2.3
917 \fIexclude=<pattern>\fR: Do not consider tags matching the given
918 \fBglob(7)\fR
919 pattern, excluding the "refs/tags/" prefix\&.
923 \fI%S\fR
924 .RS 4
925 ref name given on the command line by which the commit was reached (like
926 \fBgit log \-\-source\fR), only works with
927 \fBgit log\fR
930 \fI%e\fR
931 .RS 4
932 encoding
935 \fI%s\fR
936 .RS 4
937 subject
940 \fI%f\fR
941 .RS 4
942 sanitized subject line, suitable for a filename
945 \fI%b\fR
946 .RS 4
947 body
950 \fI%B\fR
951 .RS 4
952 raw body (unwrapped subject and body)
955 \fI%N\fR
956 .RS 4
957 commit notes
960 \fI%GG\fR
961 .RS 4
962 raw verification message from GPG for a signed commit
965 \fI%G?\fR
966 .RS 4
967 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
970 \fI%GS\fR
971 .RS 4
972 show the name of the signer for a signed commit
975 \fI%GK\fR
976 .RS 4
977 show the key used to sign a signed commit
980 \fI%GF\fR
981 .RS 4
982 show the fingerprint of the key used to sign a signed commit
985 \fI%GP\fR
986 .RS 4
987 show the fingerprint of the primary key whose subkey was used to sign a signed commit
990 \fI%GT\fR
991 .RS 4
992 show the trust level for the key used to sign a signed commit
995 \fI%gD\fR
996 .RS 4
997 reflog selector, e\&.g\&.,
998 \fBrefs/stash@{1}\fR
1000 \fBrefs/stash@{2 minutes ago}\fR; the format follows the rules described for the
1001 \fB\-g\fR
1002 option\&. The portion before the
1003 \fB@\fR
1004 is the refname as given on the command line (so
1005 \fBgit log \-g refs/heads/master\fR
1006 would yield
1007 \fBrefs/heads/master@{0}\fR)\&.
1010 \fI%gd\fR
1011 .RS 4
1012 shortened reflog selector; same as
1013 \fB%gD\fR, but the refname portion is shortened for human readability (so
1014 \fBrefs/heads/master\fR
1015 becomes just
1016 \fBmaster\fR)\&.
1019 \fI%gn\fR
1020 .RS 4
1021 reflog identity name
1024 \fI%gN\fR
1025 .RS 4
1026 reflog identity name (respecting \&.mailmap, see
1027 \fBgit-shortlog\fR(1)
1029 \fBgit-blame\fR(1))
1032 \fI%ge\fR
1033 .RS 4
1034 reflog identity email
1037 \fI%gE\fR
1038 .RS 4
1039 reflog identity email (respecting \&.mailmap, see
1040 \fBgit-shortlog\fR(1)
1042 \fBgit-blame\fR(1))
1045 \fI%gs\fR
1046 .RS 4
1047 reflog subject
1050 \fI%(trailers[:options])\fR
1051 .RS 4
1052 display the trailers of the body as interpreted by
1053 \fBgit-interpret-trailers\fR(1)\&. The
1054 \fBtrailers\fR
1055 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\&.
1057 .RS 4
1058 .ie n \{\
1059 \h'-04'\(bu\h'+03'\c
1061 .el \{\
1062 .sp -1
1063 .IP \(bu 2.3
1065 \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
1066 \fBonly\fR
1067 option so that non\-trailer lines in the trailer block are hidden\&. If that is not desired it can be disabled with
1068 \fBonly=false\fR\&. E\&.g\&.,
1069 \fB%(trailers:key=Reviewed\-by)\fR
1070 shows trailer lines with key
1071 \fBReviewed\-by\fR\&.
1074 .RS 4
1075 .ie n \{\
1076 \h'-04'\(bu\h'+03'\c
1078 .el \{\
1079 .sp -1
1080 .IP \(bu 2.3
1082 \fIonly[=<bool>]\fR: select whether non\-trailer lines from the trailer block should be included\&.
1085 .RS 4
1086 .ie n \{\
1087 \h'-04'\(bu\h'+03'\c
1089 .el \{\
1090 .sp -1
1091 .IP \(bu 2.3
1093 \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
1094 \fB%x2C\fR
1095 as it would otherwise be parsed as next option\&. E\&.g\&.,
1096 \fB%(trailers:key=Ticket,separator=%x2C )\fR
1097 shows all trailer lines whose key is "Ticket" separated by a comma and a space\&.
1100 .RS 4
1101 .ie n \{\
1102 \h'-04'\(bu\h'+03'\c
1104 .el \{\
1105 .sp -1
1106 .IP \(bu 2.3
1108 \fIunfold[=<bool>]\fR: make it behave as if interpret\-trailer\(cqs
1109 \fB\-\-unfold\fR
1110 option was given\&. E\&.g\&.,
1111 \fB%(trailers:only,unfold=true)\fR
1112 unfolds and shows all trailer lines\&.
1115 .RS 4
1116 .ie n \{\
1117 \h'-04'\(bu\h'+03'\c
1119 .el \{\
1120 .sp -1
1121 .IP \(bu 2.3
1123 \fIkeyonly[=<bool>]\fR: only show the key part of the trailer\&.
1126 .RS 4
1127 .ie n \{\
1128 \h'-04'\(bu\h'+03'\c
1130 .el \{\
1131 .sp -1
1132 .IP \(bu 2.3
1134 \fIvalueonly[=<bool>]\fR: only show the value part of the trailer\&.
1137 .RS 4
1138 .ie n \{\
1139 \h'-04'\(bu\h'+03'\c
1141 .el \{\
1142 .sp -1
1143 .IP \(bu 2.3
1145 \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
1146 \fIseparator=<sep>\fR
1147 above\&.
1152 .if n \{\
1155 .RS 4
1156 .it 1 an-trap
1157 .nr an-no-space-flag 1
1158 .nr an-break-flag 1
1160 .ps +1
1161 \fBNote\fR
1162 .ps -1
1165 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\&.
1166 .sp .5v
1169 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\&.
1171 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\&.
1173 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\&.
1175 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\&.
1177 .RS 4
1178 .ie n \{\
1179 \h'-04'\(bu\h'+03'\c
1181 .el \{\
1182 .sp -1
1183 .IP \(bu 2.3
1185 \fItformat:\fR
1188 \fItformat:\fR
1189 format works exactly like
1190 \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:
1192 .if n \{\
1193 .RS 4
1196 $ git log \-2 \-\-pretty=format:%h 4da45bef \e
1197   | perl \-pe \*(Aq$_ \&.= " \-\- NO NEWLINE\en" unless /\en/\*(Aq
1198 4da45be
1199 7134973 \-\- NO NEWLINE
1201 $ git log \-2 \-\-pretty=tformat:%h 4da45bef \e
1202   | perl \-pe \*(Aq$_ \&.= " \-\- NO NEWLINE\en" unless /\en/\*(Aq
1203 4da45be
1204 7134973
1206 .if n \{\
1210 In addition, any unrecognized string that has a
1211 \fB%\fR
1212 in it is interpreted as if it has
1213 \fBtformat:\fR
1214 in front of it\&. For example, these two are equivalent:
1216 .if n \{\
1217 .RS 4
1220 $ git log \-2 \-\-pretty=tformat:%h 4da45bef
1221 $ git log \-2 \-\-pretty=%h 4da45bef
1223 .if n \{\
1228 .SH "DIFF FORMATTING"
1230 The options below can be used to change the way \fBgit show\fR generates diff output\&.
1232 \-p, \-u, \-\-patch
1233 .RS 4
1234 Generate patch (see section titled
1235 "Generating patch text with \-p")\&.
1238 \-s, \-\-no\-patch
1239 .RS 4
1240 Suppress all output from the diff machinery\&. Useful for commands like
1241 \fBgit show\fR
1242 that show the patch by default to squelch their output, or to cancel the effect of options like
1243 \fB\-\-patch\fR,
1244 \fB\-\-stat\fR
1245 earlier on the command line in an alias\&.
1248 \-\-diff\-merges=(off|none|on|first\-parent|1|separate|m|combined|c|dense\-combined|cc|remerge|r), \-\-no\-diff\-merges
1249 .RS 4
1250 Specify diff format to be used for merge commits\&. Default is
1251 \fBdense\-combined\fR
1252 unless
1253 \fB\-\-first\-parent\fR
1254 is in use, in which case
1255 \fBfirst\-parent\fR
1256 is the default\&.
1258 \-\-diff\-merges=(off|none), \-\-no\-diff\-merges
1259 .RS 4
1260 Disable output of diffs for merge commits\&. Useful to override implied value\&.
1263 \-\-diff\-merges=on, \-\-diff\-merges=m, \-m
1264 .RS 4
1265 This option makes diff output for merge commits to be shown in the default format\&.
1266 \fB\-m\fR
1267 will produce the output only if
1268 \fB\-p\fR
1269 is given as well\&. The default format could be changed using
1270 \fBlog\&.diffMerges\fR
1271 configuration parameter, which default value is
1272 \fBseparate\fR\&.
1275 \-\-diff\-merges=first\-parent, \-\-diff\-merges=1
1276 .RS 4
1277 This option makes merge commits show the full diff with respect to the first parent only\&.
1280 \-\-diff\-merges=separate
1281 .RS 4
1282 This makes merge commits show the full diff with respect to each of the parents\&. Separate log entry and diff is generated for each parent\&.
1285 \-\-diff\-merges=remerge, \-\-diff\-merges=r, \-\-remerge\-diff
1286 .RS 4
1287 With this option, two\-parent merge commits are remerged to create a temporary tree object \(em potentially containing files with conflict markers and such\&. A diff is then shown between that temporary tree and the actual merge commit\&.
1289 The output emitted when this option is used is subject to change, and so is its interaction with other options (unless explicitly documented)\&.
1292 \-\-diff\-merges=combined, \-\-diff\-merges=c, \-c
1293 .RS 4
1294 With this option, diff output for a merge commit 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\&. Furthermore, it lists only files which were modified from all parents\&.
1295 \fB\-c\fR
1296 implies
1297 \fB\-p\fR\&.
1300 \-\-diff\-merges=dense\-combined, \-\-diff\-merges=cc, \-\-cc
1301 .RS 4
1302 With this option the output produced by
1303 \fB\-\-diff\-merges=combined\fR
1304 is further compressed by omitting uninteresting hunks whose contents in the parents have only two variants and the merge result picks one of them without modification\&.
1305 \fB\-\-cc\fR
1306 implies
1307 \fB\-p\fR\&.
1311 \-\-combined\-all\-paths
1312 .RS 4
1313 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
1314 \fB\-\-diff\-merges=[dense\-]combined\fR
1315 is in use, and is likely only useful if filename changes are detected (i\&.e\&. when either rename or copy detection have been requested)\&.
1318 \-U<n>, \-\-unified=<n>
1319 .RS 4
1320 Generate diffs with <n> lines of context instead of the usual three\&. Implies
1321 \fB\-\-patch\fR\&.
1324 \-\-output=<file>
1325 .RS 4
1326 Output to a specific file instead of stdout\&.
1329 \-\-output\-indicator\-new=<char>, \-\-output\-indicator\-old=<char>, \-\-output\-indicator\-context=<char>
1330 .RS 4
1331 Specify the character used to indicate new, old or context lines in the generated patch\&. Normally they are
1332 \fI+\fR,
1333 \fI\-\fR
1334 and \*(Aq \*(Aq respectively\&.
1337 \-\-raw
1338 .RS 4
1339 For each commit, show a summary of changes using the raw diff format\&. See the "RAW OUTPUT FORMAT" section of
1340 \fBgit-diff\fR(1)\&. This is different from showing the log itself in raw format, which you can achieve with
1341 \fB\-\-format=raw\fR\&.
1344 \-\-patch\-with\-raw
1345 .RS 4
1346 Synonym for
1347 \fB\-p \-\-raw\fR\&.
1351 .RS 4
1352 Show the tree objects in the diff output\&.
1355 \-\-indent\-heuristic
1356 .RS 4
1357 Enable the heuristic that shifts diff hunk boundaries to make patches easier to read\&. This is the default\&.
1360 \-\-no\-indent\-heuristic
1361 .RS 4
1362 Disable the indent heuristic\&.
1365 \-\-minimal
1366 .RS 4
1367 Spend extra time to make sure the smallest possible diff is produced\&.
1370 \-\-patience
1371 .RS 4
1372 Generate a diff using the "patience diff" algorithm\&.
1375 \-\-histogram
1376 .RS 4
1377 Generate a diff using the "histogram diff" algorithm\&.
1380 \-\-anchored=<text>
1381 .RS 4
1382 Generate a diff using the "anchored diff" algorithm\&.
1384 This option may be specified more than once\&.
1386 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\&.
1389 \-\-diff\-algorithm={patience|minimal|histogram|myers}
1390 .RS 4
1391 Choose a diff algorithm\&. The variants are as follows:
1393 \fBdefault\fR, \fBmyers\fR
1394 .RS 4
1395 The basic greedy diff algorithm\&. Currently, this is the default\&.
1398 \fBminimal\fR
1399 .RS 4
1400 Spend extra time to make sure the smallest possible diff is produced\&.
1403 \fBpatience\fR
1404 .RS 4
1405 Use "patience diff" algorithm when generating patches\&.
1408 \fBhistogram\fR
1409 .RS 4
1410 This algorithm extends the patience algorithm to "support low\-occurrence common elements"\&.
1413 For instance, if you configured the
1414 \fBdiff\&.algorithm\fR
1415 variable to a non\-default value and want to use the default one, then you have to use
1416 \fB\-\-diff\-algorithm=default\fR
1417 option\&.
1420 \-\-stat[=<width>[,<name\-width>[,<count>]]]
1421 .RS 4
1422 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
1423 \fB<width>\fR\&. The width of the filename part can be limited by giving another width
1424 \fB<name\-width>\fR
1425 after a comma\&. The width of the graph part can be limited by using
1426 \fB\-\-stat\-graph\-width=<width>\fR
1427 (affects all commands generating a stat graph) or by setting
1428 \fBdiff\&.statGraphWidth=<width>\fR
1429 (does not affect
1430 \fBgit format\-patch\fR)\&. By giving a third parameter
1431 \fB<count>\fR, you can limit the output to the first
1432 \fB<count>\fR
1433 lines, followed by
1434 \fB\&.\&.\&.\fR
1435 if there are more\&.
1437 These parameters can also be set individually with
1438 \fB\-\-stat\-width=<width>\fR,
1439 \fB\-\-stat\-name\-width=<name\-width>\fR
1441 \fB\-\-stat\-count=<count>\fR\&.
1444 \-\-compact\-summary
1445 .RS 4
1446 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
1447 \fB\-\-stat\fR\&.
1450 \-\-numstat
1451 .RS 4
1452 Similar to
1453 \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
1454 \fB\-\fR
1455 instead of saying
1456 \fB0 0\fR\&.
1459 \-\-shortstat
1460 .RS 4
1461 Output only the last line of the
1462 \fB\-\-stat\fR
1463 format containing total number of modified files, as well as number of added and deleted lines\&.
1466 \-X[<param1,param2,\&...>], \-\-dirstat[=<param1,param2,\&...>]
1467 .RS 4
1468 Output the distribution of relative amount of changes for each sub\-directory\&. The behavior of
1469 \fB\-\-dirstat\fR
1470 can be customized by passing it a comma separated list of parameters\&. The defaults are controlled by the
1471 \fBdiff\&.dirstat\fR
1472 configuration variable (see
1473 \fBgit-config\fR(1))\&. The following parameters are available:
1475 \fBchanges\fR
1476 .RS 4
1477 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\&.
1480 \fBlines\fR
1481 .RS 4
1482 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
1483 \fB\-\-dirstat\fR
1484 behavior than the
1485 \fBchanges\fR
1486 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
1487 \fB\-\-*stat\fR
1488 options\&.
1491 \fBfiles\fR
1492 .RS 4
1493 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
1494 \fB\-\-dirstat\fR
1495 behavior, since it does not have to look at the file contents at all\&.
1498 \fBcumulative\fR
1499 .RS 4
1500 Count changes in a child directory for the parent directory as well\&. Note that when using
1501 \fBcumulative\fR, the sum of the percentages reported may exceed 100%\&. The default (non\-cumulative) behavior can be specified with the
1502 \fBnoncumulative\fR
1503 parameter\&.
1506 <limit>
1507 .RS 4
1508 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\&.
1511 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:
1512 \fB\-\-dirstat=files,10,cumulative\fR\&.
1515 \-\-cumulative
1516 .RS 4
1517 Synonym for \-\-dirstat=cumulative
1520 \-\-dirstat\-by\-file[=<param1,param2>\&...]
1521 .RS 4
1522 Synonym for \-\-dirstat=files,param1,param2\&...
1525 \-\-summary
1526 .RS 4
1527 Output a condensed summary of extended header information such as creations, renames and mode changes\&.
1530 \-\-patch\-with\-stat
1531 .RS 4
1532 Synonym for
1533 \fB\-p \-\-stat\fR\&.
1537 .RS 4
1538 Separate the commits with NULs instead of with new newlines\&.
1540 Also, when
1541 \fB\-\-raw\fR
1543 \fB\-\-numstat\fR
1544 has been given, do not munge pathnames and use NULs as output field terminators\&.
1546 Without this option, pathnames with "unusual" characters are quoted as explained for the configuration variable
1547 \fBcore\&.quotePath\fR
1548 (see
1549 \fBgit-config\fR(1))\&.
1552 \-\-name\-only
1553 .RS 4
1554 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
1555 \fBgit-log\fR(1)
1556 manual page\&.
1559 \-\-name\-status
1560 .RS 4
1561 Show only names and status of changed files\&. See the description of the
1562 \fB\-\-diff\-filter\fR
1563 option on what the status letters mean\&. Just like
1564 \fB\-\-name\-only\fR
1565 the file names are often encoded in UTF\-8\&.
1568 \-\-submodule[=<format>]
1569 .RS 4
1570 Specify how differences in submodules are shown\&. When specifying
1571 \fB\-\-submodule=short\fR
1573 \fIshort\fR
1574 format is used\&. This format just shows the names of the commits at the beginning and end of the range\&. When
1575 \fB\-\-submodule\fR
1577 \fB\-\-submodule=log\fR
1578 is specified, the
1579 \fIlog\fR
1580 format is used\&. This format lists the commits in the range like
1581 \fBgit-submodule\fR(1)
1582 \fBsummary\fR
1583 does\&. When
1584 \fB\-\-submodule=diff\fR
1585 is specified, the
1586 \fIdiff\fR
1587 format is used\&. This format shows an inline diff of the changes in the submodule contents between the commit range\&. Defaults to
1588 \fBdiff\&.submodule\fR
1589 or the
1590 \fIshort\fR
1591 format if the config option is unset\&.
1594 \-\-color[=<when>]
1595 .RS 4
1596 Show colored diff\&.
1597 \fB\-\-color\fR
1598 (i\&.e\&. without
1599 \fI=<when>\fR) is the same as
1600 \fB\-\-color=always\fR\&.
1601 \fI<when>\fR
1602 can be one of
1603 \fBalways\fR,
1604 \fBnever\fR, or
1605 \fBauto\fR\&.
1608 \-\-no\-color
1609 .RS 4
1610 Turn off colored diff\&. It is the same as
1611 \fB\-\-color=never\fR\&.
1614 \-\-color\-moved[=<mode>]
1615 .RS 4
1616 Moved lines of code are colored differently\&. The <mode> defaults to
1617 \fIno\fR
1618 if the option is not given and to
1619 \fIzebra\fR
1620 if the option with no mode is given\&. The mode must be one of:
1623 .RS 4
1624 Moved lines are not highlighted\&.
1627 default
1628 .RS 4
1629 Is a synonym for
1630 \fBzebra\fR\&. This may change to a more sensible mode in the future\&.
1633 plain
1634 .RS 4
1635 Any line that is added in one location and was removed in another location will be colored with
1636 \fIcolor\&.diff\&.newMoved\fR\&. Similarly
1637 \fIcolor\&.diff\&.oldMoved\fR
1638 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\&.
1641 blocks
1642 .RS 4
1643 Blocks of moved text of at least 20 alphanumeric characters are detected greedily\&. The detected blocks are painted using either the
1644 \fIcolor\&.diff\&.{old,new}Moved\fR
1645 color\&. Adjacent blocks cannot be told apart\&.
1648 zebra
1649 .RS 4
1650 Blocks of moved text are detected as in
1651 \fIblocks\fR
1652 mode\&. The blocks are painted using either the
1653 \fIcolor\&.diff\&.{old,new}Moved\fR
1654 color or
1655 \fIcolor\&.diff\&.{old,new}MovedAlternative\fR\&. The change between the two colors indicates that a new block was detected\&.
1658 dimmed\-zebra
1659 .RS 4
1660 Similar to
1661 \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\&.
1662 \fBdimmed_zebra\fR
1663 is a deprecated synonym\&.
1667 \-\-no\-color\-moved
1668 .RS 4
1669 Turn off move detection\&. This can be used to override configuration settings\&. It is the same as
1670 \fB\-\-color\-moved=no\fR\&.
1673 \-\-color\-moved\-ws=<modes>
1674 .RS 4
1675 This configures how whitespace is ignored when performing the move detection for
1676 \fB\-\-color\-moved\fR\&. These modes can be given as a comma separated list:
1679 .RS 4
1680 Do not ignore whitespace when performing move detection\&.
1683 ignore\-space\-at\-eol
1684 .RS 4
1685 Ignore changes in whitespace at EOL\&.
1688 ignore\-space\-change
1689 .RS 4
1690 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\&.
1693 ignore\-all\-space
1694 .RS 4
1695 Ignore whitespace when comparing lines\&. This ignores differences even if one line has whitespace where the other line has none\&.
1698 allow\-indentation\-change
1699 .RS 4
1700 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\&.
1704 \-\-no\-color\-moved\-ws
1705 .RS 4
1706 Do not ignore whitespace when performing move detection\&. This can be used to override configuration settings\&. It is the same as
1707 \fB\-\-color\-moved\-ws=no\fR\&.
1710 \-\-word\-diff[=<mode>]
1711 .RS 4
1712 Show a word diff, using the <mode> to delimit changed words\&. By default, words are delimited by whitespace; see
1713 \fB\-\-word\-diff\-regex\fR
1714 below\&. The <mode> defaults to
1715 \fIplain\fR, and must be one of:
1717 color
1718 .RS 4
1719 Highlight changed words using only colors\&. Implies
1720 \fB\-\-color\fR\&.
1723 plain
1724 .RS 4
1725 Show words as
1726 \fB[\-removed\-]\fR
1728 \fB{+added+}\fR\&. Makes no attempts to escape the delimiters if they appear in the input, so the output may be ambiguous\&.
1731 porcelain
1732 .RS 4
1733 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
1734 \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
1735 \fB~\fR
1736 on a line of its own\&.
1739 none
1740 .RS 4
1741 Disable word diff again\&.
1744 Note that despite the name of the first mode, color is used to highlight the changed parts in all modes if enabled\&.
1747 \-\-word\-diff\-regex=<regex>
1748 .RS 4
1749 Use <regex> to decide what a word is, instead of considering runs of non\-whitespace to be a word\&. Also implies
1750 \fB\-\-word\-diff\fR
1751 unless it was already enabled\&.
1753 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
1754 \fB|[^[:space:]]\fR
1755 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\&.
1757 For example,
1758 \fB\-\-word\-diff\-regex=\&.\fR
1759 will treat each character as a word and, correspondingly, show differences character by character\&.
1761 The regex can also be set via a diff driver or configuration option, see
1762 \fBgitattributes\fR(5)
1764 \fBgit-config\fR(1)\&. Giving it explicitly overrides any diff driver or configuration setting\&. Diff drivers override configuration settings\&.
1767 \-\-color\-words[=<regex>]
1768 .RS 4
1769 Equivalent to
1770 \fB\-\-word\-diff=color\fR
1771 plus (if a regex was specified)
1772 \fB\-\-word\-diff\-regex=<regex>\fR\&.
1775 \-\-no\-renames
1776 .RS 4
1777 Turn off rename detection, even when the configuration file gives the default to do so\&.
1780 \-\-[no\-]rename\-empty
1781 .RS 4
1782 Whether to use empty blobs as rename source\&.
1785 \-\-check
1786 .RS 4
1787 Warn if changes introduce conflict markers or whitespace errors\&. What are considered whitespace errors is controlled by
1788 \fBcore\&.whitespace\fR
1789 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\&.
1792 \-\-ws\-error\-highlight=<kind>
1793 .RS 4
1794 Highlight whitespace errors in the
1795 \fBcontext\fR,
1796 \fBold\fR
1798 \fBnew\fR
1799 lines of the diff\&. Multiple values are separated by comma,
1800 \fBnone\fR
1801 resets previous values,
1802 \fBdefault\fR
1803 reset the list to
1804 \fBnew\fR
1806 \fBall\fR
1807 is a shorthand for
1808 \fBold,new,context\fR\&. When this option is not given, and the configuration variable
1809 \fBdiff\&.wsErrorHighlight\fR
1810 is not set, only whitespace errors in
1811 \fBnew\fR
1812 lines are highlighted\&. The whitespace errors are colored with
1813 \fBcolor\&.diff\&.whitespace\fR\&.
1816 \-\-full\-index
1817 .RS 4
1818 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\&.
1821 \-\-binary
1822 .RS 4
1823 In addition to
1824 \fB\-\-full\-index\fR, output a binary diff that can be applied with
1825 \fBgit\-apply\fR\&. Implies
1826 \fB\-\-patch\fR\&.
1829 \-\-abbrev[=<n>]
1830 .RS 4
1831 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
1832 \fI<n>\fR
1833 hexdigits long that uniquely refers the object\&. In diff\-patch output format,
1834 \fB\-\-full\-index\fR
1835 takes higher precedence, i\&.e\&. if
1836 \fB\-\-full\-index\fR
1837 is specified, full blob names will be shown regardless of
1838 \fB\-\-abbrev\fR\&. Non default number of digits can be specified with
1839 \fB\-\-abbrev=<n>\fR\&.
1842 \-B[<n>][/<m>], \-\-break\-rewrites[=[<n>][/<m>]]
1843 .RS 4
1844 Break complete rewrite changes into pairs of delete and create\&. This serves two purposes:
1846 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
1847 \fBm\fR
1848 controls this aspect of the \-B option (defaults to 60%)\&.
1849 \fB\-B/70%\fR
1850 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)\&.
1852 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
1853 \fBn\fR
1854 controls this aspect of the \-B option (defaults to 50%)\&.
1855 \fB\-B20%\fR
1856 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\&.
1859 \-M[<n>], \-\-find\-renames[=<n>]
1860 .RS 4
1861 If generating diffs, detect and report renames for each commit\&. For following files across renames while traversing history, see
1862 \fB\-\-follow\fR\&. If
1863 \fBn\fR
1864 is specified, it is a threshold on the similarity index (i\&.e\&. amount of addition/deletions compared to the file\(cqs size)\&. For example,
1865 \fB\-M90%\fR
1866 means Git should consider a delete/add pair to be a rename if more than 90% of the file hasn\(cqt changed\&. Without a
1867 \fB%\fR
1868 sign, the number is to be read as a fraction, with a decimal point before it\&. I\&.e\&.,
1869 \fB\-M5\fR
1870 becomes 0\&.5, and is thus the same as
1871 \fB\-M50%\fR\&. Similarly,
1872 \fB\-M05\fR
1873 is the same as
1874 \fB\-M5%\fR\&. To limit detection to exact renames, use
1875 \fB\-M100%\fR\&. The default similarity index is 50%\&.
1878 \-C[<n>], \-\-find\-copies[=<n>]
1879 .RS 4
1880 Detect copies as well as renames\&. See also
1881 \fB\-\-find\-copies\-harder\fR\&. If
1882 \fBn\fR
1883 is specified, it has the same meaning as for
1884 \fB\-M<n>\fR\&.
1887 \-\-find\-copies\-harder
1888 .RS 4
1889 For performance reasons, by default,
1890 \fB\-C\fR
1891 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
1892 \fB\-C\fR
1893 option has the same effect\&.
1896 \-D, \-\-irreversible\-delete
1897 .RS 4
1898 Omit the preimage for deletes, i\&.e\&. print only the header but not the diff between the preimage and
1899 \fB/dev/null\fR\&. The resulting patch is not meant to be applied with
1900 \fBpatch\fR
1902 \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\&.
1904 When used together with
1905 \fB\-B\fR, omit also the preimage in the deletion part of a delete/create pair\&.
1908 \-l<num>
1909 .RS 4
1911 \fB\-M\fR
1913 \fB\-C\fR
1914 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\&.
1917 \-\-diff\-filter=[(A|C|D|M|R|T|U|X|B)\&...[*]]
1918 .RS 4
1919 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
1920 \fB*\fR
1921 (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\&.
1923 Also, these upper\-case letters can be downcased to exclude\&. E\&.g\&.
1924 \fB\-\-diff\-filter=ad\fR
1925 excludes added and deleted paths\&.
1927 Note that not all diffs can feature all types\&. For instance, copied and renamed entries cannot appear if detection for those types is disabled\&.
1930 \-S<string>
1931 .RS 4
1932 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\&.
1934 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
1935 \fB\-S\fR, and keep going until you get the very first version of the block\&.
1937 Binary files are searched as well\&.
1940 \-G<regex>
1941 .RS 4
1942 Look for differences whose patch text contains added/removed lines that match <regex>\&.
1944 To illustrate the difference between
1945 \fB\-S<regex> \-\-pickaxe\-regex\fR
1947 \fB\-G<regex>\fR, consider a commit with the following diff in the same file:
1949 .if n \{\
1950 .RS 4
1953 +    return frotz(nitfol, two\->ptr, 1, 0);
1954 \&.\&.\&.
1955 \-    hit = frotz(nitfol, mf2\&.ptr, 1, 0);
1957 .if n \{\
1961 While
1962 \fBgit log \-G"frotz\e(nitfol"\fR
1963 will show this commit,
1964 \fBgit log \-S"frotz\e(nitfol" \-\-pickaxe\-regex\fR
1965 will not (because the number of occurrences of that string did not change)\&.
1967 Unless
1968 \fB\-\-text\fR
1969 is supplied patches of binary files without a textconv filter will be ignored\&.
1971 See the
1972 \fIpickaxe\fR
1973 entry in
1974 \fBgitdiffcore\fR(7)
1975 for more information\&.
1978 \-\-find\-object=<object\-id>
1979 .RS 4
1980 Look for differences that change the number of occurrences of the specified object\&. Similar to
1981 \fB\-S\fR, just the argument is different in that it doesn\(cqt search for a specific string but for a specific object id\&.
1983 The object can be a blob or a submodule commit\&. It implies the
1984 \fB\-t\fR
1985 option in
1986 \fBgit\-log\fR
1987 to also find trees\&.
1990 \-\-pickaxe\-all
1991 .RS 4
1992 When
1993 \fB\-S\fR
1995 \fB\-G\fR
1996 finds a change, show all the changes in that changeset, not just the files that contain the change in <string>\&.
1999 \-\-pickaxe\-regex
2000 .RS 4
2001 Treat the <string> given to
2002 \fB\-S\fR
2003 as an extended POSIX regular expression to match\&.
2006 \-O<orderfile>
2007 .RS 4
2008 Control the order in which files appear in the output\&. This overrides the
2009 \fBdiff\&.orderFile\fR
2010 configuration variable (see
2011 \fBgit-config\fR(1))\&. To cancel
2012 \fBdiff\&.orderFile\fR, use
2013 \fB\-O/dev/null\fR\&.
2015 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\&.
2017 <orderfile> is parsed as follows:
2019 .RS 4
2020 .ie n \{\
2021 \h'-04'\(bu\h'+03'\c
2023 .el \{\
2024 .sp -1
2025 .IP \(bu 2.3
2027 Blank lines are ignored, so they can be used as separators for readability\&.
2030 .RS 4
2031 .ie n \{\
2032 \h'-04'\(bu\h'+03'\c
2034 .el \{\
2035 .sp -1
2036 .IP \(bu 2.3
2038 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\&.
2041 .RS 4
2042 .ie n \{\
2043 \h'-04'\(bu\h'+03'\c
2045 .el \{\
2046 .sp -1
2047 .IP \(bu 2.3
2049 Each other line contains a single pattern\&.
2052 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"\&.
2055 \-\-skip\-to=<file>, \-\-rotate\-to=<file>
2056 .RS 4
2057 Discard the files before the named <file> from the output (i\&.e\&.
2058 \fIskip to\fR), or move them to the end of the output (i\&.e\&.
2059 \fIrotate to\fR)\&. These were invented primarily for use of the
2060 \fBgit difftool\fR
2061 command, and may not be very useful otherwise\&.
2065 .RS 4
2066 Swap two inputs; that is, show differences from index or on\-disk file to tree contents\&.
2069 \-\-relative[=<path>], \-\-no\-relative
2070 .RS 4
2071 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\&.
2072 \fB\-\-no\-relative\fR
2073 can be used to countermand both
2074 \fBdiff\&.relative\fR
2075 config option and previous
2076 \fB\-\-relative\fR\&.
2079 \-a, \-\-text
2080 .RS 4
2081 Treat all files as text\&.
2084 \-\-ignore\-cr\-at\-eol
2085 .RS 4
2086 Ignore carriage\-return at the end of line when doing a comparison\&.
2089 \-\-ignore\-space\-at\-eol
2090 .RS 4
2091 Ignore changes in whitespace at EOL\&.
2094 \-b, \-\-ignore\-space\-change
2095 .RS 4
2096 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\&.
2099 \-w, \-\-ignore\-all\-space
2100 .RS 4
2101 Ignore whitespace when comparing lines\&. This ignores differences even if one line has whitespace where the other line has none\&.
2104 \-\-ignore\-blank\-lines
2105 .RS 4
2106 Ignore changes whose lines are all blank\&.
2109 \-I<regex>, \-\-ignore\-matching\-lines=<regex>
2110 .RS 4
2111 Ignore changes whose all lines match <regex>\&. This option may be specified more than once\&.
2114 \-\-inter\-hunk\-context=<lines>
2115 .RS 4
2116 Show the context between diff hunks, up to the specified number of lines, thereby fusing hunks that are close to each other\&. Defaults to
2117 \fBdiff\&.interHunkContext\fR
2118 or 0 if the config option is unset\&.
2121 \-W, \-\-function\-context
2122 .RS 4
2123 Show whole function as context lines for each change\&. The function names are determined in the same way as
2124 \fBgit diff\fR
2125 works out patch hunk headers (see
2126 \fIDefining a custom hunk\-header\fR
2128 \fBgitattributes\fR(5))\&.
2131 \-\-ext\-diff
2132 .RS 4
2133 Allow an external diff helper to be executed\&. If you set an external diff driver with
2134 \fBgitattributes\fR(5), you need to use this option with
2135 \fBgit-log\fR(1)
2136 and friends\&.
2139 \-\-no\-ext\-diff
2140 .RS 4
2141 Disallow external diff drivers\&.
2144 \-\-textconv, \-\-no\-textconv
2145 .RS 4
2146 Allow (or disallow) external text conversion filters to be run when comparing binary files\&. See
2147 \fBgitattributes\fR(5)
2148 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
2149 \fBgit-diff\fR(1)
2151 \fBgit-log\fR(1), but not for
2152 \fBgit-format-patch\fR(1)
2153 or diff plumbing commands\&.
2156 \-\-ignore\-submodules[=<when>]
2157 .RS 4
2158 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
2159 \fIignore\fR
2160 option in
2161 \fBgit-config\fR(1)
2163 \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\&.
2166 \-\-src\-prefix=<prefix>
2167 .RS 4
2168 Show the given source prefix instead of "a/"\&.
2171 \-\-dst\-prefix=<prefix>
2172 .RS 4
2173 Show the given destination prefix instead of "b/"\&.
2176 \-\-no\-prefix
2177 .RS 4
2178 Do not show any source or destination prefix\&.
2181 \-\-default\-prefix
2182 .RS 4
2183 Use the default source and destination prefixes ("a/" and "b/")\&. This is usually the default already, but may be used to override config such as
2184 \fBdiff\&.noprefix\fR\&.
2187 \-\-line\-prefix=<prefix>
2188 .RS 4
2189 Prepend an additional prefix to every line of output\&.
2192 \-\-ita\-invisible\-in\-index
2193 .RS 4
2194 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
2195 \fB\-\-ita\-visible\-in\-index\fR\&. Both options are experimental and could be removed in future\&.
2198 For more detailed explanation on these common options, see also \fBgitdiffcore\fR(7)\&.
2199 .SH "GENERATING PATCH TEXT WITH \-P"
2201 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))\&.
2203 What the \-p option produces is slightly different from the traditional diff format:
2205 .RS 4
2206 .ie n \{\
2207 \h'-04' 1.\h'+01'\c
2209 .el \{\
2210 .sp -1
2211 .IP "  1." 4.2
2213 It is preceded with a "git diff" header that looks like this:
2215 .if n \{\
2216 .RS 4
2219 diff \-\-git a/file1 b/file2
2221 .if n \{\
2226 \fBa/\fR
2228 \fBb/\fR
2229 filenames are the same unless rename/copy is involved\&. Especially, even for a creation or a deletion,
2230 \fB/dev/null\fR
2232 \fInot\fR
2233 used in place of the
2234 \fBa/\fR
2236 \fBb/\fR
2237 filenames\&.
2239 When rename/copy is involved,
2240 \fBfile1\fR
2242 \fBfile2\fR
2243 show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively\&.
2246 .RS 4
2247 .ie n \{\
2248 \h'-04' 2.\h'+01'\c
2250 .el \{\
2251 .sp -1
2252 .IP "  2." 4.2
2254 It is followed by one or more extended header lines:
2256 .if n \{\
2257 .RS 4
2260 old mode <mode>
2261 new mode <mode>
2262 deleted file mode <mode>
2263 new file mode <mode>
2264 copy from <path>
2265 copy to <path>
2266 rename from <path>
2267 rename to <path>
2268 similarity index <number>
2269 dissimilarity index <number>
2270 index <hash>\&.\&.<hash> <mode>
2272 .if n \{\
2276 File modes are printed as 6\-digit octal numbers including the file type and file permission bits\&.
2278 Path names in extended headers do not include the
2279 \fBa/\fR
2281 \fBb/\fR
2282 prefixes\&.
2284 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\&.
2286 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\&.
2289 .RS 4
2290 .ie n \{\
2291 \h'-04' 3.\h'+01'\c
2293 .el \{\
2294 .sp -1
2295 .IP "  3." 4.2
2297 Pathnames with "unusual" characters are quoted as explained for the configuration variable
2298 \fBcore\&.quotePath\fR
2299 (see
2300 \fBgit-config\fR(1))\&.
2303 .RS 4
2304 .ie n \{\
2305 \h'-04' 4.\h'+01'\c
2307 .el \{\
2308 .sp -1
2309 .IP "  4." 4.2
2311 All the
2312 \fBfile1\fR
2313 files in the output refer to files before the commit, and all the
2314 \fBfile2\fR
2315 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:
2317 .if n \{\
2318 .RS 4
2321 diff \-\-git a/a b/b
2322 rename from a
2323 rename to b
2324 diff \-\-git a/b b/a
2325 rename from b
2326 rename to a
2328 .if n \{\
2333 .RS 4
2334 .ie n \{\
2335 \h'-04' 5.\h'+01'\c
2337 .el \{\
2338 .sp -1
2339 .IP "  5." 4.2
2341 Hunk headers mention the name of the function to which the hunk applies\&. See "Defining a custom hunk\-header" in
2342 \fBgitattributes\fR(5)
2343 for details of how to tailor to this to specific languages\&.
2345 .SH "COMBINED DIFF FORMAT"
2347 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\&.
2349 A "combined diff" format looks like this:
2351 .if n \{\
2352 .RS 4
2355 diff \-\-combined describe\&.c
2356 index fabadb8,cc95eb0\&.\&.4866510
2357 \-\-\- a/describe\&.c
2358 +++ b/describe\&.c
2359 @@@ \-98,20 \-98,12 +98,20 @@@
2360         return (a_date > b_date) ? \-1 : (a_date == b_date) ? 0 : 1;
2361   }
2363 \- static void describe(char *arg)
2364  \-static void describe(struct commit *cmit, int last_one)
2365 ++static void describe(char *arg, int last_one)
2366   {
2367  +      unsigned char sha1[20];
2368  +      struct commit *cmit;
2369         struct commit_list *list;
2370         static int initialized = 0;
2371         struct commit_name *n;
2373  +      if (get_sha1(arg, sha1) < 0)
2374  +              usage(describe_usage);
2375  +      cmit = lookup_commit_reference(sha1);
2376  +      if (!cmit)
2377  +              usage(describe_usage);
2379         if (!initialized) {
2380                 initialized = 1;
2381                 for_each_ref(get_name);
2383 .if n \{\
2389 .RS 4
2390 .ie n \{\
2391 \h'-04' 1.\h'+01'\c
2393 .el \{\
2394 .sp -1
2395 .IP "  1." 4.2
2397 It is preceded with a "git diff" header, that looks like this (when the
2398 \fB\-c\fR
2399 option is used):
2401 .if n \{\
2402 .RS 4
2405 diff \-\-combined file
2407 .if n \{\
2411 or like this (when the
2412 \fB\-\-cc\fR
2413 option is used):
2415 .if n \{\
2416 .RS 4
2419 diff \-\-cc file
2421 .if n \{\
2426 .RS 4
2427 .ie n \{\
2428 \h'-04' 2.\h'+01'\c
2430 .el \{\
2431 .sp -1
2432 .IP "  2." 4.2
2434 It is followed by one or more extended header lines (this example shows a merge with two parents):
2436 .if n \{\
2437 .RS 4
2440 index <hash>,<hash>\&.\&.<hash>
2441 mode <mode>,<mode>\&.\&.<mode>
2442 new file mode <mode>
2443 deleted file mode <mode>,<mode>
2445 .if n \{\
2450 \fBmode <mode>,<mode>\&.\&.<mode>\fR
2451 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\&.
2454 .RS 4
2455 .ie n \{\
2456 \h'-04' 3.\h'+01'\c
2458 .el \{\
2459 .sp -1
2460 .IP "  3." 4.2
2462 It is followed by two\-line from\-file/to\-file header
2464 .if n \{\
2465 .RS 4
2468 \-\-\- a/file
2469 +++ b/file
2471 .if n \{\
2475 Similar to two\-line header for traditional
2476 \fIunified\fR
2477 diff format,
2478 \fB/dev/null\fR
2479 is used to signal created or deleted files\&.
2481 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
2483 .if n \{\
2484 .RS 4
2487 \-\-\- a/file
2488 \-\-\- a/file
2489 \-\-\- a/file
2490 +++ b/file
2492 .if n \{\
2496 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\&.
2499 .RS 4
2500 .ie n \{\
2501 \h'-04' 4.\h'+01'\c
2503 .el \{\
2504 .sp -1
2505 .IP "  4." 4.2
2507 Chunk header format is modified to prevent people from accidentally feeding it to
2508 \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
2509 \fIindex\fR
2510 header:
2512 .if n \{\
2513 .RS 4
2516 @@@ <from\-file\-range> <from\-file\-range> <to\-file\-range> @@@
2518 .if n \{\
2522 There are (number of parents + 1)
2523 \fB@\fR
2524 characters in the chunk header for combined diff format\&.
2527 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\&.
2529 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)\&.
2531 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)\&.
2533 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")\&.
2534 .SH "EXAMPLES"
2536 \fBgit show v1\&.0\&.0\fR
2537 .RS 4
2538 Shows the tag
2539 \fBv1\&.0\&.0\fR, along with the object the tags points at\&.
2542 \fBgit show v1\&.0\&.0^{tree}\fR
2543 .RS 4
2544 Shows the tree pointed to by the tag
2545 \fBv1\&.0\&.0\fR\&.
2548 \fBgit show \-s \-\-format=%s v1\&.0\&.0^{commit}\fR
2549 .RS 4
2550 Shows the subject of the commit pointed to by the tag
2551 \fBv1\&.0\&.0\fR\&.
2554 \fBgit show next~10:Documentation/README\fR
2555 .RS 4
2556 Shows the contents of the file
2557 \fBDocumentation/README\fR
2558 as they were current in the 10th last commit of the branch
2559 \fBnext\fR\&.
2562 \fBgit show master:Makefile master:t/Makefile\fR
2563 .RS 4
2564 Concatenates the contents of said Makefiles in the head of the branch
2565 \fBmaster\fR\&.
2567 .SH "DISCUSSION"
2569 Git is to some extent character encoding agnostic\&.
2571 .RS 4
2572 .ie n \{\
2573 \h'-04'\(bu\h'+03'\c
2575 .el \{\
2576 .sp -1
2577 .IP \(bu 2.3
2579 The contents of the blob objects are uninterpreted sequences of bytes\&. There is no encoding translation at the core level\&.
2582 .RS 4
2583 .ie n \{\
2584 \h'-04'\(bu\h'+03'\c
2586 .el \{\
2587 .sp -1
2588 .IP \(bu 2.3
2590 Path names are encoded in UTF\-8 normalization form C\&. This applies to tree objects, the index file, ref names, as well as path names in command line arguments, environment variables and config files (\fB\&.git/config\fR
2591 (see
2592 \fBgit-config\fR(1)),
2593 \fBgitignore\fR(5),
2594 \fBgitattributes\fR(5)
2596 \fBgitmodules\fR(5))\&.
2598 Note that Git at the core level treats path names simply as sequences of non\-NUL bytes, there are no path name encoding conversions (except on Mac and Windows)\&. Therefore, using non\-ASCII path names will mostly work even on platforms and file systems that use legacy extended ASCII encodings\&. However, repositories created on such systems will not work properly on UTF\-8\-based systems (e\&.g\&. Linux, Mac, Windows) and vice versa\&. Additionally, many Git\-based tools simply assume path names to be UTF\-8 and will fail to display other encodings correctly\&.
2601 .RS 4
2602 .ie n \{\
2603 \h'-04'\(bu\h'+03'\c
2605 .el \{\
2606 .sp -1
2607 .IP \(bu 2.3
2609 Commit log messages are typically encoded in UTF\-8, but other extended ASCII encodings are also supported\&. This includes ISO\-8859\-x, CP125x and many others, but
2610 \fInot\fR
2611 UTF\-16/32, EBCDIC and CJK multi\-byte encodings (GBK, Shift\-JIS, Big5, EUC\-x, CP9xx etc\&.)\&.
2614 Although we encourage that the commit log messages are encoded in UTF\-8, both the core and Git Porcelain are designed not to force UTF\-8 on projects\&. If all participants of a particular project find it more convenient to use legacy encodings, Git does not forbid it\&. However, there are a few things to keep in mind\&.
2616 .RS 4
2617 .ie n \{\
2618 \h'-04' 1.\h'+01'\c
2620 .el \{\
2621 .sp -1
2622 .IP "  1." 4.2
2624 \fIgit commit\fR
2626 \fIgit commit\-tree\fR
2627 issues a warning if the commit log message given to it does not look like a valid UTF\-8 string, unless you explicitly say your project uses a legacy encoding\&. The way to say this is to have
2628 \fBi18n\&.commitEncoding\fR
2630 \fB\&.git/config\fR
2631 file, like this:
2633 .if n \{\
2634 .RS 4
2637 [i18n]
2638         commitEncoding = ISO\-8859\-1
2640 .if n \{\
2644 Commit objects created with the above setting record the value of
2645 \fBi18n\&.commitEncoding\fR
2646 in its
2647 \fBencoding\fR
2648 header\&. This is to help other people who look at them later\&. Lack of this header implies that the commit log message is encoded in UTF\-8\&.
2651 .RS 4
2652 .ie n \{\
2653 \h'-04' 2.\h'+01'\c
2655 .el \{\
2656 .sp -1
2657 .IP "  2." 4.2
2659 \fIgit log\fR,
2660 \fIgit show\fR,
2661 \fIgit blame\fR
2662 and friends look at the
2663 \fBencoding\fR
2664 header of a commit object, and try to re\-code the log message into UTF\-8 unless otherwise specified\&. You can specify the desired output encoding with
2665 \fBi18n\&.logOutputEncoding\fR
2667 \fB\&.git/config\fR
2668 file, like this:
2670 .if n \{\
2671 .RS 4
2674 [i18n]
2675         logOutputEncoding = ISO\-8859\-1
2677 .if n \{\
2681 If you do not have this configuration variable, the value of
2682 \fBi18n\&.commitEncoding\fR
2683 is used instead\&.
2686 Note that we deliberately chose not to re\-code the commit log message when a commit is made to force UTF\-8 at the commit object level, because re\-coding to UTF\-8 is not necessarily a reversible operation\&.
2687 .SH "GIT"
2689 Part of the \fBgit\fR(1) suite