blob: a966c588a7087b60b5fe0821777aeca533442862 [file] [log] [blame]
Junio C Hamano96153bf2018-04-25 08:25:341<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamano1a4e8412005-12-27 08:17:232<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5<head>
Junio C Hamano9629d4f2012-12-19 00:28:276<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoa85030a2022-07-27 16:48:217<meta name="generator" content="AsciiDoc 10.2.0" />
Junio C Hamano68cf15a2010-11-06 01:01:598<title>git-log(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:239<style type="text/css">
Junio C Hamano9629d4f2012-12-19 00:28:2710/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano1a4e8412005-12-27 08:17:2325}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
Junio C Hamanoba4b9282008-07-06 05:20:3131a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
Junio C Hamano1a4e8412005-12-27 08:17:2338
39em {
40 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:5941 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:2342}
43
44strong {
45 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:5946 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:2347}
48
Junio C Hamano1a4e8412005-12-27 08:17:2349h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:2351 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
Junio C Hamanoba4b9282008-07-06 05:20:3156h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:2357 border-bottom: 2px solid silver;
58}
59h2 {
Junio C Hamano1a4e8412005-12-27 08:17:2360 padding-top: 0.5em;
61}
Junio C Hamanoba4b9282008-07-06 05:20:3162h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
Junio C Hamano9629d4f2012-12-19 00:28:2768h5 {
69 font-size: 1.0em;
70}
Junio C Hamano1a4e8412005-12-27 08:17:2371
72div.sectionbody {
Junio C Hamano1a4e8412005-12-27 08:17:2373 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
Junio C Hamano68cf15a2010-11-06 01:01:5985ul, ol, li > p {
86 margin-top: 0;
87}
Junio C Hamano9629d4f2012-12-19 00:28:2788ul > li { color: #aaa; }
89ul > li > * { color: black; }
Junio C Hamano68cf15a2010-11-06 01:01:5990
Junio C Hamanoac12f0e2014-09-19 22:32:5191.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:2395 padding: 0;
96 margin: 0;
97}
Junio C Hamanoac12f0e2014-09-19 22:32:5198pre {
99 white-space: pre-wrap;
100}
Junio C Hamano1a4e8412005-12-27 08:17:23101
Junio C Hamano9629d4f2012-12-19 00:28:27102#author {
Junio C Hamano1a4e8412005-12-27 08:17:23103 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23104 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31105 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23106}
Junio C Hamano9629d4f2012-12-19 00:28:27107#email {
Junio C Hamano1a4e8412005-12-27 08:17:23108}
Junio C Hamano9629d4f2012-12-19 00:28:27109#revnumber, #revdate, #revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23110}
111
Junio C Hamano9629d4f2012-12-19 00:28:27112#footer {
Junio C Hamano1a4e8412005-12-27 08:17:23113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
Junio C Hamano9629d4f2012-12-19 00:28:27118#footer-text {
Junio C Hamano1a4e8412005-12-27 08:17:23119 float: left;
120 padding-bottom: 0.5em;
121}
Junio C Hamano9629d4f2012-12-19 00:28:27122#footer-badges {
Junio C Hamano1a4e8412005-12-27 08:17:23123 float: right;
124 padding-bottom: 0.5em;
125}
126
Junio C Hamano9629d4f2012-12-19 00:28:27127#preamble {
Junio C Hamano68cf15a2010-11-06 01:01:59128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
Junio C Hamano9629d4f2012-12-19 00:28:27131div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano1a4e8412005-12-27 08:17:23132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22134 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59150 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
Junio C Hamano9629d4f2012-12-19 00:28:27172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
Junio C Hamano1a4e8412005-12-27 08:17:23174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
Junio C Hamano9629d4f2012-12-19 00:28:27178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
Junio C Hamano1a4e8412005-12-27 08:17:23181 padding: 0.5em;
182}
183
Junio C Hamano7bd050f2011-09-22 06:32:22184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59187 margin-right: 10%;
Junio C Hamano9629d4f2012-12-19 00:28:27188 border-left: 5px solid #f0f0f0;
189 color: #888;
Junio C Hamano1a4e8412005-12-27 08:17:23190}
Junio C Hamano7bd050f2011-09-22 06:32:22191
Junio C Hamano68cf15a2010-11-06 01:01:59192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23194 text-align: right;
195}
Junio C Hamano68cf15a2010-11-06 01:01:59196
Junio C Hamano9629d4f2012-12-19 00:28:27197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
Junio C Hamano68cf15a2010-11-06 01:01:59200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31206div.verseblock + div.attribution {
207 text-align: left;
208}
Junio C Hamano1a4e8412005-12-27 08:17:23209
210div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
217}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22220 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23221}
222
223div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23226}
227
Junio C Hamano1a4e8412005-12-27 08:17:23228div.imageblock div.content { padding-left: 0; }
Junio C Hamanoac12f0e2014-09-19 22:32:51229span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano68cf15a2010-11-06 01:01:59230a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59239 font-style: normal;
240 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23241}
242dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59243 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23244}
245
246ul, ol {
247 list-style-position: outside;
248}
Junio C Hamano68cf15a2010-11-06 01:01:59249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23253 list-style-type: lower-alpha;
254}
Junio C Hamano68cf15a2010-11-06 01:01:59255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
Junio C Hamano1a4e8412005-12-27 08:17:23271
Junio C Hamano1a4e8412005-12-27 08:17:23272tfoot {
273 font-weight: bold;
274}
Junio C Hamano68cf15a2010-11-06 01:01:59275td > div.verse {
276 white-space: pre;
277}
Junio C Hamano68cf15a2010-11-06 01:01:59278
279div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
Junio C Hamano68cf15a2010-11-06 01:01:59283div.hdlist tr {
284 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31285}
Junio C Hamano68cf15a2010-11-06 01:01:59286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23290 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59291 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23292 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59293 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23294}
Junio C Hamano68cf15a2010-11-06 01:01:59295td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23296 vertical-align: top;
297}
Junio C Hamano68cf15a2010-11-06 01:01:59298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
Junio C Hamano1a4e8412005-12-27 08:17:23306
Junio C Hamano7bd050f2011-09-22 06:32:22307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.footnote, span.footnoteref {
312 vertical-align: super;
313}
314
315#footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
318}
319
320#footnotes div.footnote {
321 margin: 0 0 5px 0;
322}
323
324#footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
332}
333
Junio C Hamano9629d4f2012-12-19 00:28:27334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
Junio C Hamano1a4e8412005-12-27 08:17:23341}
Junio C Hamanoba4b9282008-07-06 05:20:31342
Junio C Hamano9629d4f2012-12-19 00:28:27343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22348 margin-bottom: 2.5em;
349}
350
Junio C Hamano9629d4f2012-12-19 00:28:27351#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31352 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
Junio C Hamanoac12f0e2014-09-19 22:32:51359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
Junio C Hamano9629d4f2012-12-19 00:28:27375
376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
Junio C Hamanoac12f0e2014-09-19 22:32:51417div.unbreakable { page-break-inside: avoid; }
418
Junio C Hamano9629d4f2012-12-19 00:28:27419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428}
429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
Junio C Hamano725b0da2020-01-22 22:02:40439/* Because the table frame attribute is overridden by CSS in most browsers. */
Junio C Hamano9629d4f2012-12-19 00:28:27440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450}
451
452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481}
482
483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503}
504
505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507}
508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513}
514
515
516/*
517 * manpage specific
518 *
519 * */
520
521body.manpage h1 {
Junio C Hamano68cf15a2010-11-06 01:01:59522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526}
Junio C Hamano9629d4f2012-12-19 00:28:27527body.manpage h2 {
Junio C Hamano68cf15a2010-11-06 01:01:59528 border-style: none;
529}
Junio C Hamano9629d4f2012-12-19 00:28:27530body.manpage div.sectionbody {
531 margin-left: 3em;
Junio C Hamano68cf15a2010-11-06 01:01:59532}
533
534@media print {
Junio C Hamano9629d4f2012-12-19 00:28:27535 body.manpage div#toc { display: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59536}
Junio C Hamanoac12f0e2014-09-19 22:32:51537
538
Junio C Hamano1a4e8412005-12-27 08:17:23539</style>
Junio C Hamano7bd050f2011-09-22 06:32:22540<script type="text/javascript">
541/*<![CDATA[*/
Junio C Hamano2b153182021-12-15 21:00:31542var asciidoc = { // Namespace.
543
544/////////////////////////////////////////////////////////////////////
545// Table Of Contents generator
546/////////////////////////////////////////////////////////////////////
547
548/* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
550 *
551 * Table Of Content generator
552 * Version: 0.4
553 *
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
556 */
557
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
560
561// toclevels = 1..4.
562toc: function (toclevels) {
563
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
571 }
572 return text;
573 }
574
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
579 }
580
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
593 }
594 iterate(i);
595 }
596 }
597 }
598 iterate(el);
599 return result;
600 }
601
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
605 }
606
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
616 }
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
619 }
620
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
634 }
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
637},
638
639
640/////////////////////////////////////////////////////////////////////
641// Footnotes generator
642/////////////////////////////////////////////////////////////////////
643
644/* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
646 */
647
648footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
654 }
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
660 }
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
663 }
664
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
682 }
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
689 }
690 }
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
703 }
704 }
705 }
706},
707
708install: function(toclevels) {
709 var timerId;
710
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
715 }
716 }
717
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
721 }
722
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
728}
729
730}
Junio C Hamano9629d4f2012-12-19 00:28:27731asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22732/*]]>*/
733</script>
Junio C Hamano1a4e8412005-12-27 08:17:23734</head>
Junio C Hamano9629d4f2012-12-19 00:28:27735<body class="manpage">
Junio C Hamano1a4e8412005-12-27 08:17:23736<div id="header">
737<h1>
738git-log(1) Manual Page
739</h1>
740<h2>NAME</h2>
741<div class="sectionbody">
742<p>git-log -
743 Show commit logs
744</p>
745</div>
746</div>
Junio C Hamano7bd050f2011-09-22 06:32:22747<div id="content">
Junio C Hamano9629d4f2012-12-19 00:28:27748<div class="sect1">
Junio C Hamano68cf15a2010-11-06 01:01:59749<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23750<div class="sectionbody">
Junio C Hamano15567bc2011-07-23 00:51:59751<div class="verseblock">
Junio C Hamano59a32b02021-12-10 22:53:38752<pre class="content"><em>git log</em> [&lt;options&gt;] [&lt;revision-range&gt;] [[--] &lt;path&gt;&#8230;]</pre>
Junio C Hamano9629d4f2012-12-19 00:28:27753<div class="attribution">
Junio C Hamano15567bc2011-07-23 00:51:59754</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23755</div>
Junio C Hamano9629d4f2012-12-19 00:28:27756</div>
757<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31758<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23759<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59760<div class="paragraph"><p>Shows the commit logs.</p></div>
Junio C Hamano28c33de2020-07-30 21:22:26761<div class="paragraph"><p>List commits that are reachable by following the <code>parent</code> links from the
762given commit(s), but exclude commits that are reachable from the one(s)
763given with a <em>&#94;</em> in front of them. The output is given in reverse
764chronological order by default.</p></div>
765<div class="paragraph"><p>You can think of this as a set operation. Commits reachable from any of
766the commits given on the command line form a set, and then commits reachable
767from any of the ones given with <em>&#94;</em> in front are subtracted from that
768set. The remaining commits are what comes out in the command&#8217;s output.
769Various other options and paths parameters can be used to further limit the
770result.</p></div>
771<div class="paragraph"><p>Thus, the following command:</p></div>
772<div class="listingblock">
773<div class="content">
774<pre><code>$ git log foo bar ^baz</code></pre>
775</div></div>
776<div class="paragraph"><p>means "list all the commits which are reachable from <em>foo</em> or <em>bar</em>, but
777not from <em>baz</em>".</p></div>
778<div class="paragraph"><p>A special notation "<em>&lt;commit1&gt;</em>..<em>&lt;commit2&gt;</em>" can be used as a
779short-hand for "^<em>&lt;commit1&gt;</em> <em>&lt;commit2&gt;</em>". For example, either of
780the following may be used interchangeably:</p></div>
781<div class="listingblock">
782<div class="content">
783<pre><code>$ git log origin..HEAD
784$ git log HEAD ^origin</code></pre>
785</div></div>
786<div class="paragraph"><p>Another special notation is "<em>&lt;commit1&gt;</em>&#8230;<em>&lt;commit2&gt;</em>" which is useful
787for merges. The resulting set of commits is the symmetric difference
788between the two operands. The following two commands are equivalent:</p></div>
789<div class="listingblock">
790<div class="content">
791<pre><code>$ git log A B --not $(git merge-base --all A B)
792$ git log A...B</code></pre>
793</div></div>
794<div class="paragraph"><p>The command takes options applicable to the <a href="git-rev-list.html">git-rev-list(1)</a>
Junio C Hamanoba7c8d82006-04-15 06:17:42795command to control what is shown and how, and options applicable to
Junio C Hamano28c33de2020-07-30 21:22:26796the <a href="git-diff.html">git-diff(1)</a> command to control how the changes
Junio C Hamanoba4b9282008-07-06 05:20:31797each commit introduces are shown.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23798</div>
Junio C Hamano9629d4f2012-12-19 00:28:27799</div>
800<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31801<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23802<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59803<div class="dlist"><dl>
804<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45805--follow
806</dt>
807<dd>
808<p>
809 Continue listing the history of a file beyond renames
810 (works only for a single file).
811</p>
812</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59813<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45814--no-decorate
815</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59816<dt class="hdlist1">
Junio C Hamano37cf4082016-05-30 01:22:14817--decorate[=short|full|auto|no]
Junio C Hamano78e3a782010-07-15 22:24:45818</dt>
819<dd>
820<p>
821 Print out the ref names of any commits that are shown. If <em>short</em> is
822 specified, the ref name prefixes <em>refs/heads/</em>, <em>refs/tags/</em> and
823 <em>refs/remotes/</em> will not be printed. If <em>full</em> is specified, the
Junio C Hamano37cf4082016-05-30 01:22:14824 full ref name (including prefix) will be printed. If <em>auto</em> is
825 specified, then if the output is going to a terminal, the ref names
826 are shown as if <em>short</em> were given, otherwise no ref names are
Junio C Hamano91a411f2021-07-14 00:40:50827 shown. The option <code>--decorate</code> is short-hand for <code>--decorate=short</code>.
828 Default to configuration value of <code>log.decorate</code> if configured,
829 otherwise, <code>auto</code>.
Junio C Hamano78e3a782010-07-15 22:24:45830</p>
831</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59832<dt class="hdlist1">
Junio C Hamano371470a2017-12-13 22:26:40833--decorate-refs=&lt;pattern&gt;
834</dt>
835<dt class="hdlist1">
836--decorate-refs-exclude=&lt;pattern&gt;
837</dt>
838<dd>
839<p>
Junio C Hamano594d2d42022-08-30 17:58:50840 For each candidate reference, do not use it for decoration if it
Junio C Hamano371470a2017-12-13 22:26:40841 matches any patterns given to <code>--decorate-refs-exclude</code> or if it
Junio C Hamano0dd50942020-04-29 21:21:05842 doesn&#8217;t match any of the patterns given to <code>--decorate-refs</code>. The
843 <code>log.excludeDecoration</code> config option allows excluding refs from
844 the decorations, but an explicit <code>--decorate-refs</code> pattern will
845 override a match in <code>log.excludeDecoration</code>.
Junio C Hamano371470a2017-12-13 22:26:40846</p>
Junio C Hamano594d2d42022-08-30 17:58:50847<div class="paragraph"><p>If none of these options or config settings are given, then references are
848used as decoration if they match <code>HEAD</code>, <code>refs/heads/</code>, <code>refs/remotes/</code>,
849<code>refs/stash/</code>, or <code>refs/tags/</code>.</p></div>
850</dd>
851<dt class="hdlist1">
852--clear-decorations
853</dt>
854<dd>
855<p>
856 When specified, this option clears all previous <code>--decorate-refs</code>
857 or <code>--decorate-refs-exclude</code> options and relaxes the default
858 decoration filter to include all references. This option is
859 assumed if the config value <code>log.initialDecorationSet</code> is set to
860 <code>all</code>.
861</p>
Junio C Hamano371470a2017-12-13 22:26:40862</dd>
863<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45864--source
865</dt>
866<dd>
867<p>
868 Print out the ref name given on the command line by which each
869 commit was reached.
870</p>
871</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59872<dt class="hdlist1">
Junio C Hamano0dd50942020-04-29 21:21:05873--[no-]mailmap
874</dt>
875<dt class="hdlist1">
Junio C Hamano36594952019-07-25 22:26:52876--[no-]use-mailmap
Junio C Hamanoce836cc2013-01-21 02:01:53877</dt>
878<dd>
879<p>
880 Use mailmap file to map author and committer names and email
Junio C Hamanob73af6c2013-12-03 22:07:11881 addresses to canonical real names and email addresses. See
Junio C Hamanoce836cc2013-01-21 02:01:53882 <a href="git-shortlog.html">git-shortlog(1)</a>.
883</p>
884</dd>
885<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45886--full-diff
887</dt>
888<dd>
889<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51890 Without this flag, <code>git log -p &lt;path&gt;...</code> shows commits that
Junio C Hamano78e3a782010-07-15 22:24:45891 touch the specified paths, and diffs about the same specified
892 paths. With this, the full diff is shown for commits that touch
893 the specified paths; this means that "&lt;path&gt;&#8230;" limits only
Junio C Hamano68cf15a2010-11-06 01:01:59894 commits, and doesn&#8217;t limit diff for those commits.
Junio C Hamano78e3a782010-07-15 22:24:45895</p>
Junio C Hamano68cf15a2010-11-06 01:01:59896<div class="paragraph"><p>Note that this affects all diff-based output types, e.g. those
Junio C Hamanoac12f0e2014-09-19 22:32:51897produced by <code>--stat</code>, etc.</p></div>
Junio C Hamano78e3a782010-07-15 22:24:45898</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59899<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45900--log-size
901</dt>
902<dd>
903<p>
Junio C Hamanob73af6c2013-12-03 22:07:11904 Include a line &#8220;log size &lt;number&gt;&#8221; in the output for each commit,
905 where &lt;number&gt; is the length of that commit&#8217;s message in bytes.
Junio C Hamanoac12f0e2014-09-19 22:32:51906 Intended to speed up tools that read log messages from <code>git log</code>
Junio C Hamanob73af6c2013-12-03 22:07:11907 output by allowing them to allocate space in advance.
Junio C Hamano78e3a782010-07-15 22:24:45908</p>
909</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59910<dt class="hdlist1">
Junio C Hamanob7676d52020-11-18 22:15:08911-L&lt;start&gt;,&lt;end&gt;:&lt;file&gt;
Junio C Hamano8eac2682013-09-09 22:35:20912</dt>
913<dt class="hdlist1">
Junio C Hamanob7676d52020-11-18 22:15:08914-L:&lt;funcname&gt;:&lt;file&gt;
Junio C Hamano7e590a12013-06-02 23:46:52915</dt>
916<dd>
917<p>
Junio C Hamanob7676d52020-11-18 22:15:08918 Trace the evolution of the line range given by <em>&lt;start&gt;,&lt;end&gt;</em>,
919 or by the function name regex <em>&lt;funcname&gt;</em>, within the <em>&lt;file&gt;</em>. You may
Junio C Hamano7e590a12013-06-02 23:46:52920 not give any pathspec limiters. This is currently limited to
921 a walk starting from a single revision, i.e., you may only
Junio C Hamano68793842020-01-06 23:07:09922 give zero or one positive revision arguments, and
Junio C Hamanob7676d52020-11-18 22:15:08923 <em>&lt;start&gt;</em> and <em>&lt;end&gt;</em> (or <em>&lt;funcname&gt;</em>) must exist in the starting revision.
Junio C Hamano68793842020-01-06 23:07:09924 You can specify this option more than once. Implies <code>--patch</code>.
925 Patch output can be suppressed using <code>--no-patch</code>, but other diff formats
926 (namely <code>--raw</code>, <code>--numstat</code>, <code>--shortstat</code>, <code>--dirstat</code>, <code>--summary</code>,
927 <code>--name-only</code>, <code>--name-status</code>, <code>--check</code>) are not currently implemented.
Junio C Hamano7e590a12013-06-02 23:46:52928</p>
Junio C Hamanob7676d52020-11-18 22:15:08929<div class="paragraph"><p><em>&lt;start&gt;</em> and <em>&lt;end&gt;</em> can take one of these forms:</p></div>
Junio C Hamano7e590a12013-06-02 23:46:52930<div class="ulist"><ul>
931<li>
932<p>
933number
934</p>
Junio C Hamanob7676d52020-11-18 22:15:08935<div class="paragraph"><p>If <em>&lt;start&gt;</em> or <em>&lt;end&gt;</em> is a number, it specifies an
Junio C Hamano7e590a12013-06-02 23:46:52936absolute line number (lines count from 1).</p></div>
937</li>
938<li>
939<p>
Junio C Hamanob7676d52020-11-18 22:15:08940<code>/regex/</code>
Junio C Hamano7e590a12013-06-02 23:46:52941</p>
942<div class="paragraph"><p>This form will use the first line matching the given
Junio C Hamanob7676d52020-11-18 22:15:08943POSIX regex. If <em>&lt;start&gt;</em> is a regex, it will search from the end of
Junio C Hamanoac12f0e2014-09-19 22:32:51944the previous <code>-L</code> range, if any, otherwise from the start of file.
Junio C Hamanob7676d52020-11-18 22:15:08945If <em>&lt;start&gt;</em> is <code>^/regex/</code>, it will search from the start of file.
946If <em>&lt;end&gt;</em> is a regex, it will search
947starting at the line given by <em>&lt;start&gt;</em>.</p></div>
Junio C Hamano7e590a12013-06-02 23:46:52948</li>
949<li>
950<p>
951+offset or -offset
952</p>
Junio C Hamanob7676d52020-11-18 22:15:08953<div class="paragraph"><p>This is only valid for <em>&lt;end&gt;</em> and will specify a number
954of lines before or after the line given by <em>&lt;start&gt;</em>.</p></div>
Junio C Hamano7e590a12013-06-02 23:46:52955</li>
Junio C Hamano7e590a12013-06-02 23:46:52956</ul></div>
Junio C Hamanob7676d52020-11-18 22:15:08957<div class="paragraph"><p>If <code>:&lt;funcname&gt;</code> is given in place of <em>&lt;start&gt;</em> and <em>&lt;end&gt;</em>, it is a
Junio C Hamanodd5004a2015-05-06 19:33:32958regular expression that denotes the range from the first funcname line
Junio C Hamanob7676d52020-11-18 22:15:08959that matches <em>&lt;funcname&gt;</em>, up to the next funcname line. <code>:&lt;funcname&gt;</code>
Junio C Hamanodd5004a2015-05-06 19:33:32960searches from the end of the previous <code>-L</code> range, if any, otherwise
Junio C Hamanob7676d52020-11-18 22:15:08961from the start of file. <code>^:&lt;funcname&gt;</code> searches from the start of
962file. The function names are determined in the same way as <code>git diff</code>
963works out patch hunk headers (see <em>Defining a custom hunk-header</em>
964in <a href="gitattributes.html">gitattributes(5)</a>).</p></div>
Junio C Hamano7e590a12013-06-02 23:46:52965</dd>
966<dt class="hdlist1">
Junio C Hamano59a32b02021-12-10 22:53:38967&lt;revision-range&gt;
Junio C Hamanof26c77e2013-04-27 00:06:04968</dt>
969<dd>
970<p>
971 Show only commits in the specified revision range. When no
Junio C Hamano59a32b02021-12-10 22:53:38972 &lt;revision-range&gt; is specified, it defaults to <code>HEAD</code> (i.e. the
Junio C Hamanoac12f0e2014-09-19 22:32:51973 whole history leading to the current commit). <code>origin..HEAD</code>
Junio C Hamanof26c77e2013-04-27 00:06:04974 specifies all the commits reachable from the current commit
Junio C Hamanoac12f0e2014-09-19 22:32:51975 (i.e. <code>HEAD</code>), but not from <code>origin</code>. For a complete list of
Junio C Hamano59a32b02021-12-10 22:53:38976 ways to spell &lt;revision-range&gt;, see the <em>Specifying Ranges</em>
Junio C Hamanof26c77e2013-04-27 00:06:04977 section of <a href="gitrevisions.html">gitrevisions(7)</a>.
978</p>
979</dd>
980<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45981[--] &lt;path&gt;&#8230;
982</dt>
983<dd>
984<p>
Junio C Hamano5723afa2011-08-31 00:49:23985 Show only commits that are enough to explain how the files
Junio C Hamanob73af6c2013-12-03 22:07:11986 that match the specified paths came to be. See <em>History
987 Simplification</em> below for details and other simplification
Junio C Hamano5723afa2011-08-31 00:49:23988 modes.
Junio C Hamano78e3a782010-07-15 22:24:45989</p>
Junio C Hamanoccb82522018-05-08 07:52:09990<div class="paragraph"><p>Paths may need to be prefixed with <code>--</code> to separate them from
Junio C Hamanof26c77e2013-04-27 00:06:04991options or the revision range, when confusion arises.</p></div>
Junio C Hamano78e3a782010-07-15 22:24:45992</dd>
993</dl></div>
Junio C Hamano9629d4f2012-12-19 00:28:27994<div class="sect2">
995<h3 id="_commit_limiting">Commit Limiting</h3>
Junio C Hamano68cf15a2010-11-06 01:01:59996<div class="paragraph"><p>Besides specifying a range of commits that should be listed using the
Junio C Hamanob0e02952008-01-19 08:02:00997special notations explained in the description, additional commit
Junio C Hamano8ce35d72012-09-18 22:30:42998limiting may be applied.</p></div>
999<div class="paragraph"><p>Using more options generally further limits the output (e.g.
Junio C Hamanoac12f0e2014-09-19 22:32:511000<code>--since=&lt;date1&gt;</code> limits to commits newer than <code>&lt;date1&gt;</code>, and using it
1001with <code>--grep=&lt;pattern&gt;</code> further limits to commits whose log message
1002has a line that matches <code>&lt;pattern&gt;</code>), unless otherwise noted.</p></div>
Junio C Hamano8ce35d72012-09-18 22:30:421003<div class="paragraph"><p>Note that these are applied before commit
Junio C Hamanoac12f0e2014-09-19 22:32:511004ordering and formatting options, such as <code>--reverse</code>.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591005<div class="dlist"><dl>
1006<dt class="hdlist1">
Junio C Hamano693e7092012-09-12 22:56:531007-&lt;number&gt;
1008</dt>
1009<dt class="hdlist1">
1010-n &lt;number&gt;
Junio C Hamanoeb415992008-06-08 22:49:471011</dt>
Junio C Hamano68cf15a2010-11-06 01:01:591012<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:321013--max-count=&lt;number&gt;
Junio C Hamanob0e02952008-01-19 08:02:001014</dt>
1015<dd>
1016<p>
Junio C Hamanoc5be4cc2011-03-09 07:20:431017 Limit the number of commits to output.
Junio C Hamanob0e02952008-01-19 08:02:001018</p>
1019</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591020<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:321021--skip=&lt;number&gt;
Junio C Hamanob0e02952008-01-19 08:02:001022</dt>
1023<dd>
1024<p>
1025 Skip <em>number</em> commits before starting to show the commit output.
1026</p>
1027</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591028<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:321029--since=&lt;date&gt;
Junio C Hamanoeb415992008-06-08 22:49:471030</dt>
Junio C Hamano68cf15a2010-11-06 01:01:591031<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:321032--after=&lt;date&gt;
Junio C Hamanob0e02952008-01-19 08:02:001033</dt>
1034<dd>
1035<p>
1036 Show commits more recent than a specific date.
1037</p>
1038</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591039<dt class="hdlist1">
Junio C Hamano72ea2ca2022-05-21 00:51:231040--since-as-filter=&lt;date&gt;
1041</dt>
1042<dd>
1043<p>
1044 Show all commits more recent than a specific date. This visits
1045 all commits in the range, rather than stopping at the first commit which
1046 is older than a specific date.
1047</p>
1048</dd>
1049<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:321050--until=&lt;date&gt;
Junio C Hamanoeb415992008-06-08 22:49:471051</dt>
Junio C Hamano68cf15a2010-11-06 01:01:591052<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:321053--before=&lt;date&gt;
Junio C Hamanob0e02952008-01-19 08:02:001054</dt>
1055<dd>
1056<p>
1057 Show commits older than a specific date.
1058</p>
1059</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591060<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:321061--author=&lt;pattern&gt;
Junio C Hamanoeb415992008-06-08 22:49:471062</dt>
Junio C Hamano68cf15a2010-11-06 01:01:591063<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:321064--committer=&lt;pattern&gt;
Junio C Hamanob0e02952008-01-19 08:02:001065</dt>
1066<dd>
1067<p>
1068 Limit the commits output to ones with author/committer
Junio C Hamano8ce35d72012-09-18 22:30:421069 header lines that match the specified pattern (regular
Junio C Hamanoac12f0e2014-09-19 22:32:511070 expression). With more than one <code>--author=&lt;pattern&gt;</code>,
Junio C Hamano8ce35d72012-09-18 22:30:421071 commits whose author matches any of the given patterns are
Junio C Hamanoac12f0e2014-09-19 22:32:511072 chosen (similarly for multiple <code>--committer=&lt;pattern&gt;</code>).
Junio C Hamanob0e02952008-01-19 08:02:001073</p>
1074</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591075<dt class="hdlist1">
Junio C Hamano9954ed72012-10-03 04:54:001076--grep-reflog=&lt;pattern&gt;
1077</dt>
1078<dd>
1079<p>
1080 Limit the commits output to ones with reflog entries that
1081 match the specified pattern (regular expression). With
Junio C Hamanoac12f0e2014-09-19 22:32:511082 more than one <code>--grep-reflog</code>, commits whose reflog message
Junio C Hamano9954ed72012-10-03 04:54:001083 matches any of the given patterns are chosen. It is an
Junio C Hamanoac12f0e2014-09-19 22:32:511084 error to use this option unless <code>--walk-reflogs</code> is in use.
Junio C Hamano9954ed72012-10-03 04:54:001085</p>
1086</dd>
1087<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:321088--grep=&lt;pattern&gt;
Junio C Hamanob0e02952008-01-19 08:02:001089</dt>
1090<dd>
1091<p>
1092 Limit the commits output to ones with log message that
Junio C Hamano8ce35d72012-09-18 22:30:421093 matches the specified pattern (regular expression). With
Junio C Hamanoac12f0e2014-09-19 22:32:511094 more than one <code>--grep=&lt;pattern&gt;</code>, commits whose message
Junio C Hamano8ce35d72012-09-18 22:30:421095 matches any of the given patterns are chosen (but see
Junio C Hamanoac12f0e2014-09-19 22:32:511096 <code>--all-match</code>).
Junio C Hamanob0e02952008-01-19 08:02:001097</p>
Junio C Hamanob3f862c2019-12-05 22:22:001098<div class="paragraph"><p>When <code>--notes</code> is in effect, the message from the notes is
Junio C Hamano8152abf2015-04-28 22:48:021099matched as if it were part of the log message.</p></div>
Junio C Hamanob0e02952008-01-19 08:02:001100</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591101<dt class="hdlist1">
Junio C Hamanoaa17c7c2008-11-03 04:36:581102--all-match
1103</dt>
1104<dd>
1105<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511106 Limit the commits output to ones that match all given <code>--grep</code>,
Junio C Hamano8ce35d72012-09-18 22:30:421107 instead of ones that match at least one.
Junio C Hamanoaa17c7c2008-11-03 04:36:581108</p>
1109</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591110<dt class="hdlist1">
Junio C Hamano6bb32e62015-02-17 22:11:261111--invert-grep
1112</dt>
1113<dd>
1114<p>
1115 Limit the commits output to ones with log message that do not
1116 match the pattern specified with <code>--grep=&lt;pattern&gt;</code>.
1117</p>
1118</dd>
1119<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471120-i
1121</dt>
Junio C Hamano68cf15a2010-11-06 01:01:591122<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471123--regexp-ignore-case
Junio C Hamanob0e02952008-01-19 08:02:001124</dt>
1125<dd>
1126<p>
Junio C Hamanob73af6c2013-12-03 22:07:111127 Match the regular expression limiting patterns without regard to letter
1128 case.
Junio C Hamanob0e02952008-01-19 08:02:001129</p>
1130</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591131<dt class="hdlist1">
Junio C Hamanoa1295452012-11-13 22:32:041132--basic-regexp
1133</dt>
1134<dd>
1135<p>
1136 Consider the limiting patterns to be basic regular expressions;
1137 this is the default.
1138</p>
1139</dd>
1140<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471141-E
1142</dt>
Junio C Hamano68cf15a2010-11-06 01:01:591143<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471144--extended-regexp
Junio C Hamanob0e02952008-01-19 08:02:001145</dt>
1146<dd>
1147<p>
1148 Consider the limiting patterns to be extended regular expressions
1149 instead of the default basic regular expressions.
1150</p>
1151</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591152<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471153-F
1154</dt>
Junio C Hamano68cf15a2010-11-06 01:01:591155<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471156--fixed-strings
Junio C Hamano24bc09a2008-02-28 00:27:441157</dt>
1158<dd>
1159<p>
Junio C Hamano68cf15a2010-11-06 01:01:591160 Consider the limiting patterns to be fixed strings (don&#8217;t interpret
Junio C Hamano24bc09a2008-02-28 00:27:441161 pattern as a regular expression).
1162</p>
1163</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591164<dt class="hdlist1">
Junio C Hamanoa275c1f2017-06-19 20:10:121165-P
1166</dt>
1167<dt class="hdlist1">
Junio C Hamanoa1295452012-11-13 22:32:041168--perl-regexp
1169</dt>
1170<dd>
1171<p>
Junio C Hamano222ed822017-06-02 06:24:061172 Consider the limiting patterns to be Perl-compatible regular
1173 expressions.
Junio C Hamanoa1295452012-11-13 22:32:041174</p>
Junio C Hamano222ed822017-06-02 06:24:061175<div class="paragraph"><p>Support for these types of regular expressions is an optional
1176compile-time dependency. If Git wasn&#8217;t compiled with support for them
1177providing this option will cause it to die.</p></div>
Junio C Hamanoa1295452012-11-13 22:32:041178</dd>
1179<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:001180--remove-empty
1181</dt>
1182<dd>
1183<p>
1184 Stop when a given path disappears from the tree.
1185</p>
1186</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591187<dt class="hdlist1">
Junio C Hamano934e1782009-07-16 06:59:151188--merges
1189</dt>
1190<dd>
1191<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511192 Print only merge commits. This is exactly the same as <code>--min-parents=2</code>.
Junio C Hamano934e1782009-07-16 06:59:151193</p>
1194</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591195<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:001196--no-merges
1197</dt>
1198<dd>
1199<p>
Junio C Hamanof32ce262011-03-27 07:35:111200 Do not print commits with more than one parent. This is
Junio C Hamanoac12f0e2014-09-19 22:32:511201 exactly the same as <code>--max-parents=1</code>.
Junio C Hamanob0e02952008-01-19 08:02:001202</p>
1203</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591204<dt class="hdlist1">
Junio C Hamanof32ce262011-03-27 07:35:111205--min-parents=&lt;number&gt;
1206</dt>
1207<dt class="hdlist1">
1208--max-parents=&lt;number&gt;
1209</dt>
1210<dt class="hdlist1">
1211--no-min-parents
1212</dt>
1213<dt class="hdlist1">
1214--no-max-parents
1215</dt>
1216<dd>
1217<p>
Junio C Hamanoc5bb3b32013-08-05 22:43:361218 Show only commits which have at least (or at most) that many parent
Junio C Hamanoac12f0e2014-09-19 22:32:511219 commits. In particular, <code>--max-parents=1</code> is the same as <code>--no-merges</code>,
1220 <code>--min-parents=2</code> is the same as <code>--merges</code>. <code>--max-parents=0</code>
1221 gives all root commits and <code>--min-parents=3</code> all octopus merges.
Junio C Hamanof32ce262011-03-27 07:35:111222</p>
Junio C Hamanoac12f0e2014-09-19 22:32:511223<div class="paragraph"><p><code>--no-min-parents</code> and <code>--no-max-parents</code> reset these limits (to no limit)
1224again. Equivalent forms are <code>--min-parents=0</code> (any commit has 0 or more
1225parents) and <code>--max-parents=-1</code> (negative numbers denote no upper limit).</p></div>
Junio C Hamanof32ce262011-03-27 07:35:111226</dd>
1227<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:001228--first-parent
1229</dt>
1230<dd>
1231<p>
Junio C Hamano034a2ff2022-02-18 00:40:111232 When finding commits to include, follow only the first
1233 parent commit upon seeing a merge commit. This option
1234 can give a better overview when viewing the evolution of
1235 a particular topic branch, because merges into a topic
1236 branch tend to be only about adjusting to updated upstream
1237 from time to time, and this option allows you to ignore
1238 the individual commits brought in to your history by such
1239 a merge.
Junio C Hamanob0e02952008-01-19 08:02:001240</p>
Junio C Hamanoa372d5b2021-02-26 01:34:371241<div class="paragraph"><p>This option also changes default diff format for merge commits
1242to <code>first-parent</code>, see <code>--diff-merges=first-parent</code> for details.</p></div>
Junio C Hamanob0e02952008-01-19 08:02:001243</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591244<dt class="hdlist1">
Junio C Hamano034a2ff2022-02-18 00:40:111245--exclude-first-parent-only
1246</dt>
1247<dd>
1248<p>
1249 When finding commits to exclude (with a <em>&#94;</em>), follow only
1250 the first parent commit upon seeing a merge commit.
1251 This can be used to find the set of changes in a topic branch
1252 from the point where it diverged from the remote branch, given
1253 that arbitrary merges can be valid topic branch changes.
1254</p>
1255</dd>
1256<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:001257--not
1258</dt>
1259<dd>
1260<p>
1261 Reverses the meaning of the <em>&#94;</em> prefix (or lack thereof)
Junio C Hamanoac12f0e2014-09-19 22:32:511262 for all following revision specifiers, up to the next <code>--not</code>.
Junio C Hamanob0e02952008-01-19 08:02:001263</p>
1264</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591265<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:001266--all
1267</dt>
1268<dd>
1269<p>
Junio C Hamanoe89102f2017-02-15 23:18:151270 Pretend as if all the refs in <code>refs/</code>, along with <code>HEAD</code>, are
1271 listed on the command line as <em>&lt;commit&gt;</em>.
Junio C Hamanob0e02952008-01-19 08:02:001272</p>
1273</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591274<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:171275--branches[=&lt;pattern&gt;]
Junio C Hamano50819852008-11-19 02:07:561276</dt>
1277<dd>
1278<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511279 Pretend as if all the refs in <code>refs/heads</code> are listed
Junio C Hamanod2179ef2010-10-22 04:12:171280 on the command line as <em>&lt;commit&gt;</em>. If <em>&lt;pattern&gt;</em> is given, limit
Junio C Hamano57827fb2010-01-23 03:02:501281 branches to ones matching given shell glob. If pattern lacks <em>?</em>,
Junio C Hamano81d540a2012-03-02 19:52:471282 <em>&#42;</em>, or <em>[</em>, <em>/&#42;</em> at the end is implied.
Junio C Hamano50819852008-11-19 02:07:561283</p>
1284</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591285<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:171286--tags[=&lt;pattern&gt;]
Junio C Hamano50819852008-11-19 02:07:561287</dt>
1288<dd>
1289<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511290 Pretend as if all the refs in <code>refs/tags</code> are listed
Junio C Hamanod2179ef2010-10-22 04:12:171291 on the command line as <em>&lt;commit&gt;</em>. If <em>&lt;pattern&gt;</em> is given, limit
Junio C Hamano81d540a2012-03-02 19:52:471292 tags to ones matching given shell glob. If pattern lacks <em>?</em>, <em>&#42;</em>,
1293 or <em>[</em>, <em>/&#42;</em> at the end is implied.
Junio C Hamano50819852008-11-19 02:07:561294</p>
1295</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591296<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:171297--remotes[=&lt;pattern&gt;]
Junio C Hamano50819852008-11-19 02:07:561298</dt>
1299<dd>
1300<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511301 Pretend as if all the refs in <code>refs/remotes</code> are listed
Junio C Hamanod2179ef2010-10-22 04:12:171302 on the command line as <em>&lt;commit&gt;</em>. If <em>&lt;pattern&gt;</em> is given, limit
Junio C Hamano97bcb482010-11-25 03:16:071303 remote-tracking branches to ones matching given shell glob.
Junio C Hamano81d540a2012-03-02 19:52:471304 If pattern lacks <em>?</em>, <em>&#42;</em>, or <em>[</em>, <em>/&#42;</em> at the end is implied.
Junio C Hamano57827fb2010-01-23 03:02:501305</p>
1306</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591307<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:171308--glob=&lt;glob-pattern&gt;
Junio C Hamano57827fb2010-01-23 03:02:501309</dt>
1310<dd>
1311<p>
Junio C Hamanod2179ef2010-10-22 04:12:171312 Pretend as if all the refs matching shell glob <em>&lt;glob-pattern&gt;</em>
Junio C Hamano57827fb2010-01-23 03:02:501313 are listed on the command line as <em>&lt;commit&gt;</em>. Leading <em>refs/</em>,
Junio C Hamano81d540a2012-03-02 19:52:471314 is automatically prepended if missing. If pattern lacks <em>?</em>, <em>&#42;</em>,
1315 or <em>[</em>, <em>/&#42;</em> at the end is implied.
Junio C Hamano50819852008-11-19 02:07:561316</p>
1317</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591318<dt class="hdlist1">
Junio C Hamanof079f702013-12-06 23:43:181319--exclude=&lt;glob-pattern&gt;
1320</dt>
1321<dd>
1322<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511323 Do not include refs matching <em>&lt;glob-pattern&gt;</em> that the next <code>--all</code>,
1324 <code>--branches</code>, <code>--tags</code>, <code>--remotes</code>, or <code>--glob</code> would otherwise
Junio C Hamanof079f702013-12-06 23:43:181325 consider. Repetitions of this option accumulate exclusion patterns
Junio C Hamanoac12f0e2014-09-19 22:32:511326 up to the next <code>--all</code>, <code>--branches</code>, <code>--tags</code>, <code>--remotes</code>, or
1327 <code>--glob</code> option (other options or arguments do not clear
Junio C Hamanofb5ffde2014-11-04 22:38:561328 accumulated patterns).
Junio C Hamanof079f702013-12-06 23:43:181329</p>
Junio C Hamanoac12f0e2014-09-19 22:32:511330<div class="paragraph"><p>The patterns given should not begin with <code>refs/heads</code>, <code>refs/tags</code>, or
1331<code>refs/remotes</code> when applied to <code>--branches</code>, <code>--tags</code>, or <code>--remotes</code>,
1332respectively, and they must begin with <code>refs/</code> when applied to <code>--glob</code>
1333or <code>--all</code>. If a trailing <em>/&#42;</em> is intended, it must be given
Junio C Hamanof079f702013-12-06 23:43:181334explicitly.</p></div>
1335</dd>
1336<dt class="hdlist1">
Junio C Hamanoe6ab9192022-11-23 04:01:361337--exclude-hidden=[receive|uploadpack]
1338</dt>
1339<dd>
1340<p>
1341 Do not include refs that would be hidden by <code>git-receive-pack</code> or
1342 <code>git-upload-pack</code> by consulting the appropriate <code>receive.hideRefs</code> or
1343 <code>uploadpack.hideRefs</code> configuration along with <code>transfer.hideRefs</code> (see
1344 <a href="git-config.html">git-config(1)</a>). This option affects the next pseudo-ref option
1345 <code>--all</code> or <code>--glob</code> and is cleared after processing them.
1346</p>
1347</dd>
1348<dt class="hdlist1">
Junio C Hamano2a4bcbc2014-10-29 20:07:391349--reflog
1350</dt>
1351<dd>
1352<p>
1353 Pretend as if all objects mentioned by reflogs are listed on the
1354 command line as <code>&lt;commit&gt;</code>.
1355</p>
1356</dd>
1357<dt class="hdlist1">
Junio C Hamanoa42e0332019-07-19 19:49:371358--alternate-refs
1359</dt>
1360<dd>
1361<p>
1362 Pretend as if all objects mentioned as ref tips of alternate
1363 repositories were listed on the command line. An alternate
1364 repository is any repository whose object directory is specified
1365 in <code>objects/info/alternates</code>. The set of included objects may
1366 be modified by <code>core.alternateRefsCommand</code>, etc. See
1367 <a href="git-config.html">git-config(1)</a>.
1368</p>
1369</dd>
1370<dt class="hdlist1">
Junio C Hamano8d57fa92017-09-19 05:01:081371--single-worktree
1372</dt>
1373<dd>
1374<p>
1375 By default, all working trees will be examined by the
1376 following options when there are more than one (see
1377 <a href="git-worktree.html">git-worktree(1)</a>): <code>--all</code>, <code>--reflog</code> and
1378 <code>--indexed-objects</code>.
1379 This option forces them to examine the current working tree
1380 only.
1381</p>
1382</dd>
1383<dt class="hdlist1">
Junio C Hamano084228c2011-05-30 08:13:521384--ignore-missing
1385</dt>
1386<dd>
1387<p>
1388 Upon seeing an invalid object name in the input, pretend as if
1389 the bad input was not given.
1390</p>
1391</dd>
1392<dt class="hdlist1">
Junio C Hamano5706e0b2009-11-24 10:54:161393--bisect
1394</dt>
1395<dd>
1396<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511397 Pretend as if the bad bisection ref <code>refs/bisect/bad</code>
1398 was listed and as if it was followed by <code>--not</code> and the good
1399 bisection refs <code>refs/bisect/good-*</code> on the command
Junio C Hamano255163d2020-08-18 00:37:231400 line.
Junio C Hamano5706e0b2009-11-24 10:54:161401</p>
1402</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591403<dt class="hdlist1">
Junio C Hamano5706e0b2009-11-24 10:54:161404--stdin
1405</dt>
1406<dd>
1407<p>
1408 In addition to the <em>&lt;commit&gt;</em> listed on the command
Junio C Hamano92d80372016-07-13 22:00:051409 line, read them from the standard input. If a <code>--</code> separator is
Junio C Hamano5706e0b2009-11-24 10:54:161410 seen, stop reading commits and start reading paths to limit the
1411 result.
1412</p>
1413</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591414<dt class="hdlist1">
Junio C Hamano9a2fb2d2011-03-23 05:40:151415--cherry-mark
1416</dt>
1417<dd>
1418<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511419 Like <code>--cherry-pick</code> (see below) but mark equivalent commits
1420 with <code>=</code> rather than omitting them, and inequivalent ones with <code>+</code>.
Junio C Hamano9a2fb2d2011-03-23 05:40:151421</p>
1422</dd>
1423<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:001424--cherry-pick
1425</dt>
1426<dd>
1427<p>
1428 Omit any commit that introduces the same change as
Junio C Hamanob73af6c2013-12-03 22:07:111429 another commit on the &#8220;other side&#8221; when the set of
Junio C Hamano68cf15a2010-11-06 01:01:591430 commits are limited with symmetric difference.
1431</p>
Junio C Hamanoac12f0e2014-09-19 22:32:511432<div class="paragraph"><p>For example, if you have two branches, <code>A</code> and <code>B</code>, a usual way
Junio C Hamanob0e02952008-01-19 08:02:001433to list all commits on only one side of them is with
Junio C Hamanoac12f0e2014-09-19 22:32:511434<code>--left-right</code> (see the example below in the description of
1435the <code>--left-right</code> option). However, it shows the commits that were
Junio C Hamanob73af6c2013-12-03 22:07:111436cherry-picked from the other branch (for example, &#8220;3rd on b&#8221; may be
1437cherry-picked from branch A). With this option, such pairs of commits are
Junio C Hamano68cf15a2010-11-06 01:01:591438excluded from the output.</p></div>
Junio C Hamanob0e02952008-01-19 08:02:001439</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591440<dt class="hdlist1">
Junio C Hamano9a2fb2d2011-03-23 05:40:151441--left-only
1442</dt>
1443<dt class="hdlist1">
1444--right-only
1445</dt>
1446<dd>
1447<p>
Junio C Hamanocd451662016-09-13 00:54:091448 List only commits on the respective side of a symmetric difference,
Junio C Hamanoac12f0e2014-09-19 22:32:511449 i.e. only those which would be marked <code>&lt;</code> resp. <code>&gt;</code> by
1450 <code>--left-right</code>.
Junio C Hamano9a2fb2d2011-03-23 05:40:151451</p>
Junio C Hamanoac12f0e2014-09-19 22:32:511452<div class="paragraph"><p>For example, <code>--cherry-pick --right-only A...B</code> omits those
1453commits from <code>B</code> which are in <code>A</code> or are patch-equivalent to a commit in
1454<code>A</code>. In other words, this lists the <code>+</code> commits from <code>git cherry A B</code>.
1455More precisely, <code>--cherry-pick --right-only --no-merges</code> gives the exact
Junio C Hamano9a2fb2d2011-03-23 05:40:151456list.</p></div>
1457</dd>
1458<dt class="hdlist1">
1459--cherry
1460</dt>
1461<dd>
1462<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511463 A synonym for <code>--right-only --cherry-mark --no-merges</code>; useful to
Junio C Hamano9a2fb2d2011-03-23 05:40:151464 limit the output to the commits on our side and mark those that
1465 have been applied to the other side of a forked history with
Junio C Hamanoac12f0e2014-09-19 22:32:511466 <code>git log --cherry upstream...mybranch</code>, similar to
1467 <code>git cherry upstream mybranch</code>.
Junio C Hamano9a2fb2d2011-03-23 05:40:151468</p>
1469</dd>
1470<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471471-g
1472</dt>
Junio C Hamano68cf15a2010-11-06 01:01:591473<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471474--walk-reflogs
Junio C Hamanob0e02952008-01-19 08:02:001475</dt>
1476<dd>
1477<p>
1478 Instead of walking the commit ancestry chain, walk
1479 reflog entries from the most recent one to older ones.
1480 When this option is used you cannot specify commits to
1481 exclude (that is, <em>&#94;commit</em>, <em>commit1..commit2</em>,
Junio C Hamanod75148a2014-04-08 19:48:381482 and <em>commit1...commit2</em> notations cannot be used).
Junio C Hamano68cf15a2010-11-06 01:01:591483</p>
Junio C Hamanob4896852019-12-10 23:15:091484<div class="paragraph"><p>With <code>--pretty</code> format other than <code>oneline</code> and <code>reference</code> (for obvious reasons),
Junio C Hamanob0e02952008-01-19 08:02:001485this causes the output to have two extra lines of information
Junio C Hamanoe548d1b2016-08-08 22:26:491486taken from the reflog. The reflog designator in the output may be shown
1487as <code>ref@{Nth}</code> (where <code>Nth</code> is the reverse-chronological index in the
1488reflog) or as <code>ref@{timestamp}</code> (with the timestamp for that entry),
1489depending on a few rules:</p></div>
1490<div class="openblock">
1491<div class="content">
1492<div class="olist arabic"><ol class="arabic">
1493<li>
1494<p>
1495If the starting point is specified as <code>ref@{Nth}</code>, show the index
Junio C Hamano2567b322019-02-05 23:33:561496 format.
Junio C Hamanoe548d1b2016-08-08 22:26:491497</p>
1498</li>
1499<li>
1500<p>
1501If the starting point was specified as <code>ref@{now}</code>, show the
Junio C Hamano2567b322019-02-05 23:33:561502 timestamp format.
Junio C Hamanoe548d1b2016-08-08 22:26:491503</p>
1504</li>
1505<li>
1506<p>
1507If neither was used, but <code>--date</code> was given on the command line, show
Junio C Hamano2567b322019-02-05 23:33:561508 the timestamp in the format requested by <code>--date</code>.
Junio C Hamanoe548d1b2016-08-08 22:26:491509</p>
1510</li>
1511<li>
1512<p>
1513Otherwise, show the index format.
1514</p>
1515</li>
1516</ol></div>
1517</div></div>
1518<div class="paragraph"><p>Under <code>--pretty=oneline</code>, the commit message is
Junio C Hamanob0e02952008-01-19 08:02:001519prefixed with this information on the same line.
Junio C Hamanoac12f0e2014-09-19 22:32:511520This option cannot be combined with <code>--reverse</code>.
Junio C Hamanoa28a9202012-06-21 07:08:231521See also <a href="git-reflog.html">git-reflog(1)</a>.</p></div>
Junio C Hamanob4896852019-12-10 23:15:091522<div class="paragraph"><p>Under <code>--pretty=reference</code>, this information will not be shown at all.</p></div>
Junio C Hamanob0e02952008-01-19 08:02:001523</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591524<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:001525--merge
1526</dt>
1527<dd>
1528<p>
1529 After a failed merge, show refs that touch files having a
Junio C Hamano68cf15a2010-11-06 01:01:591530 conflict and don&#8217;t exist on all heads to merge.
Junio C Hamanob0e02952008-01-19 08:02:001531</p>
1532</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591533<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:001534--boundary
1535</dt>
1536<dd>
1537<p>
Junio C Hamano27159f82013-06-14 17:19:221538 Output excluded boundary commits. Boundary commits are
Junio C Hamanoac12f0e2014-09-19 22:32:511539 prefixed with <code>-</code>.
Junio C Hamanob0e02952008-01-19 08:02:001540</p>
1541</dd>
Junio C Hamanoa76cb0d2008-08-13 20:04:101542</dl></div>
Junio C Hamano9629d4f2012-12-19 00:28:271543</div>
1544<div class="sect2">
1545<h3 id="_history_simplification">History Simplification</h3>
Junio C Hamano68cf15a2010-11-06 01:01:591546<div class="paragraph"><p>Sometimes you are only interested in parts of the history, for example the
Junio C Hamano28363492008-11-14 08:26:311547commits modifying a particular &lt;path&gt;. But there are two parts of
1548<em>History Simplification</em>, one part is selecting the commits and the other
1549is how to do it, as there are various strategies to simplify the history.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591550<div class="paragraph"><p>The following options select the commits to be shown:</p></div>
1551<div class="dlist"><dl>
1552<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:311553&lt;paths&gt;
1554</dt>
1555<dd>
1556<p>
1557 Commits modifying the given &lt;paths&gt; are selected.
1558</p>
1559</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591560<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:311561--simplify-by-decoration
1562</dt>
1563<dd>
1564<p>
1565 Commits that are referred by some branch or tag are selected.
1566</p>
1567</dd>
1568</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:591569<div class="paragraph"><p>Note that extra commits can be shown to give a meaningful history.</p></div>
1570<div class="paragraph"><p>The following options affect the way the simplification is performed:</p></div>
1571<div class="dlist"><dl>
1572<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:311573Default mode
1574</dt>
1575<dd>
1576<p>
1577 Simplifies the history to the simplest history explaining the
1578 final state of the tree. Simplest because it prunes some side
1579 branches if the end result is the same (i.e. merging branches
1580 with the same content)
1581</p>
1582</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591583<dt class="hdlist1">
Junio C Hamano67bf2242020-04-22 21:41:441584--show-pulls
1585</dt>
1586<dd>
1587<p>
1588 Include all commits from the default mode, but also any merge
1589 commits that are not TREESAME to the first parent but are
1590 TREESAME to a later parent. This mode is helpful for showing
1591 the merge commits that "first introduced" a change to a branch.
1592</p>
1593</dd>
1594<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:311595--full-history
1596</dt>
1597<dd>
1598<p>
Junio C Hamano15567bc2011-07-23 00:51:591599 Same as the default mode, but does not prune some history.
Junio C Hamano28363492008-11-14 08:26:311600</p>
1601</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591602<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:311603--dense
1604</dt>
1605<dd>
1606<p>
1607 Only the selected commits are shown, plus some to have a
1608 meaningful history.
1609</p>
1610</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591611<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:311612--sparse
1613</dt>
1614<dd>
1615<p>
1616 All commits in the simplified history are shown.
1617</p>
1618</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591619<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:311620--simplify-merges
1621</dt>
1622<dd>
1623<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511624 Additional option to <code>--full-history</code> to remove some needless
Junio C Hamano28363492008-11-14 08:26:311625 merges from the resulting history, as there are no selected
1626 commits contributing to this merge.
1627</p>
1628</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591629<dt class="hdlist1">
Junio C Hamano594d2d42022-08-30 17:58:501630--ancestry-path[=&lt;commit&gt;]
Junio C Hamano89a57342010-06-22 23:22:551631</dt>
1632<dd>
1633<p>
1634 When given a range of commits to display (e.g. <em>commit1..commit2</em>
Junio C Hamano594d2d42022-08-30 17:58:501635 or <em>commit2 &#94;commit1</em>), only display commits in that range
1636 that are ancestors of &lt;commit&gt;, descendants of &lt;commit&gt;, or
1637 &lt;commit&gt; itself. If no commit is specified, use <em>commit1</em> (the
1638 excluded part of the range) as &lt;commit&gt;. Can be passed multiple
1639 times; if so, a commit is included if it is any of the commits
1640 given or if it is an ancestor or descendant of one of them.
Junio C Hamano89a57342010-06-22 23:22:551641</p>
1642</dd>
Junio C Hamano28363492008-11-14 08:26:311643</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:591644<div class="paragraph"><p>A more detailed explanation follows.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:511645<div class="paragraph"><p>Suppose you specified <code>foo</code> as the &lt;paths&gt;. We shall call commits
1646that modify <code>foo</code> !TREESAME, and the rest TREESAME. (In a diff
1647filtered for <code>foo</code>, they look different and equal, respectively.)</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591648<div class="paragraph"><p>In the following, we will always refer to the same example history to
Junio C Hamanoa76cb0d2008-08-13 20:04:101649illustrate the differences between simplification settings. We assume
Junio C Hamanoac12f0e2014-09-19 22:32:511650that you are filtering for a file <code>foo</code> in this commit graph:</p></div>
Junio C Hamanoa76cb0d2008-08-13 20:04:101651<div class="listingblock">
1652<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:511653<pre><code> .-A---M---N---O---P---Q
Junio C Hamano27159f82013-06-14 17:19:221654 / / / / / /
1655 I B C D E Y
1656 \ / / / / /
Junio C Hamanoac12f0e2014-09-19 22:32:511657 `-------------' X</code></pre>
Junio C Hamanoa76cb0d2008-08-13 20:04:101658</div></div>
Junio C Hamano27159f82013-06-14 17:19:221659<div class="paragraph"><p>The horizontal line of history A---Q is taken to be the first parent of
Junio C Hamanoa76cb0d2008-08-13 20:04:101660each merge. The commits are:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591661<div class="ulist"><ul>
Junio C Hamanoa76cb0d2008-08-13 20:04:101662<li>
1663<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511664<code>I</code> is the initial commit, in which <code>foo</code> exists with contents
1665 &#8220;asdf&#8221;, and a file <code>quux</code> exists with contents &#8220;quux&#8221;. Initial
1666 commits are compared to an empty tree, so <code>I</code> is !TREESAME.
Junio C Hamanoa76cb0d2008-08-13 20:04:101667</p>
1668</li>
1669<li>
1670<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511671In <code>A</code>, <code>foo</code> contains just &#8220;foo&#8221;.
Junio C Hamanoa76cb0d2008-08-13 20:04:101672</p>
1673</li>
1674<li>
1675<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511676<code>B</code> contains the same change as <code>A</code>. Its merge <code>M</code> is trivial and
Junio C Hamanoa76cb0d2008-08-13 20:04:101677 hence TREESAME to all parents.
1678</p>
1679</li>
1680<li>
1681<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511682<code>C</code> does not change <code>foo</code>, but its merge <code>N</code> changes it to &#8220;foobar&#8221;,
Junio C Hamanoa76cb0d2008-08-13 20:04:101683 so it is not TREESAME to any parent.
1684</p>
1685</li>
1686<li>
1687<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511688<code>D</code> sets <code>foo</code> to &#8220;baz&#8221;. Its merge <code>O</code> combines the strings from
1689 <code>N</code> and <code>D</code> to &#8220;foobarbaz&#8221;; i.e., it is not TREESAME to any parent.
Junio C Hamanoa76cb0d2008-08-13 20:04:101690</p>
1691</li>
1692<li>
1693<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511694<code>E</code> changes <code>quux</code> to &#8220;xyzzy&#8221;, and its merge <code>P</code> combines the
1695 strings to &#8220;quux xyzzy&#8221;. <code>P</code> is TREESAME to <code>O</code>, but not to <code>E</code>.
Junio C Hamano27159f82013-06-14 17:19:221696</p>
1697</li>
1698<li>
1699<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511700<code>X</code> is an independent root commit that added a new file <code>side</code>, and <code>Y</code>
1701 modified it. <code>Y</code> is TREESAME to <code>X</code>. Its merge <code>Q</code> added <code>side</code> to <code>P</code>, and
1702 <code>Q</code> is TREESAME to <code>P</code>, but not to <code>Y</code>.
Junio C Hamanoa76cb0d2008-08-13 20:04:101703</p>
1704</li>
1705</ul></div>
Junio C Hamanoac12f0e2014-09-19 22:32:511706<div class="paragraph"><p><code>rev-list</code> walks backwards through history, including or excluding
1707commits based on whether <code>--full-history</code> and/or parent rewriting
1708(via <code>--parents</code> or <code>--children</code>) are used. The following settings
Junio C Hamanoa76cb0d2008-08-13 20:04:101709are available.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591710<div class="dlist"><dl>
1711<dt class="hdlist1">
Junio C Hamanoa76cb0d2008-08-13 20:04:101712Default mode
1713</dt>
1714<dd>
1715<p>
1716 Commits are included if they are not TREESAME to any parent
Junio C Hamanoac12f0e2014-09-19 22:32:511717 (though this can be changed, see <code>--sparse</code> below). If the
Junio C Hamanoa76cb0d2008-08-13 20:04:101718 commit was a merge, and it was TREESAME to one parent, follow
1719 only that parent. (Even if there are several TREESAME
1720 parents, follow only one of them.) Otherwise, follow all
1721 parents.
1722</p>
Junio C Hamano68cf15a2010-11-06 01:01:591723<div class="paragraph"><p>This results in:</p></div>
Junio C Hamanoa76cb0d2008-08-13 20:04:101724<div class="listingblock">
1725<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:511726<pre><code> .-A---N---O
Junio C Hamano89a57342010-06-22 23:22:551727 / / /
Junio C Hamanoac12f0e2014-09-19 22:32:511728 I---------D</code></pre>
Junio C Hamanoa76cb0d2008-08-13 20:04:101729</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:591730<div class="paragraph"><p>Note how the rule to only follow the TREESAME parent, if one is
Junio C Hamanoac12f0e2014-09-19 22:32:511731available, removed <code>B</code> from consideration entirely. <code>C</code> was
1732considered via <code>N</code>, but is TREESAME. Root commits are compared to an
1733empty tree, so <code>I</code> is !TREESAME.</p></div>
1734<div class="paragraph"><p>Parent/child relations are only visible with <code>--parents</code>, but that does
Junio C Hamanoa76cb0d2008-08-13 20:04:101735not affect the commits selected in default mode, so we have shown the
1736parent lines.</p></div>
1737</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591738<dt class="hdlist1">
Junio C Hamanoa76cb0d2008-08-13 20:04:101739--full-history without parent rewriting
1740</dt>
1741<dd>
1742<p>
1743 This mode differs from the default in one point: always follow
1744 all parents of a merge, even if it is TREESAME to one of them.
1745 Even if more than one side of the merge has commits that are
1746 included, this does not imply that the merge itself is! In
1747 the example, we get
1748</p>
1749<div class="listingblock">
1750<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:511751<pre><code> I A B N D O P Q</code></pre>
Junio C Hamanoa76cb0d2008-08-13 20:04:101752</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:511753<div class="paragraph"><p><code>M</code> was excluded because it is TREESAME to both parents. <code>E</code>,
1754<code>C</code> and <code>B</code> were all walked, but only <code>B</code> was !TREESAME, so the others
Junio C Hamanoa76cb0d2008-08-13 20:04:101755do not appear.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591756<div class="paragraph"><p>Note that without parent rewriting, it is not really possible to talk
Junio C Hamanoa76cb0d2008-08-13 20:04:101757about the parent/child relationships between the commits, so we show
1758them disconnected.</p></div>
1759</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591760<dt class="hdlist1">
Junio C Hamanoa76cb0d2008-08-13 20:04:101761--full-history with parent rewriting
1762</dt>
1763<dd>
1764<p>
1765 Ordinary commits are only included if they are !TREESAME
Junio C Hamanoac12f0e2014-09-19 22:32:511766 (though this can be changed, see <code>--sparse</code> below).
Junio C Hamanoa76cb0d2008-08-13 20:04:101767</p>
Junio C Hamano68cf15a2010-11-06 01:01:591768<div class="paragraph"><p>Merges are always included. However, their parent list is rewritten:
Junio C Hamanoa76cb0d2008-08-13 20:04:101769Along each parent, prune away commits that are not included
1770themselves. This results in</p></div>
1771<div class="listingblock">
1772<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:511773<pre><code> .-A---M---N---O---P---Q
Junio C Hamanoa76cb0d2008-08-13 20:04:101774 / / / / /
1775 I B / D /
1776 \ / / / /
Junio C Hamanoac12f0e2014-09-19 22:32:511777 `-------------'</code></pre>
Junio C Hamanoa76cb0d2008-08-13 20:04:101778</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:511779<div class="paragraph"><p>Compare to <code>--full-history</code> without rewriting above. Note that <code>E</code>
Junio C Hamanoa76cb0d2008-08-13 20:04:101780was pruned away because it is TREESAME, but the parent list of P was
Junio C Hamanoac12f0e2014-09-19 22:32:511781rewritten to contain <code>E</code>'s parent <code>I</code>. The same happened for <code>C</code> and
1782<code>N</code>, and <code>X</code>, <code>Y</code> and <code>Q</code>.</p></div>
Junio C Hamanoa76cb0d2008-08-13 20:04:101783</dd>
1784</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:591785<div class="paragraph"><p>In addition to the above settings, you can change whether TREESAME
Junio C Hamanoa76cb0d2008-08-13 20:04:101786affects inclusion:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591787<div class="dlist"><dl>
1788<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471789--dense
1790</dt>
Junio C Hamanoa76cb0d2008-08-13 20:04:101791<dd>
1792<p>
1793 Commits that are walked are included if they are not TREESAME
1794 to any parent.
1795</p>
1796</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591797<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471798--sparse
Junio C Hamanob0e02952008-01-19 08:02:001799</dt>
1800<dd>
1801<p>
Junio C Hamanoa76cb0d2008-08-13 20:04:101802 All commits that are walked are included.
Junio C Hamanob0e02952008-01-19 08:02:001803</p>
Junio C Hamanoac12f0e2014-09-19 22:32:511804<div class="paragraph"><p>Note that without <code>--full-history</code>, this still simplifies merges: if
Junio C Hamanoa76cb0d2008-08-13 20:04:101805one of the parents is TREESAME, we follow only that one, so the other
1806sides of the merge are never walked.</p></div>
Junio C Hamanob0e02952008-01-19 08:02:001807</dd>
Junio C Hamano68cf15a2010-11-06 01:01:591808<dt class="hdlist1">
Junio C Hamanoa2f46622008-09-03 05:20:311809--simplify-merges
1810</dt>
1811<dd>
1812<p>
1813 First, build a history graph in the same way that
Junio C Hamanoac12f0e2014-09-19 22:32:511814 <code>--full-history</code> with parent rewriting does (see above).
Junio C Hamanoa2f46622008-09-03 05:20:311815</p>
Junio C Hamanoac12f0e2014-09-19 22:32:511816<div class="paragraph"><p>Then simplify each commit <code>C</code> to its replacement <code>C'</code> in the final
Junio C Hamanoa2f46622008-09-03 05:20:311817history according to the following rules:</p></div>
Junio C Hamano9629d4f2012-12-19 00:28:271818<div class="openblock">
1819<div class="content">
Junio C Hamano68cf15a2010-11-06 01:01:591820<div class="ulist"><ul>
Junio C Hamanoa2f46622008-09-03 05:20:311821<li>
1822<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511823Set <code>C'</code> to <code>C</code>.
Junio C Hamanoa2f46622008-09-03 05:20:311824</p>
1825</li>
1826<li>
1827<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511828Replace each parent <code>P</code> of <code>C'</code> with its simplification <code>P'</code>. In
Junio C Hamano27159f82013-06-14 17:19:221829 the process, drop parents that are ancestors of other parents or that are
1830 root commits TREESAME to an empty tree, and remove duplicates, but take care
1831 to never drop all parents that we are TREESAME to.
Junio C Hamanoa2f46622008-09-03 05:20:311832</p>
1833</li>
1834<li>
1835<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511836If after this parent rewriting, <code>C'</code> is a root or merge commit (has
Junio C Hamanoa2f46622008-09-03 05:20:311837 zero or &gt;1 parents), a boundary commit, or !TREESAME, it remains.
1838 Otherwise, it is replaced with its only parent.
1839</p>
1840</li>
1841</ul></div>
Junio C Hamano9629d4f2012-12-19 00:28:271842</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:591843<div class="paragraph"><p>The effect of this is best shown by way of comparing to
Junio C Hamanoac12f0e2014-09-19 22:32:511844<code>--full-history</code> with parent rewriting. The example turns into:</p></div>
Junio C Hamanoa2f46622008-09-03 05:20:311845<div class="listingblock">
1846<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:511847<pre><code> .-A---M---N---O
Junio C Hamanoa2f46622008-09-03 05:20:311848 / / /
1849 I B D
1850 \ / /
Junio C Hamanoac12f0e2014-09-19 22:32:511851 `---------'</code></pre>
Junio C Hamanoa2f46622008-09-03 05:20:311852</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:511853<div class="paragraph"><p>Note the major differences in <code>N</code>, <code>P</code>, and <code>Q</code> over <code>--full-history</code>:</p></div>
Junio C Hamano9629d4f2012-12-19 00:28:271854<div class="openblock">
1855<div class="content">
Junio C Hamano68cf15a2010-11-06 01:01:591856<div class="ulist"><ul>
Junio C Hamanoa2f46622008-09-03 05:20:311857<li>
1858<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511859<code>N</code>'s parent list had <code>I</code> removed, because it is an ancestor of the
1860 other parent <code>M</code>. Still, <code>N</code> remained because it is !TREESAME.
Junio C Hamanoa2f46622008-09-03 05:20:311861</p>
1862</li>
1863<li>
1864<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511865<code>P</code>'s parent list similarly had <code>I</code> removed. <code>P</code> was then
Junio C Hamanoa2f46622008-09-03 05:20:311866 removed completely, because it had one parent and is TREESAME.
1867</p>
1868</li>
Junio C Hamano27159f82013-06-14 17:19:221869<li>
1870<p>
Junio C Hamanoac12f0e2014-09-19 22:32:511871<code>Q</code>'s parent list had <code>Y</code> simplified to <code>X</code>. <code>X</code> was then removed, because it
1872 was a TREESAME root. <code>Q</code> was then removed completely, because it had one
Junio C Hamano27159f82013-06-14 17:19:221873 parent and is TREESAME.
1874</p>
1875</li>
Junio C Hamanoa2f46622008-09-03 05:20:311876</ul></div>
Junio C Hamano9629d4f2012-12-19 00:28:271877</div></div>
Junio C Hamanoa2f46622008-09-03 05:20:311878</dd>
1879</dl></div>
Junio C Hamano67bf2242020-04-22 21:41:441880<div class="paragraph"><p>There is another simplification mode available:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:591881<div class="dlist"><dl>
1882<dt class="hdlist1">
Junio C Hamano594d2d42022-08-30 17:58:501883--ancestry-path[=&lt;commit&gt;]
Junio C Hamano89a57342010-06-22 23:22:551884</dt>
1885<dd>
1886<p>
Junio C Hamano594d2d42022-08-30 17:58:501887 Limit the displayed commits to those which are an ancestor of
1888 &lt;commit&gt;, or which are a descendant of &lt;commit&gt;, or are &lt;commit&gt;
1889 itself.
Junio C Hamano89a57342010-06-22 23:22:551890</p>
Junio C Hamano68cf15a2010-11-06 01:01:591891<div class="paragraph"><p>As an example use case, consider the following commit history:</p></div>
Junio C Hamano89a57342010-06-22 23:22:551892<div class="listingblock">
1893<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:511894<pre><code> D---E-------F
Junio C Hamano89a57342010-06-22 23:22:551895 / \ \
1896 B---C---G---H---I---J
1897 / \
Junio C Hamanoac12f0e2014-09-19 22:32:511898 A-------K---------------L--M</code></pre>
Junio C Hamano89a57342010-06-22 23:22:551899</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:511900<div class="paragraph"><p>A regular <em>D..M</em> computes the set of commits that are ancestors of <code>M</code>,
1901but excludes the ones that are ancestors of <code>D</code>. This is useful to see
1902what happened to the history leading to <code>M</code> since <code>D</code>, in the sense
1903that &#8220;what does <code>M</code> have that did not exist in <code>D</code>&#8221;. The result in this
1904example would be all the commits, except <code>A</code> and <code>B</code> (and <code>D</code> itself,
Junio C Hamano89a57342010-06-22 23:22:551905of course).</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:511906<div class="paragraph"><p>When we want to find out what commits in <code>M</code> are contaminated with the
1907bug introduced by <code>D</code> and need fixing, however, we might want to view
1908only the subset of <em>D..M</em> that are actually descendants of <code>D</code>, i.e.
1909excluding <code>C</code> and <code>K</code>. This is exactly what the <code>--ancestry-path</code>
Junio C Hamano89a57342010-06-22 23:22:551910option does. Applied to the <em>D..M</em> range, it results in:</p></div>
1911<div class="listingblock">
1912<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:511913<pre><code> E-------F
Junio C Hamano89a57342010-06-22 23:22:551914 \ \
1915 G---H---I---J
1916 \
Junio C Hamanoac12f0e2014-09-19 22:32:511917 L--M</code></pre>
Junio C Hamano89a57342010-06-22 23:22:551918</div></div>
Junio C Hamano594d2d42022-08-30 17:58:501919<div class="paragraph"><p>We can also use <code>--ancestry-path=D</code> instead of <code>--ancestry-path</code> which
1920means the same thing when applied to the <em>D..M</em> range but is just more
1921explicit.</p></div>
1922<div class="paragraph"><p>If we instead are interested in a given topic within this range, and all
1923commits affected by that topic, we may only want to view the subset of
1924<code>D..M</code> which contain that topic in their ancestry path. So, using
1925<code>--ancestry-path=H D..M</code> for example would result in:</p></div>
1926<div class="listingblock">
1927<div class="content">
1928<pre><code> E
1929 \
1930 G---H---I---J
1931 \
1932 L--M</code></pre>
1933</div></div>
1934<div class="paragraph"><p>Whereas <code>--ancestry-path=K D..M</code> would result in</p></div>
1935<div class="listingblock">
1936<div class="content">
1937<pre><code> K---------------L--M</code></pre>
1938</div></div>
Junio C Hamano89a57342010-06-22 23:22:551939</dd>
1940</dl></div>
Junio C Hamano67bf2242020-04-22 21:41:441941<div class="paragraph"><p>Before discussing another option, <code>--show-pulls</code>, we need to
1942create a new example history.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:391943<div class="paragraph"><p>A common problem users face when looking at simplified history is that a
Junio C Hamano67bf2242020-04-22 21:41:441944commit they know changed a file somehow does not appear in the file&#8217;s
1945simplified history. Let&#8217;s demonstrate a new example and show how options
1946such as <code>--full-history</code> and <code>--simplify-merges</code> works in that case:</p></div>
Junio C Hamano67bf2242020-04-22 21:41:441947<div class="listingblock">
1948<div class="content">
1949<pre><code> .-A---M-----C--N---O---P
1950 / / \ \ \/ / /
1951 I B \ R-'`-Z' /
1952 \ / \/ /
1953 \ / /\ /
1954 `---X--' `---Y--'</code></pre>
1955</div></div>
Junio C Hamano0cb719f2020-05-31 20:04:391956<div class="paragraph"><p>For this example, suppose <code>I</code> created <code>file.txt</code> which was modified by
Junio C Hamano67bf2242020-04-22 21:41:441957<code>A</code>, <code>B</code>, and <code>X</code> in different ways. The single-parent commits <code>C</code>, <code>Z</code>,
1958and <code>Y</code> do not change <code>file.txt</code>. The merge commit <code>M</code> was created by
1959resolving the merge conflict to include both changes from <code>A</code> and <code>B</code>
1960and hence is not TREESAME to either. The merge commit <code>R</code>, however, was
1961created by ignoring the contents of <code>file.txt</code> at <code>M</code> and taking only
1962the contents of <code>file.txt</code> at <code>X</code>. Hence, <code>R</code> is TREESAME to <code>X</code> but not
1963<code>M</code>. Finally, the natural merge resolution to create <code>N</code> is to take the
1964contents of <code>file.txt</code> at <code>R</code>, so <code>N</code> is TREESAME to <code>R</code> but not <code>C</code>.
1965The merge commits <code>O</code> and <code>P</code> are TREESAME to their first parents, but
1966not to their second parents, <code>Z</code> and <code>Y</code> respectively.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:391967<div class="paragraph"><p>When using the default mode, <code>N</code> and <code>R</code> both have a TREESAME parent, so
Junio C Hamano67bf2242020-04-22 21:41:441968those edges are walked and the others are ignored. The resulting history
1969graph is:</p></div>
Junio C Hamano67bf2242020-04-22 21:41:441970<div class="listingblock">
1971<div class="content">
1972<pre><code> I---X</code></pre>
1973</div></div>
Junio C Hamano0cb719f2020-05-31 20:04:391974<div class="paragraph"><p>When using <code>--full-history</code>, Git walks every edge. This will discover
Junio C Hamano67bf2242020-04-22 21:41:441975the commits <code>A</code> and <code>B</code> and the merge <code>M</code>, but also will reveal the
1976merge commits <code>O</code> and <code>P</code>. With parent rewriting, the resulting graph is:</p></div>
Junio C Hamano67bf2242020-04-22 21:41:441977<div class="listingblock">
1978<div class="content">
1979<pre><code> .-A---M--------N---O---P
1980 / / \ \ \/ / /
1981 I B \ R-'`--' /
1982 \ / \/ /
1983 \ / /\ /
1984 `---X--' `------'</code></pre>
1985</div></div>
Junio C Hamano0cb719f2020-05-31 20:04:391986<div class="paragraph"><p>Here, the merge commits <code>O</code> and <code>P</code> contribute extra noise, as they did
Junio C Hamano67bf2242020-04-22 21:41:441987not actually contribute a change to <code>file.txt</code>. They only merged a topic
1988that was based on an older version of <code>file.txt</code>. This is a common
1989issue in repositories using a workflow where many contributors work in
Junio C Hamano594d2d42022-08-30 17:58:501990parallel and merge their topic branches along a single trunk: many
Junio C Hamano67bf2242020-04-22 21:41:441991unrelated merges appear in the <code>--full-history</code> results.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:391992<div class="paragraph"><p>When using the <code>--simplify-merges</code> option, the commits <code>O</code> and <code>P</code>
Junio C Hamano67bf2242020-04-22 21:41:441993disappear from the results. This is because the rewritten second parents
1994of <code>O</code> and <code>P</code> are reachable from their first parents. Those edges are
1995removed and then the commits look like single-parent commits that are
1996TREESAME to their parent. This also happens to the commit <code>N</code>, resulting
1997in a history view as follows:</p></div>
Junio C Hamano67bf2242020-04-22 21:41:441998<div class="listingblock">
1999<div class="content">
2000<pre><code> .-A---M--.
2001 / / \
2002 I B R
2003 \ / /
2004 \ / /
2005 `---X--'</code></pre>
2006</div></div>
Junio C Hamano0cb719f2020-05-31 20:04:392007<div class="paragraph"><p>In this view, we see all of the important single-parent changes from
Junio C Hamano67bf2242020-04-22 21:41:442008<code>A</code>, <code>B</code>, and <code>X</code>. We also see the carefully-resolved merge <code>M</code> and the
2009not-so-carefully-resolved merge <code>R</code>. This is usually enough information
2010to determine why the commits <code>A</code> and <code>B</code> "disappeared" from history in
2011the default view. However, there are a few issues with this approach.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:392012<div class="paragraph"><p>The first issue is performance. Unlike any previous option, the
Junio C Hamano67bf2242020-04-22 21:41:442013<code>--simplify-merges</code> option requires walking the entire commit history
2014before returning a single result. This can make the option difficult to
2015use for very large repositories.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:392016<div class="paragraph"><p>The second issue is one of auditing. When many contributors are working
Junio C Hamano67bf2242020-04-22 21:41:442017on the same repository, it is important which merge commits introduced
2018a change into an important branch. The problematic merge <code>R</code> above is
2019not likely to be the merge commit that was used to merge into an
2020important branch. Instead, the merge <code>N</code> was used to merge <code>R</code> and <code>X</code>
2021into the important branch. This commit may have information about why
2022the change <code>X</code> came to override the changes from <code>A</code> and <code>B</code> in its
2023commit message.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:392024<div class="dlist"><dl>
2025<dt class="hdlist1">
2026--show-pulls
2027</dt>
2028<dd>
2029<p>
2030 In addition to the commits shown in the default history, show
2031 each merge commit that is not TREESAME to its first parent but
2032 is TREESAME to a later parent.
2033</p>
2034<div class="paragraph"><p>When a merge commit is included by <code>--show-pulls</code>, the merge is
Junio C Hamano67bf2242020-04-22 21:41:442035treated as if it "pulled" the change from another branch. When using
2036<code>--show-pulls</code> on this example (and no other options) the resulting
2037graph is:</p></div>
Junio C Hamano67bf2242020-04-22 21:41:442038<div class="listingblock">
2039<div class="content">
2040<pre><code> I---X---R---N</code></pre>
2041</div></div>
Junio C Hamano0cb719f2020-05-31 20:04:392042<div class="paragraph"><p>Here, the merge commits <code>R</code> and <code>N</code> are included because they pulled
Junio C Hamano67bf2242020-04-22 21:41:442043the commits <code>X</code> and <code>R</code> into the base branch, respectively. These
2044merges are the reason the commits <code>A</code> and <code>B</code> do not appear in the
2045default history.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:392046<div class="paragraph"><p>When <code>--show-pulls</code> is paired with <code>--simplify-merges</code>, the
Junio C Hamano67bf2242020-04-22 21:41:442047graph includes all of the necessary information:</p></div>
Junio C Hamano67bf2242020-04-22 21:41:442048<div class="listingblock">
2049<div class="content">
2050<pre><code> .-A---M--. N
2051 / / \ /
2052 I B R
2053 \ / /
2054 \ / /
2055 `---X--'</code></pre>
2056</div></div>
Junio C Hamano0cb719f2020-05-31 20:04:392057<div class="paragraph"><p>Notice that since <code>M</code> is reachable from <code>R</code>, the edge from <code>N</code> to <code>M</code>
Junio C Hamano67bf2242020-04-22 21:41:442058was simplified away. However, <code>N</code> still appears in the history as an
2059important commit because it "pulled" the change <code>R</code> into the main
2060branch.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:392061</dd>
2062</dl></div>
Junio C Hamanoac12f0e2014-09-19 22:32:512063<div class="paragraph"><p>The <code>--simplify-by-decoration</code> option allows you to view only the
Junio C Hamano28363492008-11-14 08:26:312064big picture of the topology of the history, by omitting commits
2065that are not referenced by tags. Commits are marked as !TREESAME
2066(in other words, kept after history simplification rules described
2067above) if (1) they are referenced by tags, or (2) they change the
2068contents of the paths given on the command line. All other
2069commits are marked as TREESAME (subject to be simplified away).</p></div>
Junio C Hamano9629d4f2012-12-19 00:28:272070</div>
2071<div class="sect2">
2072<h3 id="_commit_ordering">Commit Ordering</h3>
Junio C Hamano68cf15a2010-11-06 01:01:592073<div class="paragraph"><p>By default, the commits are shown in reverse chronological order.</p></div>
2074<div class="dlist"><dl>
2075<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:002076--date-order
2077</dt>
2078<dd>
2079<p>
Junio C Hamanod0316112012-08-22 19:55:292080 Show no parents before all of its children are shown, but
2081 otherwise show commits in the commit timestamp order.
Junio C Hamanob0e02952008-01-19 08:02:002082</p>
2083</dd>
Junio C Hamano68cf15a2010-11-06 01:01:592084<dt class="hdlist1">
Junio C Hamanoa1952302013-07-01 21:31:182085--author-date-order
2086</dt>
2087<dd>
2088<p>
2089 Show no parents before all of its children are shown, but
2090 otherwise show commits in the author timestamp order.
2091</p>
2092</dd>
2093<dt class="hdlist1">
Junio C Hamanod0316112012-08-22 19:55:292094--topo-order
2095</dt>
2096<dd>
2097<p>
2098 Show no parents before all of its children are shown, and
2099 avoid showing commits on multiple lines of history
2100 intermixed.
2101</p>
2102<div class="paragraph"><p>For example, in a commit history like this:</p></div>
2103<div class="listingblock">
2104<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:512105<pre><code> ---1----2----4----7
Junio C Hamanod0316112012-08-22 19:55:292106 \ \
Junio C Hamanoac12f0e2014-09-19 22:32:512107 3----5----6----8---</code></pre>
Junio C Hamanod0316112012-08-22 19:55:292108</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:512109<div class="paragraph"><p>where the numbers denote the order of commit timestamps, <code>git
2110rev-list</code> and friends with <code>--date-order</code> show the commits in the
Junio C Hamanod0316112012-08-22 19:55:292111timestamp order: 8 7 6 5 4 3 2 1.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:512112<div class="paragraph"><p>With <code>--topo-order</code>, they would show 8 6 5 3 7 4 2 1 (or 8 7 4 2 6 5
Junio C Hamanod0316112012-08-22 19:55:2921133 1); some older commits are shown before newer ones in order to
2114avoid showing the commits from two parallel development track mixed
2115together.</p></div>
2116</dd>
2117<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:002118--reverse
2119</dt>
2120<dd>
2121<p>
Junio C Hamanof3ca7b82016-10-03 22:27:022122 Output the commits chosen to be shown (see Commit Limiting
2123 section above) in reverse order. Cannot be combined with
2124 <code>--walk-reflogs</code>.
Junio C Hamanob0e02952008-01-19 08:02:002125</p>
2126</dd>
Junio C Hamanoba4b9282008-07-06 05:20:312127</dl></div>
Junio C Hamano9629d4f2012-12-19 00:28:272128</div>
2129<div class="sect2">
2130<h3 id="_object_traversal">Object Traversal</h3>
Junio C Hamano076ffcc2013-02-06 05:13:212131<div class="paragraph"><p>These options are mostly targeted for packing of Git repositories.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:592132<div class="dlist"><dl>
2133<dt class="hdlist1">
Junio C Hamanoeccdd4a2012-09-10 23:28:172134--no-walk[=(sorted|unsorted)]
Junio C Hamanob0e02952008-01-19 08:02:002135</dt>
2136<dd>
2137<p>
Junio C Hamanoeccdd4a2012-09-10 23:28:172138 Only show the given commits, but do not traverse their ancestors.
2139 This has no effect if a range is specified. If the argument
Junio C Hamanoac12f0e2014-09-19 22:32:512140 <code>unsorted</code> is given, the commits are shown in the order they were
2141 given on the command line. Otherwise (if <code>sorted</code> or no argument
Junio C Hamanob73af6c2013-12-03 22:07:112142 was given), the commits are shown in reverse chronological order
Junio C Hamanoeccdd4a2012-09-10 23:28:172143 by commit time.
Junio C Hamanoe8fdbbb2021-11-12 23:42:032144 Cannot be combined with <code>--graph</code>.
Junio C Hamanob0e02952008-01-19 08:02:002145</p>
2146</dd>
Junio C Hamano68cf15a2010-11-06 01:01:592147<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:002148--do-walk
2149</dt>
2150<dd>
2151<p>
Junio C Hamanoac12f0e2014-09-19 22:32:512152 Overrides a previous <code>--no-walk</code>.
Junio C Hamanob0e02952008-01-19 08:02:002153</p>
2154</dd>
Junio C Hamanoba4b9282008-07-06 05:20:312155</dl></div>
Junio C Hamano9629d4f2012-12-19 00:28:272156</div>
2157<div class="sect2">
2158<h3 id="_commit_formatting">Commit Formatting</h3>
Junio C Hamanod2c978f2011-03-20 19:42:222159<div class="dlist"><dl>
2160<dt class="hdlist1">
2161--pretty[=&lt;format&gt;]
2162</dt>
2163<dt class="hdlist1">
2164--format=&lt;format&gt;
2165</dt>
2166<dd>
2167<p>
2168 Pretty-print the contents of the commit logs in a given format,
2169 where <em>&lt;format&gt;</em> can be one of <em>oneline</em>, <em>short</em>, <em>medium</em>,
Junio C Hamanob4896852019-12-10 23:15:092170 <em>full</em>, <em>fuller</em>, <em>reference</em>, <em>email</em>, <em>raw</em>, <em>format:&lt;string&gt;</em>
Junio C Hamano6bb32e62015-02-17 22:11:262171 and <em>tformat:&lt;string&gt;</em>. When <em>&lt;format&gt;</em> is none of the above,
2172 and has <em>%placeholder</em> in it, it acts as if
2173 <em>--pretty=tformat:&lt;format&gt;</em> were given.
Junio C Hamanod2c978f2011-03-20 19:42:222174</p>
Junio C Hamano6bb32e62015-02-17 22:11:262175<div class="paragraph"><p>See the "PRETTY FORMATS" section for some additional details for each
2176format. When <em>=&lt;format&gt;</em> part is omitted, it defaults to <em>medium</em>.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:222177<div class="paragraph"><p>Note: you can specify the default pretty format in the repository
Junio C Hamanoa28a9202012-06-21 07:08:232178configuration (see <a href="git-config.html">git-config(1)</a>).</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:222179</dd>
2180<dt class="hdlist1">
2181--abbrev-commit
2182</dt>
2183<dd>
2184<p>
2185 Instead of showing the full 40-byte hexadecimal commit object
Junio C Hamanoee43d182020-11-11 22:10:412186 name, show a prefix that names the object uniquely.
2187 "--abbrev=&lt;n&gt;" (which also modifies diff output, if it is displayed)
2188 option can be used to specify the minimum length of the prefix.
Junio C Hamanod2c978f2011-03-20 19:42:222189</p>
2190<div class="paragraph"><p>This should make "--pretty=oneline" a whole lot more readable for
2191people using 80-column terminals.</p></div>
2192</dd>
2193<dt class="hdlist1">
Junio C Hamanof93530e2011-05-25 23:59:592194--no-abbrev-commit
2195</dt>
2196<dd>
2197<p>
2198 Show the full 40-byte hexadecimal commit object name. This negates
Junio C Hamano558abd22020-09-03 20:22:342199 <code>--abbrev-commit</code>, either explicit or implied by other options such
2200 as "--oneline". It also overrides the <code>log.abbrevCommit</code> variable.
Junio C Hamanof93530e2011-05-25 23:59:592201</p>
2202</dd>
2203<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:222204--oneline
2205</dt>
2206<dd>
2207<p>
2208 This is a shorthand for "--pretty=oneline --abbrev-commit"
2209 used together.
2210</p>
2211</dd>
2212<dt class="hdlist1">
Junio C Hamanoc5bb3b32013-08-05 22:43:362213--encoding=&lt;encoding&gt;
Junio C Hamanod2c978f2011-03-20 19:42:222214</dt>
2215<dd>
2216<p>
Junio C Hamano7d6f46e2021-09-10 19:54:212217 Commit objects record the character encoding used for the log message
Junio C Hamanod2c978f2011-03-20 19:42:222218 in their encoding header; this option can be used to tell the
2219 command to re-code the commit log message in the encoding
2220 preferred by the user. For non plumbing commands this
Junio C Hamano823eebb2015-07-10 22:29:342221 defaults to UTF-8. Note that if an object claims to be encoded
2222 in <code>X</code> and we are outputting in <code>X</code>, we will output the object
2223 verbatim; this means that invalid sequences in the original
Junio C Hamano7d6f46e2021-09-10 19:54:212224 commit may be copied to the output. Likewise, if iconv(3) fails
Junio C Hamano19dcd3f2021-10-29 23:20:472225 to convert the commit, we will quietly output the original
2226 object verbatim.
Junio C Hamanod2c978f2011-03-20 19:42:222227</p>
2228</dd>
2229<dt class="hdlist1">
Junio C Hamano5996b672016-04-13 22:01:412230--expand-tabs=&lt;n&gt;
2231</dt>
2232<dt class="hdlist1">
2233--expand-tabs
2234</dt>
2235<dt class="hdlist1">
2236--no-expand-tabs
2237</dt>
2238<dd>
2239<p>
2240 Perform a tab expansion (replace each tab with enough spaces
2241 to fill to the next display column that is multiple of <em>&lt;n&gt;</em>)
2242 in the log message before showing it in the output.
2243 <code>--expand-tabs</code> is a short-hand for <code>--expand-tabs=8</code>, and
2244 <code>--no-expand-tabs</code> is a short-hand for <code>--expand-tabs=0</code>,
2245 which disables tab expansion.
2246</p>
2247<div class="paragraph"><p>By default, tabs are expanded in pretty formats that indent the log
2248message by 4 spaces (i.e. <em>medium</em>, which is the default, <em>full</em>,
2249and <em>fuller</em>).</p></div>
2250</dd>
2251<dt class="hdlist1">
Junio C Hamanob3f862c2019-12-05 22:22:002252--notes[=&lt;ref&gt;]
Junio C Hamanod2c978f2011-03-20 19:42:222253</dt>
2254<dd>
2255<p>
Junio C Hamanoa28a9202012-06-21 07:08:232256 Show the notes (see <a href="git-notes.html">git-notes(1)</a>) that annotate the
Junio C Hamanod2c978f2011-03-20 19:42:222257 commit, when showing the commit log message. This is the default
Junio C Hamanoac12f0e2014-09-19 22:32:512258 for <code>git log</code>, <code>git show</code> and <code>git whatchanged</code> commands when
2259 there is no <code>--pretty</code>, <code>--format</code>, or <code>--oneline</code> option given
Junio C Hamano60033462011-05-03 00:48:432260 on the command line.
Junio C Hamanod2c978f2011-03-20 19:42:222261</p>
Junio C Hamano60033462011-05-03 00:48:432262<div class="paragraph"><p>By default, the notes shown are from the notes refs listed in the
Junio C Hamano042f2142016-06-27 18:05:052263<code>core.notesRef</code> and <code>notes.displayRef</code> variables (or corresponding
Junio C Hamanoa28a9202012-06-21 07:08:232264environment overrides). See <a href="git-config.html">git-config(1)</a> for more details.</p></div>
Junio C Hamanob3f862c2019-12-05 22:22:002265<div class="paragraph"><p>With an optional <em>&lt;ref&gt;</em> argument, use the ref to find the notes
2266to display. The ref can specify the full refname when it begins
Junio C Hamano1f7c4a52015-10-14 22:15:512267with <code>refs/notes/</code>; when it begins with <code>notes/</code>, <code>refs/</code> and otherwise
2268<code>refs/notes/</code> is prefixed to form a full name of the ref.</p></div>
Junio C Hamano60033462011-05-03 00:48:432269<div class="paragraph"><p>Multiple --notes options can be combined to control which notes are
2270being displayed. Examples: "--notes=foo" will show only notes from
2271"refs/notes/foo"; "--notes=foo --notes" will show both notes from
2272"refs/notes/foo" and from the default notes ref(s).</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:222273</dd>
2274<dt class="hdlist1">
Junio C Hamano60033462011-05-03 00:48:432275--no-notes
2276</dt>
2277<dd>
2278<p>
Junio C Hamanoac12f0e2014-09-19 22:32:512279 Do not show notes. This negates the above <code>--notes</code> option, by
Junio C Hamano60033462011-05-03 00:48:432280 resetting the list of notes refs from which notes are shown.
2281 Options are parsed in the order given on the command line, so e.g.
2282 "--notes --notes=foo --no-notes --notes=bar" will only show notes
2283 from "refs/notes/bar".
2284</p>
2285</dd>
2286<dt class="hdlist1">
Junio C Hamanob3f862c2019-12-05 22:22:002287--show-notes[=&lt;ref&gt;]
Junio C Hamano60033462011-05-03 00:48:432288</dt>
2289<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:222290--[no-]standard-notes
2291</dt>
2292<dd>
2293<p>
Junio C Hamano60033462011-05-03 00:48:432294 These options are deprecated. Use the above --notes/--no-notes
2295 options instead.
Junio C Hamanod2c978f2011-03-20 19:42:222296</p>
2297</dd>
2298<dt class="hdlist1">
Junio C Hamano0acb1ae2012-09-24 21:28:132299--show-signature
2300</dt>
2301<dd>
2302<p>
2303 Check the validity of a signed commit object by passing the signature
Junio C Hamanoac12f0e2014-09-19 22:32:512304 to <code>gpg --verify</code> and show the output.
Junio C Hamano0acb1ae2012-09-24 21:28:132305</p>
2306</dd>
2307<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:222308--relative-date
2309</dt>
2310<dd>
2311<p>
Junio C Hamanoac12f0e2014-09-19 22:32:512312 Synonym for <code>--date=relative</code>.
Junio C Hamanod2c978f2011-03-20 19:42:222313</p>
2314</dd>
2315<dt class="hdlist1">
Junio C Hamano1eb56092015-10-05 20:39:532316--date=&lt;format&gt;
Junio C Hamanod2c978f2011-03-20 19:42:222317</dt>
2318<dd>
2319<p>
2320 Only takes effect for dates shown in human-readable format, such
Junio C Hamanoac12f0e2014-09-19 22:32:512321 as when using <code>--pretty</code>. <code>log.date</code> config variable sets a default
Junio C Hamano1eb56092015-10-05 20:39:532322 value for the log command&#8217;s <code>--date</code> option. By default, dates
2323 are shown in the original time zone (either committer&#8217;s or
2324 author&#8217;s). If <code>-local</code> is appended to the format (e.g.,
2325 <code>iso-local</code>), the user&#8217;s local time zone is used instead.
Junio C Hamanod2c978f2011-03-20 19:42:222326</p>
Junio C Hamanob5513772019-04-22 03:38:392327<div class="openblock">
2328<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:512329<div class="paragraph"><p><code>--date=relative</code> shows dates relative to the current time,
Junio C Hamanoe548d1b2016-08-08 22:26:492330e.g. &#8220;2 hours ago&#8221;. The <code>-local</code> option has no effect for
2331<code>--date=relative</code>.</p></div>
Junio C Hamano1eb56092015-10-05 20:39:532332<div class="paragraph"><p><code>--date=local</code> is an alias for <code>--date=default-local</code>.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:512333<div class="paragraph"><p><code>--date=iso</code> (or <code>--date=iso8601</code>) shows timestamps in a ISO 8601-like format.
2334The differences to the strict ISO 8601 format are:</p></div>
2335<div class="ulist"><ul>
2336<li>
2337<p>
2338a space instead of the <code>T</code> date/time delimiter
2339</p>
2340</li>
2341<li>
2342<p>
2343a space between time and time zone
2344</p>
2345</li>
2346<li>
2347<p>
2348no colon between hours and minutes of the time zone
2349</p>
2350</li>
2351</ul></div>
2352<div class="paragraph"><p><code>--date=iso-strict</code> (or <code>--date=iso8601-strict</code>) shows timestamps in strict
2353ISO 8601 format.</p></div>
2354<div class="paragraph"><p><code>--date=rfc</code> (or <code>--date=rfc2822</code>) shows timestamps in RFC 2822
Junio C Hamanob73af6c2013-12-03 22:07:112355format, often found in email messages.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:512356<div class="paragraph"><p><code>--date=short</code> shows only the date, but not the time, in <code>YYYY-MM-DD</code> format.</p></div>
Junio C Hamanoe548d1b2016-08-08 22:26:492357<div class="paragraph"><p><code>--date=raw</code> shows the date as seconds since the epoch (1970-01-01
235800:00:00 UTC), followed by a space, and then the timezone as an offset
2359from UTC (a <code>+</code> or <code>-</code> with four digits; the first two are hours, and
2360the second two are minutes). I.e., as if the timestamp were formatted
2361with <code>strftime("%s %z")</code>).
2362Note that the <code>-local</code> option does not affect the seconds-since-epoch
2363value (which is always measured in UTC), but does switch the accompanying
2364timezone value.</p></div>
Junio C Hamano23168ef2019-02-07 07:20:472365<div class="paragraph"><p><code>--date=human</code> shows the timezone if the timezone does not match the
2366current time-zone, and doesn&#8217;t print the whole date if that matches
2367(ie skip printing year for dates that are "this year", but also skip
2368the whole date itself if it&#8217;s in the last few days and we can just say
2369what weekday it was). For older dates the hour and minute is also
2370omitted.</p></div>
Junio C Hamanoe548d1b2016-08-08 22:26:492371<div class="paragraph"><p><code>--date=unix</code> shows the date as a Unix epoch timestamp (seconds since
23721970). As with <code>--raw</code>, this is always in UTC and therefore <code>-local</code>
2373has no effect.</p></div>
Junio C Hamano55d91912017-06-22 22:32:462374<div class="paragraph"><p><code>--date=format:...</code> feeds the format <code>...</code> to your system <code>strftime</code>,
Junio C Hamano59a32b02021-12-10 22:53:382375except for %s, %z, and %Z, which are handled internally.
Junio C Hamanod7ed4042015-08-03 19:43:002376Use <code>--date=format:%c</code> to show the date in your system locale&#8217;s
2377preferred format. See the <code>strftime</code> manual for a complete list of
Junio C Hamano1eb56092015-10-05 20:39:532378format placeholders. When using <code>-local</code>, the correct syntax is
2379<code>--date=format-local:...</code>.</p></div>
2380<div class="paragraph"><p><code>--date=default</code> is the default format, and is similar to
2381<code>--date=rfc2822</code>, with a few exceptions:</p></div>
Junio C Hamanob5513772019-04-22 03:38:392382</div></div>
Junio C Hamano1eb56092015-10-05 20:39:532383<div class="ulist"><ul>
2384<li>
2385<p>
2386there is no comma after the day-of-week
2387</p>
2388</li>
2389<li>
2390<p>
2391the time zone is omitted when the local time zone is used
2392</p>
2393</li>
2394</ul></div>
Junio C Hamanod2c978f2011-03-20 19:42:222395</dd>
2396<dt class="hdlist1">
2397--parents
2398</dt>
2399<dd>
2400<p>
2401 Print also the parents of the commit (in the form "commit parent&#8230;").
Junio C Hamanoce019c02017-10-30 05:57:462402 Also enables parent rewriting, see <em>History Simplification</em> above.
Junio C Hamanod2c978f2011-03-20 19:42:222403</p>
2404</dd>
2405<dt class="hdlist1">
2406--children
2407</dt>
2408<dd>
2409<p>
2410 Print also the children of the commit (in the form "commit child&#8230;").
Junio C Hamanoce019c02017-10-30 05:57:462411 Also enables parent rewriting, see <em>History Simplification</em> above.
Junio C Hamanod2c978f2011-03-20 19:42:222412</p>
2413</dd>
2414<dt class="hdlist1">
2415--left-right
2416</dt>
2417<dd>
2418<p>
Junio C Hamanocd451662016-09-13 00:54:092419 Mark which side of a symmetric difference a commit is reachable from.
Junio C Hamanoac12f0e2014-09-19 22:32:512420 Commits from the left side are prefixed with <code>&lt;</code> and those from
2421 the right with <code>&gt;</code>. If combined with <code>--boundary</code>, those
2422 commits are prefixed with <code>-</code>.
Junio C Hamanod2c978f2011-03-20 19:42:222423</p>
2424<div class="paragraph"><p>For example, if you have this topology:</p></div>
2425<div class="listingblock">
2426<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:512427<pre><code> y---b---b branch B
Junio C Hamanod2c978f2011-03-20 19:42:222428 / \ /
2429 / .
2430 / / \
Junio C Hamanoac12f0e2014-09-19 22:32:512431 o---x---a---a branch A</code></pre>
Junio C Hamanod2c978f2011-03-20 19:42:222432</div></div>
2433<div class="paragraph"><p>you would get an output like this:</p></div>
2434<div class="listingblock">
2435<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:512436<pre><code> $ git rev-list --left-right --boundary --pretty=oneline A...B
Junio C Hamanod2c978f2011-03-20 19:42:222437
2438 &gt;bbbbbbb... 3rd on b
2439 &gt;bbbbbbb... 2nd on b
2440 &lt;aaaaaaa... 3rd on a
2441 &lt;aaaaaaa... 2nd on a
2442 -yyyyyyy... 1st on b
Junio C Hamanoac12f0e2014-09-19 22:32:512443 -xxxxxxx... 1st on a</code></pre>
Junio C Hamanod2c978f2011-03-20 19:42:222444</div></div>
2445</dd>
2446<dt class="hdlist1">
2447--graph
2448</dt>
2449<dd>
2450<p>
2451 Draw a text-based graphical representation of the commit history
2452 on the left hand side of the output. This may cause extra lines
2453 to be printed in between commits, in order for the graph history
2454 to be drawn properly.
Junio C Hamanoef57d1e2015-03-25 21:23:002455 Cannot be combined with <code>--no-walk</code>.
Junio C Hamanod2c978f2011-03-20 19:42:222456</p>
Junio C Hamanoce019c02017-10-30 05:57:462457<div class="paragraph"><p>This enables parent rewriting, see <em>History Simplification</em> above.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:512458<div class="paragraph"><p>This implies the <code>--topo-order</code> option by default, but the
2459<code>--date-order</code> option may also be specified.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:222460</dd>
Junio C Hamano624dd4c2014-04-03 21:56:302461<dt class="hdlist1">
2462--show-linear-break[=&lt;barrier&gt;]
2463</dt>
2464<dd>
2465<p>
2466 When --graph is not used, all history branches are flattened
2467 which can make it hard to see that the two consecutive commits
2468 do not belong to a linear branch. This option puts a barrier
Junio C Hamanoac12f0e2014-09-19 22:32:512469 in between them in that case. If <code>&lt;barrier&gt;</code> is specified, it
Junio C Hamano624dd4c2014-04-03 21:56:302470 is the string that will be shown instead of the default one.
2471</p>
2472</dd>
Junio C Hamanod2c978f2011-03-20 19:42:222473</dl></div>
Junio C Hamano9629d4f2012-12-19 00:28:272474</div>
Junio C Hamano9629d4f2012-12-19 00:28:272475</div>
2476</div>
2477<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:312478<h2 id="_pretty_formats">PRETTY FORMATS</h2>
Junio C Hamano0430e3a2007-05-15 03:13:172479<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:592480<div class="paragraph"><p>If the commit is a merge, and if the pretty-format
Junio C Hamano0430e3a2007-05-15 03:13:172481is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is
2482inserted before the <em>Author:</em> line. This line begins with
Junio C Hamanob4896852019-12-10 23:15:092483"Merge: " and the hashes of ancestral commits are printed,
Junio C Hamano0430e3a2007-05-15 03:13:172484separated by spaces. Note that the listed commits may not
2485necessarily be the list of the <strong>direct</strong> parent commits if you
2486have limited your view of history: for example, if you are
2487only interested in changes related to a certain directory or
Junio C Hamanoba4b9282008-07-06 05:20:312488file.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:592489<div class="paragraph"><p>There are several built-in formats, and you can define
Junio C Hamanoa574a092010-06-13 19:57:102490additional formats by setting a pretty.&lt;name&gt;
2491config option to either another format name, or a
2492<em>format:</em> string, as described below (see
Junio C Hamanoa28a9202012-06-21 07:08:232493<a href="git-config.html">git-config(1)</a>). Here are the details of the
Junio C Hamanoa574a092010-06-13 19:57:102494built-in formats:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:592495<div class="ulist"><ul>
Junio C Hamanoa340aaa2006-11-23 02:47:332496<li>
2497<p>
2498<em>oneline</em>
2499</p>
2500<div class="literalblock">
2501<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:382502<pre><code>&lt;hash&gt; &lt;title-line&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:332503</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:592504<div class="paragraph"><p>This is designed to be as compact as possible.</p></div>
Junio C Hamanoa340aaa2006-11-23 02:47:332505</li>
2506<li>
2507<p>
2508<em>short</em>
2509</p>
2510<div class="literalblock">
2511<div class="content">
Junio C Hamanob4896852019-12-10 23:15:092512<pre><code>commit &lt;hash&gt;
Junio C Hamanoac12f0e2014-09-19 22:32:512513Author: &lt;author&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:332514</div></div>
2515<div class="literalblock">
2516<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:382517<pre><code>&lt;title-line&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:332518</div></div>
2519</li>
2520<li>
2521<p>
2522<em>medium</em>
2523</p>
2524<div class="literalblock">
2525<div class="content">
Junio C Hamanob4896852019-12-10 23:15:092526<pre><code>commit &lt;hash&gt;
Junio C Hamanoa340aaa2006-11-23 02:47:332527Author: &lt;author&gt;
Junio C Hamano59a32b02021-12-10 22:53:382528Date: &lt;author-date&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:332529</div></div>
2530<div class="literalblock">
2531<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:382532<pre><code>&lt;title-line&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:332533</div></div>
2534<div class="literalblock">
2535<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:382536<pre><code>&lt;full-commit-message&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:332537</div></div>
2538</li>
2539<li>
2540<p>
2541<em>full</em>
2542</p>
2543<div class="literalblock">
2544<div class="content">
Junio C Hamanob4896852019-12-10 23:15:092545<pre><code>commit &lt;hash&gt;
Junio C Hamanoa340aaa2006-11-23 02:47:332546Author: &lt;author&gt;
Junio C Hamanoac12f0e2014-09-19 22:32:512547Commit: &lt;committer&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:332548</div></div>
2549<div class="literalblock">
2550<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:382551<pre><code>&lt;title-line&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:332552</div></div>
2553<div class="literalblock">
2554<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:382555<pre><code>&lt;full-commit-message&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:332556</div></div>
2557</li>
2558<li>
2559<p>
2560<em>fuller</em>
2561</p>
2562<div class="literalblock">
2563<div class="content">
Junio C Hamanob4896852019-12-10 23:15:092564<pre><code>commit &lt;hash&gt;
Junio C Hamano6a3c8272008-12-19 21:38:182565Author: &lt;author&gt;
Junio C Hamano59a32b02021-12-10 22:53:382566AuthorDate: &lt;author-date&gt;
Junio C Hamano6a3c8272008-12-19 21:38:182567Commit: &lt;committer&gt;
Junio C Hamano59a32b02021-12-10 22:53:382568CommitDate: &lt;committer-date&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:332569</div></div>
2570<div class="literalblock">
2571<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:382572<pre><code>&lt;title-line&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:332573</div></div>
2574<div class="literalblock">
2575<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:382576<pre><code>&lt;full-commit-message&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:332577</div></div>
2578</li>
2579<li>
2580<p>
Junio C Hamanob4896852019-12-10 23:15:092581<em>reference</em>
2582</p>
2583<div class="literalblock">
2584<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:382585<pre><code>&lt;abbrev-hash&gt; (&lt;title-line&gt;, &lt;short-author-date&gt;)</code></pre>
Junio C Hamanob4896852019-12-10 23:15:092586</div></div>
2587<div class="paragraph"><p>This format is used to refer to another commit in a commit message and
2588is the same as <code>--pretty='format:%C(auto)%h (%s, %ad)'</code>. By default,
2589the date is formatted with <code>--date=short</code> unless another <code>--date</code> option
2590is explicitly specified. As with any <code>format:</code> with format
2591placeholders, its output is not affected by other options like
2592<code>--decorate</code> and <code>--walk-reflogs</code>.</p></div>
2593</li>
2594<li>
2595<p>
Junio C Hamanoa340aaa2006-11-23 02:47:332596<em>email</em>
2597</p>
2598<div class="literalblock">
2599<div class="content">
Junio C Hamanob4896852019-12-10 23:15:092600<pre><code>From &lt;hash&gt; &lt;date&gt;
Junio C Hamanoa340aaa2006-11-23 02:47:332601From: &lt;author&gt;
Junio C Hamano59a32b02021-12-10 22:53:382602Date: &lt;author-date&gt;
2603Subject: [PATCH] &lt;title-line&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:332604</div></div>
2605<div class="literalblock">
2606<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:382607<pre><code>&lt;full-commit-message&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:332608</div></div>
2609</li>
2610<li>
2611<p>
Junio C Hamano0dd50942020-04-29 21:21:052612<em>mboxrd</em>
2613</p>
2614<div class="paragraph"><p>Like <em>email</em>, but lines in the commit message starting with "From "
2615(preceded by zero or more "&gt;") are quoted with "&gt;" so they aren&#8217;t
2616confused as starting a new commit.</p></div>
2617</li>
2618<li>
2619<p>
Junio C Hamanoa340aaa2006-11-23 02:47:332620<em>raw</em>
2621</p>
Junio C Hamano68cf15a2010-11-06 01:01:592622<div class="paragraph"><p>The <em>raw</em> format shows the entire commit exactly as
Junio C Hamanob4896852019-12-10 23:15:092623stored in the commit object. Notably, the hashes are
Junio C Hamanoa340aaa2006-11-23 02:47:332624displayed in full, regardless of whether --abbrev or
2625--no-abbrev are used, and <em>parents</em> information show the
Junio C Hamanod75148a2014-04-08 19:48:382626true parent commits, without taking grafts or history
Junio C Hamano85f1fde2015-06-01 20:37:322627simplification into account. Note that this format affects the way
2628commits are displayed, but not the way the diff is shown e.g. with
2629<code>git log --raw</code>. To get full object names in a raw diff format,
2630use <code>--no-abbrev</code>.</p></div>
Junio C Hamanoa340aaa2006-11-23 02:47:332631</li>
Junio C Hamanoa3fd83c2007-03-02 10:34:362632<li>
2633<p>
Junio C Hamano59a32b02021-12-10 22:53:382634<em>format:&lt;format-string&gt;</em>
Junio C Hamanoa3fd83c2007-03-02 10:34:362635</p>
Junio C Hamano59a32b02021-12-10 22:53:382636<div class="paragraph"><p>The <em>format:&lt;format-string&gt;</em> format allows you to specify which information
Junio C Hamanoa3fd83c2007-03-02 10:34:362637you want to show. It works a little bit like printf format,
2638with the notable exception that you get a newline with <em>%n</em>
Junio C Hamanoba4b9282008-07-06 05:20:312639instead of <em>\n</em>.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:592640<div class="paragraph"><p>E.g, <em>format:"The author of %h was %an, %ar%nThe title was &gt;&gt;%s&lt;&lt;%n"</em>
Junio C Hamanoba4b9282008-07-06 05:20:312641would show something like this:</p></div>
Junio C Hamano0430e3a2007-05-15 03:13:172642<div class="listingblock">
2643<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:512644<pre><code>The author of fe6e0ee was Junio C Hamano, 23 hours ago
2645The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;</code></pre>
Junio C Hamano0430e3a2007-05-15 03:13:172646</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:592647<div class="paragraph"><p>The placeholders are:</p></div>
2648<div class="ulist"><ul>
Junio C Hamanoa3fd83c2007-03-02 10:34:362649<li>
2650<p>
Junio C Hamano11f15372019-03-07 03:17:002651Placeholders that expand to a single literal character:
2652</p>
2653<div class="dlist"><dl>
2654<dt class="hdlist1">
2655<em>%n</em>
2656</dt>
2657<dd>
2658<p>
2659newline
2660</p>
2661</dd>
2662<dt class="hdlist1">
2663<em>%%</em>
2664</dt>
2665<dd>
2666<p>
2667a raw <em>%</em>
2668</p>
2669</dd>
2670<dt class="hdlist1">
2671<em>%x00</em>
2672</dt>
2673<dd>
2674<p>
2675print a byte from a hex code
2676</p>
2677</dd>
2678</dl></div>
2679</li>
2680<li>
2681<p>
2682Placeholders that affect formatting of later placeholders:
2683</p>
2684<div class="dlist"><dl>
2685<dt class="hdlist1">
2686<em>%Cred</em>
2687</dt>
2688<dd>
2689<p>
2690switch color to red
2691</p>
2692</dd>
2693<dt class="hdlist1">
2694<em>%Cgreen</em>
2695</dt>
2696<dd>
2697<p>
2698switch color to green
2699</p>
2700</dd>
2701<dt class="hdlist1">
2702<em>%Cblue</em>
2703</dt>
2704<dd>
2705<p>
2706switch color to blue
2707</p>
2708</dd>
2709<dt class="hdlist1">
2710<em>%Creset</em>
2711</dt>
2712<dd>
2713<p>
2714reset color
2715</p>
2716</dd>
2717<dt class="hdlist1">
2718<em>%C(&#8230;)</em>
2719</dt>
2720<dd>
2721<p>
2722color specification, as described under Values in the
2723 "CONFIGURATION FILE" section of <a href="git-config.html">git-config(1)</a>. By
2724 default, colors are shown only when enabled for log output
2725 (by <code>color.diff</code>, <code>color.ui</code>, or <code>--color</code>, and respecting
2726 the <code>auto</code> settings of the former if we are going to a
2727 terminal). <code>%C(auto,...)</code> is accepted as a historical
2728 synonym for the default (e.g., <code>%C(auto,red)</code>). Specifying
2729 <code>%C(always,...)</code> will show the colors even when color is
2730 not otherwise enabled (though consider just using
2731 <code>--color=always</code> to enable color for the whole output,
2732 including this format and anything else git might color).
2733 <code>auto</code> alone (i.e. <code>%C(auto)</code>) will turn on auto coloring
2734 on the next placeholders until the color is switched
2735 again.
2736</p>
2737</dd>
2738<dt class="hdlist1">
2739<em>%m</em>
2740</dt>
2741<dd>
2742<p>
2743left (<code>&lt;</code>), right (<code>&gt;</code>) or boundary (<code>-</code>) mark
2744</p>
2745</dd>
2746<dt class="hdlist1">
2747<em>%w([&lt;w&gt;[,&lt;i1&gt;[,&lt;i2&gt;]]])</em>
2748</dt>
2749<dd>
2750<p>
2751switch line wrapping, like the -w option of
2752 <a href="git-shortlog.html">git-shortlog(1)</a>.
2753</p>
2754</dd>
2755<dt class="hdlist1">
2756<em>%&lt;(&lt;N&gt;[,trunc|ltrunc|mtrunc])</em>
2757</dt>
2758<dd>
2759<p>
2760make the next placeholder take at
2761 least N columns, padding spaces on
2762 the right if necessary. Optionally
2763 truncate at the beginning (ltrunc),
2764 the middle (mtrunc) or the end
2765 (trunc) if the output is longer than
2766 N columns. Note that truncating
2767 only works correctly with N &gt;= 2.
2768</p>
2769</dd>
2770<dt class="hdlist1">
2771<em>%&lt;|(&lt;N&gt;)</em>
2772</dt>
2773<dd>
2774<p>
2775make the next placeholder take at least until Nth
2776 columns, padding spaces on the right if necessary
2777</p>
2778</dd>
2779<dt class="hdlist1">
2780<em>%&gt;(&lt;N&gt;)</em>, <em>%&gt;|(&lt;N&gt;)</em>
2781</dt>
2782<dd>
2783<p>
2784similar to <em>%&lt;(&lt;N&gt;)</em>, <em>%&lt;|(&lt;N&gt;)</em> respectively,
2785 but padding spaces on the left
2786</p>
2787</dd>
2788<dt class="hdlist1">
2789<em>%&gt;&gt;(&lt;N&gt;)</em>, <em>%&gt;&gt;|(&lt;N&gt;)</em>
2790</dt>
2791<dd>
2792<p>
2793similar to <em>%&gt;(&lt;N&gt;)</em>, <em>%&gt;|(&lt;N&gt;)</em>
2794 respectively, except that if the next
2795 placeholder takes more spaces than given and
2796 there are spaces on its left, use those
2797 spaces
2798</p>
2799</dd>
2800<dt class="hdlist1">
2801<em>%&gt;&lt;(&lt;N&gt;)</em>, <em>%&gt;&lt;|(&lt;N&gt;)</em>
2802</dt>
2803<dd>
2804<p>
2805similar to <em>%&lt;(&lt;N&gt;)</em>, <em>%&lt;|(&lt;N&gt;)</em>
2806 respectively, but padding both sides
2807 (i.e. the text is centered)
2808</p>
2809</dd>
2810</dl></div>
2811</li>
2812<li>
2813<p>
2814Placeholders that expand to information extracted from the commit:
2815</p>
2816<div class="dlist"><dl>
2817<dt class="hdlist1">
2818<em>%H</em>
2819</dt>
2820<dd>
2821<p>
2822commit hash
2823</p>
2824</dd>
2825<dt class="hdlist1">
2826<em>%h</em>
2827</dt>
2828<dd>
2829<p>
2830abbreviated commit hash
2831</p>
2832</dd>
2833<dt class="hdlist1">
2834<em>%T</em>
2835</dt>
2836<dd>
2837<p>
2838tree hash
2839</p>
2840</dd>
2841<dt class="hdlist1">
2842<em>%t</em>
2843</dt>
2844<dd>
2845<p>
2846abbreviated tree hash
2847</p>
2848</dd>
2849<dt class="hdlist1">
2850<em>%P</em>
2851</dt>
2852<dd>
2853<p>
2854parent hashes
2855</p>
2856</dd>
2857<dt class="hdlist1">
2858<em>%p</em>
2859</dt>
2860<dd>
2861<p>
2862abbreviated parent hashes
2863</p>
2864</dd>
2865<dt class="hdlist1">
2866<em>%an</em>
2867</dt>
2868<dd>
2869<p>
2870author name
2871</p>
2872</dd>
2873<dt class="hdlist1">
2874<em>%aN</em>
2875</dt>
2876<dd>
2877<p>
2878author name (respecting .mailmap, see <a href="git-shortlog.html">git-shortlog(1)</a>
2879 or <a href="git-blame.html">git-blame(1)</a>)
2880</p>
2881</dd>
2882<dt class="hdlist1">
2883<em>%ae</em>
2884</dt>
2885<dd>
2886<p>
2887author email
2888</p>
2889</dd>
2890<dt class="hdlist1">
2891<em>%aE</em>
2892</dt>
2893<dd>
2894<p>
2895author email (respecting .mailmap, see <a href="git-shortlog.html">git-shortlog(1)</a>
2896 or <a href="git-blame.html">git-blame(1)</a>)
2897</p>
2898</dd>
2899<dt class="hdlist1">
Junio C Hamano8ac8a3d2019-11-11 04:33:462900<em>%al</em>
2901</dt>
2902<dd>
2903<p>
2904author email local-part (the part before the <em>@</em> sign)
2905</p>
2906</dd>
2907<dt class="hdlist1">
2908<em>%aL</em>
2909</dt>
2910<dd>
2911<p>
2912author local-part (see <em>%al</em>) respecting .mailmap, see
2913 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
2914</p>
2915</dd>
2916<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:002917<em>%ad</em>
2918</dt>
2919<dd>
2920<p>
2921author date (format respects --date= option)
2922</p>
2923</dd>
2924<dt class="hdlist1">
2925<em>%aD</em>
2926</dt>
2927<dd>
2928<p>
2929author date, RFC2822 style
2930</p>
2931</dd>
2932<dt class="hdlist1">
2933<em>%ar</em>
2934</dt>
2935<dd>
2936<p>
2937author date, relative
2938</p>
2939</dd>
2940<dt class="hdlist1">
2941<em>%at</em>
2942</dt>
2943<dd>
2944<p>
2945author date, UNIX timestamp
2946</p>
2947</dd>
2948<dt class="hdlist1">
2949<em>%ai</em>
2950</dt>
2951<dd>
2952<p>
2953author date, ISO 8601-like format
2954</p>
2955</dd>
2956<dt class="hdlist1">
2957<em>%aI</em>
2958</dt>
2959<dd>
2960<p>
2961author date, strict ISO 8601 format
2962</p>
2963</dd>
2964<dt class="hdlist1">
Junio C Hamanob4896852019-12-10 23:15:092965<em>%as</em>
2966</dt>
2967<dd>
2968<p>
2969author date, short format (<code>YYYY-MM-DD</code>)
2970</p>
2971</dd>
2972<dt class="hdlist1">
Junio C Hamanobe601db2021-05-07 04:20:282973<em>%ah</em>
2974</dt>
2975<dd>
2976<p>
2977author date, human style (like the <code>--date=human</code> option of
2978 <a href="git-rev-list.html">git-rev-list(1)</a>)
2979</p>
2980</dd>
2981<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:002982<em>%cn</em>
2983</dt>
2984<dd>
2985<p>
2986committer name
2987</p>
2988</dd>
2989<dt class="hdlist1">
2990<em>%cN</em>
2991</dt>
2992<dd>
2993<p>
2994committer name (respecting .mailmap, see
2995 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
2996</p>
2997</dd>
2998<dt class="hdlist1">
2999<em>%ce</em>
3000</dt>
3001<dd>
3002<p>
3003committer email
3004</p>
3005</dd>
3006<dt class="hdlist1">
3007<em>%cE</em>
3008</dt>
3009<dd>
3010<p>
3011committer email (respecting .mailmap, see
3012 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3013</p>
3014</dd>
3015<dt class="hdlist1">
Junio C Hamano8ac8a3d2019-11-11 04:33:463016<em>%cl</em>
3017</dt>
3018<dd>
3019<p>
Junio C Hamanoa8911782020-07-07 05:35:573020committer email local-part (the part before the <em>@</em> sign)
Junio C Hamano8ac8a3d2019-11-11 04:33:463021</p>
3022</dd>
3023<dt class="hdlist1">
3024<em>%cL</em>
3025</dt>
3026<dd>
3027<p>
Junio C Hamanoa8911782020-07-07 05:35:573028committer local-part (see <em>%cl</em>) respecting .mailmap, see
Junio C Hamano8ac8a3d2019-11-11 04:33:463029 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3030</p>
3031</dd>
3032<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:003033<em>%cd</em>
3034</dt>
3035<dd>
3036<p>
3037committer date (format respects --date= option)
3038</p>
3039</dd>
3040<dt class="hdlist1">
3041<em>%cD</em>
3042</dt>
3043<dd>
3044<p>
3045committer date, RFC2822 style
3046</p>
3047</dd>
3048<dt class="hdlist1">
3049<em>%cr</em>
3050</dt>
3051<dd>
3052<p>
3053committer date, relative
3054</p>
3055</dd>
3056<dt class="hdlist1">
3057<em>%ct</em>
3058</dt>
3059<dd>
3060<p>
3061committer date, UNIX timestamp
3062</p>
3063</dd>
3064<dt class="hdlist1">
3065<em>%ci</em>
3066</dt>
3067<dd>
3068<p>
3069committer date, ISO 8601-like format
3070</p>
3071</dd>
3072<dt class="hdlist1">
3073<em>%cI</em>
3074</dt>
3075<dd>
3076<p>
3077committer date, strict ISO 8601 format
3078</p>
3079</dd>
3080<dt class="hdlist1">
Junio C Hamanob4896852019-12-10 23:15:093081<em>%cs</em>
3082</dt>
3083<dd>
3084<p>
3085committer date, short format (<code>YYYY-MM-DD</code>)
3086</p>
3087</dd>
3088<dt class="hdlist1">
Junio C Hamanobe601db2021-05-07 04:20:283089<em>%ch</em>
3090</dt>
3091<dd>
3092<p>
Junio C Hamano608b11d2021-05-16 21:40:453093committer date, human style (like the <code>--date=human</code> option of
Junio C Hamanobe601db2021-05-07 04:20:283094 <a href="git-rev-list.html">git-rev-list(1)</a>)
3095</p>
3096</dd>
3097<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:003098<em>%d</em>
3099</dt>
3100<dd>
3101<p>
3102ref names, like the --decorate option of <a href="git-log.html">git-log(1)</a>
3103</p>
3104</dd>
3105<dt class="hdlist1">
3106<em>%D</em>
3107</dt>
3108<dd>
3109<p>
3110ref names without the " (", ")" wrapping.
3111</p>
3112</dd>
3113<dt class="hdlist1">
Junio C Hamano458281a2021-03-22 21:20:263114<em>%(describe[:options])</em>
3115</dt>
3116<dd>
3117<p>
3118human-readable name, like
3119 <a href="git-describe.html">git-describe(1)</a>; empty string for
3120 undescribable commits. The <code>describe</code> string
3121 may be followed by a colon and zero or more
3122 comma-separated options. Descriptions can be
3123 inconsistent when tags are added or removed at
3124 the same time.
3125</p>
3126<div class="ulist"><ul>
3127<li>
3128<p>
Junio C Hamano2b153182021-12-15 21:00:313129<em>tags[=&lt;bool-value&gt;]</em>: Instead of only considering annotated tags,
3130 consider lightweight tags as well.
3131</p>
3132</li>
3133<li>
3134<p>
3135<em>abbrev=&lt;number&gt;</em>: Instead of using the default number of hexadecimal digits
3136 (which will vary according to the number of objects in the repository with a
3137 default of 7) of the abbreviated object name, use &lt;number&gt; digits, or as many
3138 digits as needed to form a unique object name.
3139</p>
3140</li>
3141<li>
3142<p>
Junio C Hamano458281a2021-03-22 21:20:263143<em>match=&lt;pattern&gt;</em>: Only consider tags matching the given
3144 <code>glob(7)</code> pattern, excluding the "refs/tags/" prefix.
3145</p>
3146</li>
3147<li>
3148<p>
3149<em>exclude=&lt;pattern&gt;</em>: Do not consider tags matching the given
3150 <code>glob(7)</code> pattern, excluding the "refs/tags/" prefix.
3151</p>
3152</li>
3153</ul></div>
3154</dd>
3155<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:003156<em>%S</em>
3157</dt>
3158<dd>
3159<p>
3160ref name given on the command line by which the commit was reached
3161 (like <code>git log --source</code>), only works with <code>git log</code>
3162</p>
3163</dd>
3164<dt class="hdlist1">
3165<em>%e</em>
3166</dt>
3167<dd>
3168<p>
3169encoding
3170</p>
3171</dd>
3172<dt class="hdlist1">
3173<em>%s</em>
3174</dt>
3175<dd>
3176<p>
3177subject
3178</p>
3179</dd>
3180<dt class="hdlist1">
3181<em>%f</em>
3182</dt>
3183<dd>
3184<p>
3185sanitized subject line, suitable for a filename
3186</p>
3187</dd>
3188<dt class="hdlist1">
3189<em>%b</em>
3190</dt>
3191<dd>
3192<p>
3193body
3194</p>
3195</dd>
3196<dt class="hdlist1">
3197<em>%B</em>
3198</dt>
3199<dd>
3200<p>
3201raw body (unwrapped subject and body)
3202</p>
3203</dd>
3204<dt class="hdlist1">
3205<em>%N</em>
3206</dt>
3207<dd>
3208<p>
3209commit notes
3210</p>
3211</dd>
3212<dt class="hdlist1">
3213<em>%GG</em>
3214</dt>
3215<dd>
3216<p>
3217raw verification message from GPG for a signed commit
3218</p>
3219</dd>
3220<dt class="hdlist1">
3221<em>%G?</em>
3222</dt>
3223<dd>
3224<p>
3225show "G" for a good (valid) signature,
3226 "B" for a bad signature,
3227 "U" for a good signature with unknown validity,
3228 "X" for a good signature that has expired,
3229 "Y" for a good signature made by an expired key,
3230 "R" for a good signature made by a revoked key,
3231 "E" if the signature cannot be checked (e.g. missing key)
3232 and "N" for no signature
3233</p>
3234</dd>
3235<dt class="hdlist1">
3236<em>%GS</em>
3237</dt>
3238<dd>
3239<p>
3240show the name of the signer for a signed commit
3241</p>
3242</dd>
3243<dt class="hdlist1">
3244<em>%GK</em>
3245</dt>
3246<dd>
3247<p>
3248show the key used to sign a signed commit
3249</p>
3250</dd>
3251<dt class="hdlist1">
3252<em>%GF</em>
3253</dt>
3254<dd>
3255<p>
3256show the fingerprint of the key used to sign a signed commit
3257</p>
3258</dd>
3259<dt class="hdlist1">
3260<em>%GP</em>
3261</dt>
3262<dd>
3263<p>
3264show the fingerprint of the primary key whose subkey was used
3265 to sign a signed commit
3266</p>
3267</dd>
3268<dt class="hdlist1">
Junio C Hamanobee061d2020-01-30 23:21:183269<em>%GT</em>
3270</dt>
3271<dd>
3272<p>
3273show the trust level for the key used to sign a signed commit
3274</p>
3275</dd>
3276<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:003277<em>%gD</em>
3278</dt>
3279<dd>
3280<p>
3281reflog selector, e.g., <code>refs/stash@{1}</code> or <code>refs/stash@{2
Junio C Hamano48cd3f12019-10-09 05:55:303282 minutes ago}</code>; the format follows the rules described for the
Junio C Hamano11f15372019-03-07 03:17:003283 <code>-g</code> option. The portion before the <code>@</code> is the refname as
3284 given on the command line (so <code>git log -g refs/heads/master</code>
3285 would yield <code>refs/heads/master@{0}</code>).
3286</p>
3287</dd>
3288<dt class="hdlist1">
3289<em>%gd</em>
3290</dt>
3291<dd>
3292<p>
3293shortened reflog selector; same as <code>%gD</code>, but the refname
3294 portion is shortened for human readability (so
3295 <code>refs/heads/master</code> becomes just <code>master</code>).
3296</p>
3297</dd>
3298<dt class="hdlist1">
3299<em>%gn</em>
3300</dt>
3301<dd>
3302<p>
3303reflog identity name
3304</p>
3305</dd>
3306<dt class="hdlist1">
3307<em>%gN</em>
3308</dt>
3309<dd>
3310<p>
3311reflog identity name (respecting .mailmap, see
3312 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3313</p>
3314</dd>
3315<dt class="hdlist1">
3316<em>%ge</em>
3317</dt>
3318<dd>
3319<p>
3320reflog identity email
3321</p>
3322</dd>
3323<dt class="hdlist1">
3324<em>%gE</em>
3325</dt>
3326<dd>
3327<p>
3328reflog identity email (respecting .mailmap, see
3329 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3330</p>
3331</dd>
3332<dt class="hdlist1">
3333<em>%gs</em>
3334</dt>
3335<dd>
3336<p>
3337reflog subject
3338</p>
3339</dd>
3340<dt class="hdlist1">
3341<em>%(trailers[:options])</em>
3342</dt>
3343<dd>
3344<p>
3345display the trailers of the body as
3346 interpreted by
3347 <a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>. The
3348 <code>trailers</code> string may be followed by a colon
Junio C Hamano674f3e12021-01-07 08:42:493349 and zero or more comma-separated options.
3350 If any option is provided multiple times the
Junio C Hamano608b11d2021-05-16 21:40:453351 last occurrence wins.
Junio C Hamano11f15372019-03-07 03:17:003352</p>
3353<div class="ulist"><ul>
3354<li>
3355<p>
Junio C Hamano59a32b02021-12-10 22:53:383356<em>key=&lt;key&gt;</em>: only show trailers with specified &lt;key&gt;. Matching is done
Junio C Hamano11f15372019-03-07 03:17:003357 case-insensitively and trailing colon is optional. If option is
3358 given multiple times trailer lines matching any of the keys are
3359 shown. This option automatically enables the <code>only</code> option so that
3360 non-trailer lines in the trailer block are hidden. If that is not
3361 desired it can be disabled with <code>only=false</code>. E.g.,
3362 <code>%(trailers:key=Reviewed-by)</code> shows trailer lines with key
3363 <code>Reviewed-by</code>.
Junio C Hamanoa3fd83c2007-03-02 10:34:363364</p>
3365</li>
3366<li>
3367<p>
Junio C Hamano59a32b02021-12-10 22:53:383368<em>only[=&lt;bool&gt;]</em>: select whether non-trailer lines from the trailer
Junio C Hamano674f3e12021-01-07 08:42:493369 block should be included.
Junio C Hamanoa3fd83c2007-03-02 10:34:363370</p>
3371</li>
3372<li>
3373<p>
Junio C Hamano59a32b02021-12-10 22:53:383374<em>separator=&lt;sep&gt;</em>: specify a separator inserted between trailer
Junio C Hamano11f15372019-03-07 03:17:003375 lines. When this option is not given each trailer line is
Junio C Hamano59a32b02021-12-10 22:53:383376 terminated with a line feed character. The string &lt;sep&gt; may contain
Junio C Hamano11f15372019-03-07 03:17:003377 the literal formatting codes described above. To use comma as
3378 separator one must use <code>%x2C</code> as it would otherwise be parsed as
Junio C Hamano674f3e12021-01-07 08:42:493379 next option. E.g., <code>%(trailers:key=Ticket,separator=%x2C )</code>
Junio C Hamano11f15372019-03-07 03:17:003380 shows all trailer lines whose key is "Ticket" separated by a comma
3381 and a space.
Junio C Hamanoa3fd83c2007-03-02 10:34:363382</p>
3383</li>
3384<li>
3385<p>
Junio C Hamano59a32b02021-12-10 22:53:383386<em>unfold[=&lt;bool&gt;]</em>: make it behave as if interpret-trailer&#8217;s <code>--unfold</code>
Junio C Hamano674f3e12021-01-07 08:42:493387 option was given. E.g.,
Junio C Hamano11f15372019-03-07 03:17:003388 <code>%(trailers:only,unfold=true)</code> unfolds and shows all trailer lines.
Junio C Hamanoa3fd83c2007-03-02 10:34:363389</p>
3390</li>
3391<li>
3392<p>
Junio C Hamano59a32b02021-12-10 22:53:383393<em>keyonly[=&lt;bool&gt;]</em>: only show the key part of the trailer.
Junio C Hamano674f3e12021-01-07 08:42:493394</p>
3395</li>
3396<li>
3397<p>
Junio C Hamano59a32b02021-12-10 22:53:383398<em>valueonly[=&lt;bool&gt;]</em>: only show the value part of the trailer.
Junio C Hamano674f3e12021-01-07 08:42:493399</p>
3400</li>
3401<li>
3402<p>
Junio C Hamano59a32b02021-12-10 22:53:383403<em>key_value_separator=&lt;sep&gt;</em>: specify a separator inserted between
Junio C Hamano674f3e12021-01-07 08:42:493404 trailer lines. When this option is not given each trailer key-value
3405 pair is separated by ": ". Otherwise it shares the same semantics
Junio C Hamano59a32b02021-12-10 22:53:383406 as <em>separator=&lt;sep&gt;</em> above.
Junio C Hamanoa3fd83c2007-03-02 10:34:363407</p>
3408</li>
Junio C Hamano11f15372019-03-07 03:17:003409</ul></div>
3410</dd>
3411</dl></div>
Junio C Hamano04e768d2013-04-23 19:19:263412</li>
Junio C Hamanoba4b9282008-07-06 05:20:313413</ul></div>
Junio C Hamanoa3fd83c2007-03-02 10:34:363414</li>
Junio C Hamanoc21ab052009-10-31 04:03:553415</ul></div>
3416<div class="admonitionblock">
3417<table><tr>
3418<td class="icon">
3419<div class="title">Note</div>
3420</td>
3421<td class="content">Some placeholders may depend on other options given to the
Junio C Hamanoac12f0e2014-09-19 22:32:513422revision traversal engine. For example, the <code>%g*</code> reflog options will
Junio C Hamanoc21ab052009-10-31 04:03:553423insert an empty string unless we are traversing reflog entries (e.g., by
Junio C Hamano00b9f1a2014-09-29 23:11:283424<code>git log -g</code>). The <code>%d</code> and <code>%D</code> placeholders will use the "short"
3425decoration format if <code>--decorate</code> was not already provided on the command
3426line.</td>
Junio C Hamanoc21ab052009-10-31 04:03:553427</tr></table>
3428</div>
Junio C Hamano2b153182021-12-15 21:00:313429<div class="paragraph"><p>The boolean options accept an optional value <code>[=&lt;bool-value&gt;]</code>. The values
3430<code>true</code>, <code>false</code>, <code>on</code>, <code>off</code> etc. are all accepted. See the "boolean"
3431sub-section in "EXAMPLES" in <a href="git-config.html">git-config(1)</a>. If a boolean
3432option is given with no value, it&#8217;s enabled.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:513433<div class="paragraph"><p>If you add a <code>+</code> (plus sign) after <em>%</em> of a placeholder, a line-feed
Junio C Hamano2bd8a742009-12-01 21:16:593434is inserted immediately before the expansion if and only if the
3435placeholder expands to a non-empty string.</p></div>
Junio C Hamano535c65c2017-06-24 22:51:583436<div class="paragraph"><p>If you add a <code>-</code> (minus sign) after <em>%</em> of a placeholder, all consecutive
3437line-feeds immediately preceding the expansion are deleted if and only if the
Junio C Hamano2bd8a742009-12-01 21:16:593438placeholder expands to an empty string.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:593439<div class="paragraph"><p>If you add a ` ` (space) after <em>%</em> of a placeholder, a space
Junio C Hamano89a57342010-06-22 23:22:553440is inserted immediately before the expansion if and only if the
3441placeholder expands to a non-empty string.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:593442<div class="ulist"><ul>
Junio C Hamano6fb124c2008-06-13 10:04:013443<li>
3444<p>
3445<em>tformat:</em>
3446</p>
Junio C Hamano68cf15a2010-11-06 01:01:593447<div class="paragraph"><p>The <em>tformat:</em> format works exactly like <em>format:</em>, except that it
Junio C Hamano6fb124c2008-06-13 10:04:013448provides "terminator" semantics instead of "separator" semantics. In
3449other words, each commit has the message terminator character (usually a
3450newline) appended, rather than a separator placed between entries.
3451This means that the final entry of a single-line format will be properly
3452terminated with a new line, just as the "oneline" format does.
Junio C Hamanoba4b9282008-07-06 05:20:313453For example:</p></div>
Junio C Hamano6fb124c2008-06-13 10:04:013454<div class="listingblock">
3455<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:513456<pre><code>$ git log -2 --pretty=format:%h 4da45bef \
Junio C Hamano6fb124c2008-06-13 10:04:013457 | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
34584da45be
34597134973 -- NO NEWLINE
3460
3461$ git log -2 --pretty=tformat:%h 4da45bef \
3462 | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
34634da45be
Junio C Hamanoac12f0e2014-09-19 22:32:5134647134973</code></pre>
Junio C Hamano6fb124c2008-06-13 10:04:013465</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:513466<div class="paragraph"><p>In addition, any unrecognized string that has a <code>%</code> in it is interpreted
3467as if it has <code>tformat:</code> in front of it. For example, these two are
Junio C Hamano0a235222009-03-06 08:21:093468equivalent:</p></div>
3469<div class="listingblock">
3470<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:513471<pre><code>$ git log -2 --pretty=tformat:%h 4da45bef
3472$ git log -2 --pretty=%h 4da45bef</code></pre>
Junio C Hamano0a235222009-03-06 08:21:093473</div></div>
Junio C Hamano6fb124c2008-06-13 10:04:013474</li>
Junio C Hamanoba4b9282008-07-06 05:20:313475</ul></div>
Junio C Hamano1a4e8412005-12-27 08:17:233476</div>
Junio C Hamano9629d4f2012-12-19 00:28:273477</div>
3478<div class="sect1">
Junio C Hamano255163d2020-08-18 00:37:233479<h2 id="_diff_formatting">DIFF FORMATTING</h2>
Junio C Hamanod2c978f2011-03-20 19:42:223480<div class="sectionbody">
Junio C Hamano255163d2020-08-18 00:37:233481<div class="paragraph"><p>By default, <code>git log</code> does not generate any diff output. The options
3482below can be used to show the changes made by each commit.</p></div>
Junio C Hamano8c860d62021-02-06 01:37:473483<div class="paragraph"><p>Note that unless one of <code>--diff-merges</code> variants (including short
3484<code>-m</code>, <code>-c</code>, and <code>--cc</code> options) is explicitly given, merge commits
3485will not show a diff, even if a diff format like <code>--patch</code> is
3486selected, nor will they match search options like <code>-S</code>. The exception
3487is when <code>--first-parent</code> is in use, in which case <code>first-parent</code> is
3488the default format.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:223489<div class="dlist"><dl>
3490<dt class="hdlist1">
3491-p
3492</dt>
3493<dt class="hdlist1">
3494-u
3495</dt>
3496<dt class="hdlist1">
3497--patch
3498</dt>
3499<dd>
3500<p>
Junio C Hamanoa75aada2023-01-22 01:54:303501 Generate patch (see section titled
3502<a href="#generate_patch_text_with_p">"Generating patch text with -p"</a>).
Junio C Hamanod2c978f2011-03-20 19:42:223503</p>
3504</dd>
3505<dt class="hdlist1">
Junio C Hamano58f587a2013-07-22 19:20:593506-s
3507</dt>
3508<dt class="hdlist1">
3509--no-patch
3510</dt>
3511<dd>
3512<p>
Junio C Hamanoac12f0e2014-09-19 22:32:513513 Suppress diff output. Useful for commands like <code>git show</code> that
3514 show the patch by default, or to cancel the effect of <code>--patch</code>.
Junio C Hamano58f587a2013-07-22 19:20:593515</p>
3516</dd>
3517<dt class="hdlist1">
Junio C Hamanof1fc6ca2022-02-17 01:32:333518--diff-merges=(off|none|on|first-parent|1|separate|m|combined|c|dense-combined|cc|remerge|r)
Junio C Hamano8c860d62021-02-06 01:37:473519</dt>
3520<dt class="hdlist1">
3521--no-diff-merges
3522</dt>
3523<dd>
3524<p>
3525 Specify diff format to be used for merge commits. Default is
3526 <code>off</code> unless <code>--first-parent</code> is in use, in which case
3527 <code>first-parent</code> is the default.
3528</p>
3529<div class="dlist"><dl>
3530<dt class="hdlist1">
3531--diff-merges=(off|none)
3532</dt>
3533<dt class="hdlist1">
3534--no-diff-merges
3535</dt>
3536<dd>
3537<p>
3538 Disable output of diffs for merge commits. Useful to override
3539 implied value.
3540</p>
3541</dd>
3542<dt class="hdlist1">
Junio C Hamano4078a552021-04-30 06:08:103543--diff-merges=on
3544</dt>
3545<dt class="hdlist1">
3546--diff-merges=m
3547</dt>
3548<dt class="hdlist1">
3549-m
3550</dt>
3551<dd>
3552<p>
3553 This option makes diff output for merge commits to be shown in
Junio C Hamano86505432021-08-11 20:13:583554 the default format. <code>-m</code> will produce the output only if <code>-p</code>
3555 is given as well. The default format could be changed using
Junio C Hamano4078a552021-04-30 06:08:103556 <code>log.diffMerges</code> configuration parameter, which default value
Junio C Hamano86505432021-08-11 20:13:583557 is <code>separate</code>.
Junio C Hamano4078a552021-04-30 06:08:103558</p>
3559</dd>
3560<dt class="hdlist1">
Junio C Hamano8c860d62021-02-06 01:37:473561--diff-merges=first-parent
3562</dt>
3563<dt class="hdlist1">
3564--diff-merges=1
3565</dt>
3566<dd>
3567<p>
3568 This option makes merge commits show the full diff with
3569 respect to the first parent only.
3570</p>
3571</dd>
3572<dt class="hdlist1">
3573--diff-merges=separate
3574</dt>
Junio C Hamano8c860d62021-02-06 01:37:473575<dd>
3576<p>
3577 This makes merge commits show the full diff with respect to
3578 each of the parents. Separate log entry and diff is generated
Junio C Hamano86505432021-08-11 20:13:583579 for each parent.
Junio C Hamano8c860d62021-02-06 01:37:473580</p>
3581</dd>
3582<dt class="hdlist1">
Junio C Hamanof1fc6ca2022-02-17 01:32:333583--diff-merges=remerge
3584</dt>
3585<dt class="hdlist1">
3586--diff-merges=r
3587</dt>
3588<dt class="hdlist1">
3589--remerge-diff
3590</dt>
3591<dd>
3592<p>
3593 With this option, two-parent merge commits are remerged to
3594 create a temporary tree object&#8201;&#8212;&#8201;potentially containing files
3595 with conflict markers and such. A diff is then shown between
3596 that temporary tree and the actual merge commit.
3597</p>
3598<div class="paragraph"><p>The output emitted when this option is used is subject to change, and
3599so is its interaction with other options (unless explicitly
3600documented).</p></div>
3601</dd>
3602<dt class="hdlist1">
Junio C Hamano8c860d62021-02-06 01:37:473603--diff-merges=combined
3604</dt>
3605<dt class="hdlist1">
3606--diff-merges=c
3607</dt>
3608<dt class="hdlist1">
3609-c
3610</dt>
3611<dd>
3612<p>
3613 With this option, diff output for a merge commit shows the
3614 differences from each of the parents to the merge result
3615 simultaneously instead of showing pairwise diff between a
3616 parent and the result one at a time. Furthermore, it lists
3617 only files which were modified from all parents. <code>-c</code> implies
3618 <code>-p</code>.
3619</p>
3620</dd>
3621<dt class="hdlist1">
3622--diff-merges=dense-combined
3623</dt>
3624<dt class="hdlist1">
3625--diff-merges=cc
3626</dt>
3627<dt class="hdlist1">
3628--cc
3629</dt>
3630<dd>
3631<p>
3632 With this option the output produced by
3633 <code>--diff-merges=combined</code> is further compressed by omitting
3634 uninteresting hunks whose contents in the parents have only
3635 two variants and the merge result picks one of them without
3636 modification. <code>--cc</code> implies <code>-p</code>.
3637</p>
3638</dd>
3639</dl></div>
3640</dd>
3641<dt class="hdlist1">
3642--combined-all-paths
3643</dt>
3644<dd>
3645<p>
3646 This flag causes combined diffs (used for merge commits) to
3647 list the name of the file from all parents. It thus only has
3648 effect when <code>--diff-merges=[dense-]combined</code> is in use, and
3649 is likely only useful if filename changes are detected (i.e.
3650 when either rename or copy detection have been requested).
3651</p>
3652</dd>
3653<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:223654-U&lt;n&gt;
3655</dt>
3656<dt class="hdlist1">
3657--unified=&lt;n&gt;
3658</dt>
3659<dd>
3660<p>
3661 Generate diffs with &lt;n&gt; lines of context instead of
Junio C Hamanoee43d182020-11-11 22:10:413662 the usual three.
3663 Implies <code>--patch</code>.
Junio C Hamanod2c978f2011-03-20 19:42:223664</p>
3665</dd>
3666<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:003667--output=&lt;file&gt;
3668</dt>
3669<dd>
3670<p>
3671 Output to a specific file instead of stdout.
3672</p>
3673</dd>
3674<dt class="hdlist1">
3675--output-indicator-new=&lt;char&gt;
3676</dt>
3677<dt class="hdlist1">
3678--output-indicator-old=&lt;char&gt;
3679</dt>
3680<dt class="hdlist1">
3681--output-indicator-context=&lt;char&gt;
3682</dt>
3683<dd>
3684<p>
3685 Specify the character used to indicate new, old or context
3686 lines in the generated patch. Normally they are <em>+</em>, <em>-</em> and
3687 ' ' respectively.
3688</p>
3689</dd>
3690<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:223691--raw
3692</dt>
3693<dd>
3694<p>
Junio C Hamano85f1fde2015-06-01 20:37:323695 For each commit, show a summary of changes using the raw diff
3696 format. See the "RAW OUTPUT FORMAT" section of
3697 <a href="git-diff.html">git-diff(1)</a>. This is different from showing the log
3698 itself in raw format, which you can achieve with
3699 <code>--format=raw</code>.
Junio C Hamanod2c978f2011-03-20 19:42:223700</p>
3701</dd>
3702<dt class="hdlist1">
3703--patch-with-raw
3704</dt>
3705<dd>
3706<p>
Junio C Hamanoac12f0e2014-09-19 22:32:513707 Synonym for <code>-p --raw</code>.
Junio C Hamanod2c978f2011-03-20 19:42:223708</p>
3709</dd>
3710<dt class="hdlist1">
Junio C Hamano255163d2020-08-18 00:37:233711-t
3712</dt>
3713<dd>
3714<p>
3715 Show the tree objects in the diff output.
3716</p>
3717</dd>
3718<dt class="hdlist1">
Junio C Hamanoad70bf02016-09-26 23:44:273719--indent-heuristic
3720</dt>
Junio C Hamanoa65b6762017-11-06 04:45:423721<dd>
3722<p>
Junio C Hamano14e66832018-06-18 18:32:193723 Enable the heuristic that shifts diff hunk boundaries to make patches
Junio C Hamanoa65b6762017-11-06 04:45:423724 easier to read. This is the default.
3725</p>
3726</dd>
Junio C Hamanoad70bf02016-09-26 23:44:273727<dt class="hdlist1">
3728--no-indent-heuristic
3729</dt>
Junio C Hamano5f888332016-06-13 19:28:313730<dd>
3731<p>
Junio C Hamanoa65b6762017-11-06 04:45:423732 Disable the indent heuristic.
Junio C Hamano5f888332016-06-13 19:28:313733</p>
3734</dd>
3735<dt class="hdlist1">
Junio C Hamano5a73f302011-10-14 05:58:343736--minimal
3737</dt>
3738<dd>
3739<p>
3740 Spend extra time to make sure the smallest possible
3741 diff is produced.
3742</p>
3743</dd>
3744<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:223745--patience
3746</dt>
3747<dd>
3748<p>
3749 Generate a diff using the "patience diff" algorithm.
3750</p>
3751</dd>
3752<dt class="hdlist1">
Junio C Hamanoaea9e6b2012-03-07 00:17:113753--histogram
3754</dt>
3755<dd>
3756<p>
3757 Generate a diff using the "histogram diff" algorithm.
3758</p>
3759</dd>
3760<dt class="hdlist1">
Junio C Hamano047135e2017-12-19 21:57:543761--anchored=&lt;text&gt;
3762</dt>
3763<dd>
3764<p>
3765 Generate a diff using the "anchored diff" algorithm.
3766</p>
3767<div class="paragraph"><p>This option may be specified more than once.</p></div>
3768<div class="paragraph"><p>If a line exists in both the source and destination, exists only once,
3769and starts with this text, this algorithm attempts to prevent it from
3770appearing as a deletion or addition in the output. It uses the "patience
3771diff" algorithm internally.</p></div>
3772</dd>
3773<dt class="hdlist1">
Junio C Hamano80ad00d2013-02-18 00:19:033774--diff-algorithm={patience|minimal|histogram|myers}
3775</dt>
3776<dd>
3777<p>
3778 Choose a diff algorithm. The variants are as follows:
3779</p>
3780<div class="openblock">
3781<div class="content">
3782<div class="dlist"><dl>
3783<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:513784<code>default</code>, <code>myers</code>
Junio C Hamano80ad00d2013-02-18 00:19:033785</dt>
3786<dd>
3787<p>
3788 The basic greedy diff algorithm. Currently, this is the default.
3789</p>
3790</dd>
3791<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:513792<code>minimal</code>
Junio C Hamano80ad00d2013-02-18 00:19:033793</dt>
3794<dd>
3795<p>
3796 Spend extra time to make sure the smallest possible diff is
3797 produced.
3798</p>
3799</dd>
3800<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:513801<code>patience</code>
Junio C Hamano80ad00d2013-02-18 00:19:033802</dt>
3803<dd>
3804<p>
3805 Use "patience diff" algorithm when generating patches.
3806</p>
3807</dd>
3808<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:513809<code>histogram</code>
Junio C Hamano80ad00d2013-02-18 00:19:033810</dt>
3811<dd>
3812<p>
3813 This algorithm extends the patience algorithm to "support
3814 low-occurrence common elements".
3815</p>
3816</dd>
3817</dl></div>
3818</div></div>
Junio C Hamano14e66832018-06-18 18:32:193819<div class="paragraph"><p>For instance, if you configured the <code>diff.algorithm</code> variable to a
Junio C Hamano80ad00d2013-02-18 00:19:033820non-default value and want to use the default one, then you
Junio C Hamanoac12f0e2014-09-19 22:32:513821have to use <code>--diff-algorithm=default</code> option.</p></div>
Junio C Hamano80ad00d2013-02-18 00:19:033822</dd>
3823<dt class="hdlist1">
Junio C Hamano4c4b0122011-06-30 01:19:323824--stat[=&lt;width&gt;[,&lt;name-width&gt;[,&lt;count&gt;]]]
Junio C Hamanod2c978f2011-03-20 19:42:223825</dt>
3826<dd>
3827<p>
Junio C Hamanoaea9e6b2012-03-07 00:17:113828 Generate a diffstat. By default, as much space as necessary
3829 will be used for the filename part, and the rest for the graph
3830 part. Maximum width defaults to terminal width, or 80 columns
Junio C Hamano7f2b3cb2012-06-22 22:42:393831 if not connected to a terminal, and can be overridden by
Junio C Hamanoac12f0e2014-09-19 22:32:513832 <code>&lt;width&gt;</code>. The width of the filename part can be limited by
3833 giving another width <code>&lt;name-width&gt;</code> after a comma. The width
Junio C Hamanoaea9e6b2012-03-07 00:17:113834 of the graph part can be limited by using
Junio C Hamanoac12f0e2014-09-19 22:32:513835 <code>--stat-graph-width=&lt;width&gt;</code> (affects all commands generating
3836 a stat graph) or by setting <code>diff.statGraphWidth=&lt;width&gt;</code>
3837 (does not affect <code>git format-patch</code>).
3838 By giving a third parameter <code>&lt;count&gt;</code>, you can limit the
3839 output to the first <code>&lt;count&gt;</code> lines, followed by <code>...</code> if
Junio C Hamanoaea9e6b2012-03-07 00:17:113840 there are more.
Junio C Hamanod2c978f2011-03-20 19:42:223841</p>
Junio C Hamanoac12f0e2014-09-19 22:32:513842<div class="paragraph"><p>These parameters can also be set individually with <code>--stat-width=&lt;width&gt;</code>,
3843<code>--stat-name-width=&lt;name-width&gt;</code> and <code>--stat-count=&lt;count&gt;</code>.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:223844</dd>
3845<dt class="hdlist1">
Junio C Hamano45badf02018-03-14 21:56:413846--compact-summary
3847</dt>
3848<dd>
3849<p>
3850 Output a condensed summary of extended header information such
3851 as file creations or deletions ("new" or "gone", optionally "+l"
3852 if it&#8217;s a symlink) and mode changes ("+x" or "-x" for adding
3853 or removing executable bit respectively) in diffstat. The
Junio C Hamanofa2915c2018-06-19 19:50:183854 information is put between the filename part and the graph
Junio C Hamano45badf02018-03-14 21:56:413855 part. Implies <code>--stat</code>.
3856</p>
3857</dd>
3858<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:223859--numstat
3860</dt>
3861<dd>
3862<p>
Junio C Hamanoac12f0e2014-09-19 22:32:513863 Similar to <code>--stat</code>, but shows number of added and
Junio C Hamanod2c978f2011-03-20 19:42:223864 deleted lines in decimal notation and pathname without
3865 abbreviation, to make it more machine friendly. For
Junio C Hamanoac12f0e2014-09-19 22:32:513866 binary files, outputs two <code>-</code> instead of saying
3867 <code>0 0</code>.
Junio C Hamanod2c978f2011-03-20 19:42:223868</p>
3869</dd>
3870<dt class="hdlist1">
3871--shortstat
3872</dt>
3873<dd>
3874<p>
Junio C Hamanoac12f0e2014-09-19 22:32:513875 Output only the last line of the <code>--stat</code> format containing total
Junio C Hamanod2c978f2011-03-20 19:42:223876 number of modified files, as well as number of added and deleted
3877 lines.
3878</p>
3879</dd>
3880<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:003881-X[&lt;param1,param2,&#8230;&gt;]
3882</dt>
3883<dt class="hdlist1">
Junio C Hamano1c222c52011-05-13 19:55:323884--dirstat[=&lt;param1,param2,&#8230;&gt;]
Junio C Hamanod2c978f2011-03-20 19:42:223885</dt>
3886<dd>
3887<p>
Junio C Hamano1c222c52011-05-13 19:55:323888 Output the distribution of relative amount of changes for each
Junio C Hamanoac12f0e2014-09-19 22:32:513889 sub-directory. The behavior of <code>--dirstat</code> can be customized by
Junio C Hamano1c222c52011-05-13 19:55:323890 passing it a comma separated list of parameters.
Junio C Hamanoac12f0e2014-09-19 22:32:513891 The defaults are controlled by the <code>diff.dirstat</code> configuration
Junio C Hamanoa28a9202012-06-21 07:08:233892 variable (see <a href="git-config.html">git-config(1)</a>).
Junio C Hamano1c222c52011-05-13 19:55:323893 The following parameters are available:
Junio C Hamanod2c978f2011-03-20 19:42:223894</p>
Junio C Hamano9629d4f2012-12-19 00:28:273895<div class="openblock">
3896<div class="content">
Junio C Hamano1c222c52011-05-13 19:55:323897<div class="dlist"><dl>
3898<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:513899<code>changes</code>
Junio C Hamano1c222c52011-05-13 19:55:323900</dt>
3901<dd>
3902<p>
3903 Compute the dirstat numbers by counting the lines that have been
3904 removed from the source, or added to the destination. This ignores
3905 the amount of pure code movements within a file. In other words,
3906 rearranging lines in a file is not counted as much as other changes.
3907 This is the default behavior when no parameter is given.
3908</p>
Junio C Hamanod2c978f2011-03-20 19:42:223909</dd>
3910<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:513911<code>lines</code>
Junio C Hamanod2c978f2011-03-20 19:42:223912</dt>
3913<dd>
3914<p>
Junio C Hamano1c222c52011-05-13 19:55:323915 Compute the dirstat numbers by doing the regular line-based diff
3916 analysis, and summing the removed/added line counts. (For binary
3917 files, count 64-byte chunks instead, since binary files have no
Junio C Hamanoac12f0e2014-09-19 22:32:513918 natural concept of lines). This is a more expensive <code>--dirstat</code>
3919 behavior than the <code>changes</code> behavior, but it does count rearranged
Junio C Hamano1c222c52011-05-13 19:55:323920 lines within a file as much as other changes. The resulting output
Junio C Hamanoac12f0e2014-09-19 22:32:513921 is consistent with what you get from the other <code>--*stat</code> options.
Junio C Hamanod2c978f2011-03-20 19:42:223922</p>
3923</dd>
3924<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:513925<code>files</code>
Junio C Hamano1c222c52011-05-13 19:55:323926</dt>
3927<dd>
3928<p>
3929 Compute the dirstat numbers by counting the number of files changed.
3930 Each changed file counts equally in the dirstat analysis. This is
Junio C Hamanoac12f0e2014-09-19 22:32:513931 the computationally cheapest <code>--dirstat</code> behavior, since it does
Junio C Hamano1c222c52011-05-13 19:55:323932 not have to look at the file contents at all.
3933</p>
3934</dd>
3935<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:513936<code>cumulative</code>
Junio C Hamano1c222c52011-05-13 19:55:323937</dt>
3938<dd>
3939<p>
3940 Count changes in a child directory for the parent directory as well.
Junio C Hamanoac12f0e2014-09-19 22:32:513941 Note that when using <code>cumulative</code>, the sum of the percentages
Junio C Hamano1c222c52011-05-13 19:55:323942 reported may exceed 100%. The default (non-cumulative) behavior can
Junio C Hamanoac12f0e2014-09-19 22:32:513943 be specified with the <code>noncumulative</code> parameter.
Junio C Hamano1c222c52011-05-13 19:55:323944</p>
3945</dd>
3946<dt class="hdlist1">
3947&lt;limit&gt;
3948</dt>
3949<dd>
3950<p>
3951 An integer parameter specifies a cut-off percent (3% by default).
3952 Directories contributing less than this percentage of the changes
3953 are not shown in the output.
3954</p>
3955</dd>
3956</dl></div>
Junio C Hamano9629d4f2012-12-19 00:28:273957</div></div>
Junio C Hamano1c222c52011-05-13 19:55:323958<div class="paragraph"><p>Example: The following will count changed files, while ignoring
3959directories with less than 10% of the total amount of changed files,
3960and accumulating child directory counts in the parent directories:
Junio C Hamanoac12f0e2014-09-19 22:32:513961<code>--dirstat=files,10,cumulative</code>.</p></div>
Junio C Hamano1c222c52011-05-13 19:55:323962</dd>
3963<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:003964--cumulative
3965</dt>
3966<dd>
3967<p>
3968 Synonym for --dirstat=cumulative
3969</p>
3970</dd>
3971<dt class="hdlist1">
3972--dirstat-by-file[=&lt;param1,param2&gt;&#8230;]
3973</dt>
3974<dd>
3975<p>
3976 Synonym for --dirstat=files,param1,param2&#8230;
3977</p>
3978</dd>
3979<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:223980--summary
3981</dt>
3982<dd>
3983<p>
3984 Output a condensed summary of extended header information
3985 such as creations, renames and mode changes.
3986</p>
3987</dd>
3988<dt class="hdlist1">
3989--patch-with-stat
3990</dt>
3991<dd>
3992<p>
Junio C Hamanoac12f0e2014-09-19 22:32:513993 Synonym for <code>-p --stat</code>.
Junio C Hamanod2c978f2011-03-20 19:42:223994</p>
3995</dd>
3996<dt class="hdlist1">
3997-z
3998</dt>
3999<dd>
4000<p>
4001 Separate the commits with NULs instead of with new newlines.
4002</p>
Junio C Hamanoac12f0e2014-09-19 22:32:514003<div class="paragraph"><p>Also, when <code>--raw</code> or <code>--numstat</code> has been given, do not munge
Junio C Hamanod2c978f2011-03-20 19:42:224004pathnames and use NULs as output field terminators.</p></div>
Junio C Hamano0f6f3bf2017-03-13 07:01:534005<div class="paragraph"><p>Without this option, pathnames with "unusual" characters are quoted as
4006explained for the configuration variable <code>core.quotePath</code> (see
4007<a href="git-config.html">git-config(1)</a>).</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:224008</dd>
4009<dt class="hdlist1">
4010--name-only
4011</dt>
4012<dd>
4013<p>
Junio C Hamano4078a552021-04-30 06:08:104014 Show only names of changed files. The file names are often encoded in UTF-8.
4015 For more information see the discussion about encoding in the <a href="git-log.html">git-log(1)</a>
4016 manual page.
Junio C Hamanod2c978f2011-03-20 19:42:224017</p>
4018</dd>
4019<dt class="hdlist1">
4020--name-status
4021</dt>
4022<dd>
4023<p>
4024 Show only names and status of changed files. See the description
Junio C Hamanoac12f0e2014-09-19 22:32:514025 of the <code>--diff-filter</code> option on what the status letters mean.
Junio C Hamano4078a552021-04-30 06:08:104026 Just like <code>--name-only</code> the file names are often encoded in UTF-8.
Junio C Hamanod2c978f2011-03-20 19:42:224027</p>
4028</dd>
4029<dt class="hdlist1">
4030--submodule[=&lt;format&gt;]
4031</dt>
4032<dd>
4033<p>
Junio C Hamanocd451662016-09-13 00:54:094034 Specify how differences in submodules are shown. When specifying
4035 <code>--submodule=short</code> the <em>short</em> format is used. This format just
4036 shows the names of the commits at the beginning and end of the range.
4037 When <code>--submodule</code> or <code>--submodule=log</code> is specified, the <em>log</em>
4038 format is used. This format lists the commits in the range like
4039 <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code> does. When <code>--submodule=diff</code>
4040 is specified, the <em>diff</em> format is used. This format shows an
4041 inline diff of the changes in the submodule contents between the
4042 commit range. Defaults to <code>diff.submodule</code> or the <em>short</em> format
4043 if the config option is unset.
Junio C Hamanod2c978f2011-03-20 19:42:224044</p>
4045</dd>
4046<dt class="hdlist1">
4047--color[=&lt;when&gt;]
4048</dt>
4049<dd>
4050<p>
4051 Show colored diff.
Junio C Hamanoac12f0e2014-09-19 22:32:514052 <code>--color</code> (i.e. without <em>=&lt;when&gt;</em>) is the same as <code>--color=always</code>.
4053 <em>&lt;when&gt;</em> can be one of <code>always</code>, <code>never</code>, or <code>auto</code>.
Junio C Hamanod2c978f2011-03-20 19:42:224054</p>
4055</dd>
4056<dt class="hdlist1">
4057--no-color
4058</dt>
4059<dd>
4060<p>
Junio C Hamano5f2627d2011-05-06 20:23:484061 Turn off colored diff.
Junio C Hamanoac12f0e2014-09-19 22:32:514062 It is the same as <code>--color=never</code>.
Junio C Hamanod2c978f2011-03-20 19:42:224063</p>
4064</dd>
4065<dt class="hdlist1">
Junio C Hamanofb1fdf12017-08-27 06:14:594066--color-moved[=&lt;mode&gt;]
4067</dt>
4068<dd>
4069<p>
4070 Moved lines of code are colored differently.
4071 The &lt;mode&gt; defaults to <em>no</em> if the option is not given
4072 and to <em>zebra</em> if the option with no mode is given.
4073 The mode must be one of:
4074</p>
4075<div class="openblock">
4076<div class="content">
4077<div class="dlist"><dl>
4078<dt class="hdlist1">
4079no
4080</dt>
4081<dd>
4082<p>
4083 Moved lines are not highlighted.
4084</p>
4085</dd>
4086<dt class="hdlist1">
4087default
4088</dt>
4089<dd>
4090<p>
4091 Is a synonym for <code>zebra</code>. This may change to a more sensible mode
4092 in the future.
4093</p>
4094</dd>
4095<dt class="hdlist1">
4096plain
4097</dt>
4098<dd>
4099<p>
4100 Any line that is added in one location and was removed
4101 in another location will be colored with <em>color.diff.newMoved</em>.
4102 Similarly <em>color.diff.oldMoved</em> will be used for removed lines
4103 that are added somewhere else in the diff. This mode picks up any
4104 moved line, but it is not very useful in a review to determine
4105 if a block of code was moved without permutation.
4106</p>
4107</dd>
4108<dt class="hdlist1">
Junio C Hamanof09b7cd2018-08-02 23:01:454109blocks
Junio C Hamanofb1fdf12017-08-27 06:14:594110</dt>
4111<dd>
4112<p>
4113 Blocks of moved text of at least 20 alphanumeric characters
4114 are detected greedily. The detected blocks are
Junio C Hamanof09b7cd2018-08-02 23:01:454115 painted using either the <em>color.diff.{old,new}Moved</em> color.
4116 Adjacent blocks cannot be told apart.
4117</p>
4118</dd>
4119<dt class="hdlist1">
4120zebra
4121</dt>
4122<dd>
4123<p>
4124 Blocks of moved text are detected as in <em>blocks</em> mode. The blocks
4125 are painted using either the <em>color.diff.{old,new}Moved</em> color or
Junio C Hamanofb1fdf12017-08-27 06:14:594126 <em>color.diff.{old,new}MovedAlternative</em>. The change between
4127 the two colors indicates that a new block was detected.
4128</p>
4129</dd>
4130<dt class="hdlist1">
Junio C Hamanobfd91f42018-08-17 22:21:164131dimmed-zebra
Junio C Hamanofb1fdf12017-08-27 06:14:594132</dt>
4133<dd>
4134<p>
4135 Similar to <em>zebra</em>, but additional dimming of uninteresting parts
4136 of moved code is performed. The bordering lines of two adjacent
4137 blocks are considered interesting, the rest is uninteresting.
Junio C Hamanobfd91f42018-08-17 22:21:164138 <code>dimmed_zebra</code> is a deprecated synonym.
Junio C Hamanofb1fdf12017-08-27 06:14:594139</p>
4140</dd>
4141</dl></div>
4142</div></div>
4143</dd>
4144<dt class="hdlist1">
Junio C Hamanoa90214f2019-01-28 22:05:254145--no-color-moved
4146</dt>
4147<dd>
4148<p>
4149 Turn off move detection. This can be used to override configuration
4150 settings. It is the same as <code>--color-moved=no</code>.
4151</p>
4152</dd>
4153<dt class="hdlist1">
Junio C Hamanof09b7cd2018-08-02 23:01:454154--color-moved-ws=&lt;modes&gt;
4155</dt>
4156<dd>
4157<p>
Junio C Hamanoa90214f2019-01-28 22:05:254158 This configures how whitespace is ignored when performing the
Junio C Hamanof09b7cd2018-08-02 23:01:454159 move detection for <code>--color-moved</code>.
4160 These modes can be given as a comma separated list:
4161</p>
4162<div class="openblock">
4163<div class="content">
4164<div class="dlist"><dl>
4165<dt class="hdlist1">
Junio C Hamanoa90214f2019-01-28 22:05:254166no
4167</dt>
4168<dd>
4169<p>
4170 Do not ignore whitespace when performing move detection.
4171</p>
4172</dd>
4173<dt class="hdlist1">
Junio C Hamanof09b7cd2018-08-02 23:01:454174ignore-space-at-eol
4175</dt>
4176<dd>
4177<p>
4178 Ignore changes in whitespace at EOL.
4179</p>
4180</dd>
4181<dt class="hdlist1">
4182ignore-space-change
4183</dt>
4184<dd>
4185<p>
4186 Ignore changes in amount of whitespace. This ignores whitespace
4187 at line end, and considers all other sequences of one or
4188 more whitespace characters to be equivalent.
4189</p>
4190</dd>
4191<dt class="hdlist1">
4192ignore-all-space
4193</dt>
4194<dd>
4195<p>
4196 Ignore whitespace when comparing lines. This ignores differences
4197 even if one line has whitespace where the other line has none.
4198</p>
4199</dd>
4200<dt class="hdlist1">
4201allow-indentation-change
4202</dt>
4203<dd>
4204<p>
Junio C Hamanoa90214f2019-01-28 22:05:254205 Initially ignore any whitespace in the move detection, then
Junio C Hamanof09b7cd2018-08-02 23:01:454206 group the moved code blocks only into a block if the change in
4207 whitespace is the same per line. This is incompatible with the
4208 other modes.
4209</p>
4210</dd>
4211</dl></div>
4212</div></div>
4213</dd>
4214<dt class="hdlist1">
Junio C Hamanoa90214f2019-01-28 22:05:254215--no-color-moved-ws
4216</dt>
4217<dd>
4218<p>
4219 Do not ignore whitespace when performing move detection. This can be
4220 used to override configuration settings. It is the same as
4221 <code>--color-moved-ws=no</code>.
4222</p>
4223</dd>
4224<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:224225--word-diff[=&lt;mode&gt;]
4226</dt>
4227<dd>
4228<p>
4229 Show a word diff, using the &lt;mode&gt; to delimit changed words.
4230 By default, words are delimited by whitespace; see
Junio C Hamanoac12f0e2014-09-19 22:32:514231 <code>--word-diff-regex</code> below. The &lt;mode&gt; defaults to <em>plain</em>, and
Junio C Hamanod2c978f2011-03-20 19:42:224232 must be one of:
4233</p>
Junio C Hamano9629d4f2012-12-19 00:28:274234<div class="openblock">
4235<div class="content">
Junio C Hamanod2c978f2011-03-20 19:42:224236<div class="dlist"><dl>
4237<dt class="hdlist1">
4238color
4239</dt>
4240<dd>
4241<p>
Junio C Hamanoac12f0e2014-09-19 22:32:514242 Highlight changed words using only colors. Implies <code>--color</code>.
Junio C Hamanod2c978f2011-03-20 19:42:224243</p>
4244</dd>
4245<dt class="hdlist1">
4246plain
4247</dt>
4248<dd>
4249<p>
Junio C Hamanoac12f0e2014-09-19 22:32:514250 Show words as <code>[-removed-]</code> and <code>{+added+}</code>. Makes no
Junio C Hamanod2c978f2011-03-20 19:42:224251 attempts to escape the delimiters if they appear in the input,
4252 so the output may be ambiguous.
4253</p>
4254</dd>
4255<dt class="hdlist1">
4256porcelain
4257</dt>
4258<dd>
4259<p>
4260 Use a special line-based format intended for script
4261 consumption. Added/removed/unchanged runs are printed in the
Junio C Hamanoac12f0e2014-09-19 22:32:514262 usual unified diff format, starting with a <code>+</code>/<code>-</code>/` `
Junio C Hamanod2c978f2011-03-20 19:42:224263 character at the beginning of the line and extending to the
4264 end of the line. Newlines in the input are represented by a
Junio C Hamanoac12f0e2014-09-19 22:32:514265 tilde <code>~</code> on a line of its own.
Junio C Hamanod2c978f2011-03-20 19:42:224266</p>
4267</dd>
4268<dt class="hdlist1">
4269none
4270</dt>
4271<dd>
4272<p>
4273 Disable word diff again.
4274</p>
4275</dd>
4276</dl></div>
Junio C Hamano9629d4f2012-12-19 00:28:274277</div></div>
Junio C Hamanod2c978f2011-03-20 19:42:224278<div class="paragraph"><p>Note that despite the name of the first mode, color is used to
4279highlight the changed parts in all modes if enabled.</p></div>
4280</dd>
4281<dt class="hdlist1">
4282--word-diff-regex=&lt;regex&gt;
4283</dt>
4284<dd>
4285<p>
4286 Use &lt;regex&gt; to decide what a word is, instead of considering
4287 runs of non-whitespace to be a word. Also implies
Junio C Hamanoac12f0e2014-09-19 22:32:514288 <code>--word-diff</code> unless it was already enabled.
Junio C Hamanod2c978f2011-03-20 19:42:224289</p>
4290<div class="paragraph"><p>Every non-overlapping match of the
4291&lt;regex&gt; is considered a word. Anything between these matches is
4292considered whitespace and ignored(!) for the purposes of finding
Junio C Hamanoac12f0e2014-09-19 22:32:514293differences. You may want to append <code>|[^[:space:]]</code> to your regular
Junio C Hamanod2c978f2011-03-20 19:42:224294expression to make sure that it matches all non-whitespace characters.
4295A match that contains a newline is silently truncated(!) at the
4296newline.</p></div>
Junio C Hamano713eded2015-12-03 00:24:024297<div class="paragraph"><p>For example, <code>--word-diff-regex=.</code> will treat each character as a word
4298and, correspondingly, show differences character by character.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:224299<div class="paragraph"><p>The regex can also be set via a diff driver or configuration option, see
Junio C Hamano198b1f12016-05-17 22:27:244300<a href="gitattributes.html">gitattributes(5)</a> or <a href="git-config.html">git-config(1)</a>. Giving it explicitly
Junio C Hamanod2c978f2011-03-20 19:42:224301overrides any diff driver or configuration setting. Diff drivers
4302override configuration settings.</p></div>
4303</dd>
4304<dt class="hdlist1">
4305--color-words[=&lt;regex&gt;]
4306</dt>
4307<dd>
4308<p>
Junio C Hamanoac12f0e2014-09-19 22:32:514309 Equivalent to <code>--word-diff=color</code> plus (if a regex was
4310 specified) <code>--word-diff-regex=&lt;regex&gt;</code>.
Junio C Hamanod2c978f2011-03-20 19:42:224311</p>
4312</dd>
4313<dt class="hdlist1">
4314--no-renames
4315</dt>
4316<dd>
4317<p>
4318 Turn off rename detection, even when the configuration
4319 file gives the default to do so.
4320</p>
4321</dd>
4322<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:004323--[no-]rename-empty
4324</dt>
4325<dd>
4326<p>
4327 Whether to use empty blobs as rename source.
4328</p>
4329</dd>
4330<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:224331--check
4332</dt>
4333<dd>
4334<p>
Junio C Hamano84ea1e42016-04-08 21:53:484335 Warn if changes introduce conflict markers or whitespace errors.
4336 What are considered whitespace errors is controlled by <code>core.whitespace</code>
Junio C Hamano6005bfa2011-06-23 00:51:224337 configuration. By default, trailing whitespaces (including
Junio C Hamano14e66832018-06-18 18:32:194338 lines that consist solely of whitespaces) and a space character
Junio C Hamano6005bfa2011-06-23 00:51:224339 that is immediately followed by a tab character inside the
4340 initial indent of the line are considered whitespace errors.
4341 Exits with non-zero status if problems are found. Not compatible
4342 with --exit-code.
Junio C Hamanod2c978f2011-03-20 19:42:224343</p>
4344</dd>
4345<dt class="hdlist1">
Junio C Hamano8c5d5942015-06-11 19:37:484346--ws-error-highlight=&lt;kind&gt;
4347</dt>
4348<dd>
4349<p>
Junio C Hamano4b2a6c12017-08-22 18:32:374350 Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
4351 lines of the diff. Multiple values are separated by comma,
4352 <code>none</code> resets previous values, <code>default</code> reset the list to
4353 <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>. When
4354 this option is not given, and the configuration variable
4355 <code>diff.wsErrorHighlight</code> is not set, only whitespace errors in
4356 <code>new</code> lines are highlighted. The whitespace errors are colored
Junio C Hamano14e66832018-06-18 18:32:194357 with <code>color.diff.whitespace</code>.
Junio C Hamano8c5d5942015-06-11 19:37:484358</p>
4359</dd>
4360<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:224361--full-index
4362</dt>
4363<dd>
4364<p>
4365 Instead of the first handful of characters, show the full
4366 pre- and post-image blob object names on the "index"
4367 line when generating patch format output.
4368</p>
4369</dd>
4370<dt class="hdlist1">
4371--binary
4372</dt>
4373<dd>
4374<p>
Junio C Hamanoac12f0e2014-09-19 22:32:514375 In addition to <code>--full-index</code>, output a binary diff that
Junio C Hamanoee43d182020-11-11 22:10:414376 can be applied with <code>git-apply</code>.
4377 Implies <code>--patch</code>.
Junio C Hamanod2c978f2011-03-20 19:42:224378</p>
4379</dd>
4380<dt class="hdlist1">
4381--abbrev[=&lt;n&gt;]
4382</dt>
4383<dd>
4384<p>
4385 Instead of showing the full 40-byte hexadecimal object
4386 name in diff-raw format output and diff-tree header
Junio C Hamanoee43d182020-11-11 22:10:414387 lines, show the shortest prefix that is at least <em>&lt;n&gt;</em>
4388 hexdigits long that uniquely refers the object.
Junio C Hamanocf8aeaf2020-08-31 23:16:354389 In diff-patch output format, <code>--full-index</code> takes higher
4390 precedence, i.e. if <code>--full-index</code> is specified, full blob
4391 names will be shown regardless of <code>--abbrev</code>.
4392 Non default number of digits can be specified with <code>--abbrev=&lt;n&gt;</code>.
Junio C Hamanod2c978f2011-03-20 19:42:224393</p>
4394</dd>
4395<dt class="hdlist1">
4396-B[&lt;n&gt;][/&lt;m&gt;]
4397</dt>
4398<dt class="hdlist1">
4399--break-rewrites[=[&lt;n&gt;][/&lt;m&gt;]]
4400</dt>
4401<dd>
4402<p>
4403 Break complete rewrite changes into pairs of delete and
4404 create. This serves two purposes:
4405</p>
4406<div class="paragraph"><p>It affects the way a change that amounts to a total rewrite of a file
4407not as a series of deletion and insertion mixed together with a very
4408few lines that happen to match textually as the context, but as a
4409single deletion of everything old followed by a single insertion of
Junio C Hamanoac12f0e2014-09-19 22:32:514410everything new, and the number <code>m</code> controls this aspect of the -B
4411option (defaults to 60%). <code>-B/70%</code> specifies that less than 30% of the
Junio C Hamano076ffcc2013-02-06 05:13:214412original should remain in the result for Git to consider it a total
Junio C Hamanod2c978f2011-03-20 19:42:224413rewrite (i.e. otherwise the resulting patch will be a series of
4414deletion and insertion mixed together with context lines).</p></div>
4415<div class="paragraph"><p>When used with -M, a totally-rewritten file is also considered as the
4416source of a rename (usually -M only considers a file that disappeared
Junio C Hamanoac12f0e2014-09-19 22:32:514417as the source of a rename), and the number <code>n</code> controls this aspect of
4418the -B option (defaults to 50%). <code>-B20%</code> specifies that a change with
Junio C Hamanod2c978f2011-03-20 19:42:224419addition and deletion compared to 20% or more of the file&#8217;s size are
4420eligible for being picked up as a possible source of a rename to
4421another file.</p></div>
4422</dd>
4423<dt class="hdlist1">
4424-M[&lt;n&gt;]
4425</dt>
4426<dt class="hdlist1">
4427--find-renames[=&lt;n&gt;]
4428</dt>
4429<dd>
4430<p>
4431 If generating diffs, detect and report renames for each commit.
4432 For following files across renames while traversing history, see
Junio C Hamanoac12f0e2014-09-19 22:32:514433 <code>--follow</code>.
4434 If <code>n</code> is specified, it is a threshold on the similarity
Junio C Hamanod2c978f2011-03-20 19:42:224435 index (i.e. amount of addition/deletions compared to the
Junio C Hamanoac12f0e2014-09-19 22:32:514436 file&#8217;s size). For example, <code>-M90%</code> means Git should consider a
Junio C Hamanod2c978f2011-03-20 19:42:224437 delete/add pair to be a rename if more than 90% of the file
Junio C Hamanoac12f0e2014-09-19 22:32:514438 hasn&#8217;t changed. Without a <code>%</code> sign, the number is to be read as
4439 a fraction, with a decimal point before it. I.e., <code>-M5</code> becomes
4440 0.5, and is thus the same as <code>-M50%</code>. Similarly, <code>-M05</code> is
4441 the same as <code>-M5%</code>. To limit detection to exact renames, use
4442 <code>-M100%</code>. The default similarity index is 50%.
Junio C Hamanod2c978f2011-03-20 19:42:224443</p>
4444</dd>
4445<dt class="hdlist1">
4446-C[&lt;n&gt;]
4447</dt>
4448<dt class="hdlist1">
4449--find-copies[=&lt;n&gt;]
4450</dt>
4451<dd>
4452<p>
Junio C Hamanoac12f0e2014-09-19 22:32:514453 Detect copies as well as renames. See also <code>--find-copies-harder</code>.
4454 If <code>n</code> is specified, it has the same meaning as for <code>-M&lt;n&gt;</code>.
Junio C Hamanod2c978f2011-03-20 19:42:224455</p>
4456</dd>
4457<dt class="hdlist1">
4458--find-copies-harder
4459</dt>
4460<dd>
4461<p>
Junio C Hamanoac12f0e2014-09-19 22:32:514462 For performance reasons, by default, <code>-C</code> option finds copies only
Junio C Hamanod2c978f2011-03-20 19:42:224463 if the original file of the copy was modified in the same
4464 changeset. This flag makes the command
4465 inspect unmodified files as candidates for the source of
4466 copy. This is a very expensive operation for large
4467 projects, so use it with caution. Giving more than one
Junio C Hamanoac12f0e2014-09-19 22:32:514468 <code>-C</code> option has the same effect.
Junio C Hamanod2c978f2011-03-20 19:42:224469</p>
4470</dd>
4471<dt class="hdlist1">
Junio C Hamanob02377c2011-04-28 22:26:024472-D
4473</dt>
4474<dt class="hdlist1">
4475--irreversible-delete
4476</dt>
4477<dd>
4478<p>
4479 Omit the preimage for deletes, i.e. print only the header but not
Junio C Hamanoac12f0e2014-09-19 22:32:514480 the diff between the preimage and <code>/dev/null</code>. The resulting patch
4481 is not meant to be applied with <code>patch</code> or <code>git apply</code>; this is
Junio C Hamanob02377c2011-04-28 22:26:024482 solely for people who want to just concentrate on reviewing the
Junio C Hamanod16fd1b2017-08-04 16:41:514483 text after the change. In addition, the output obviously lacks
Junio C Hamanob02377c2011-04-28 22:26:024484 enough information to apply such a patch in reverse, even manually,
4485 hence the name of the option.
4486</p>
Junio C Hamanoac12f0e2014-09-19 22:32:514487<div class="paragraph"><p>When used together with <code>-B</code>, omit also the preimage in the deletion part
Junio C Hamanob02377c2011-04-28 22:26:024488of a delete/create pair.</p></div>
4489</dd>
4490<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:224491-l&lt;num&gt;
4492</dt>
4493<dd>
4494<p>
Junio C Hamano20cf4932021-07-28 21:02:524495 The <code>-M</code> and <code>-C</code> options involve some preliminary steps that
4496 can detect subsets of renames/copies cheaply, followed by an
4497 exhaustive fallback portion that compares all remaining
4498 unpaired destinations to all relevant sources. (For renames,
4499 only remaining unpaired sources are relevant; for copies, all
4500 original sources are relevant.) For N sources and
4501 destinations, this exhaustive check is O(N^2). This option
4502 prevents the exhaustive portion of rename/copy detection from
4503 running if the number of source/destination files involved
4504 exceeds the specified number. Defaults to diff.renameLimit.
4505 Note that a value of 0 is treated as unlimited.
Junio C Hamanod2c978f2011-03-20 19:42:224506</p>
4507</dd>
4508<dt class="hdlist1">
4509--diff-filter=[(A|C|D|M|R|T|U|X|B)&#8230;[*]]
4510</dt>
4511<dd>
4512<p>
Junio C Hamanoac12f0e2014-09-19 22:32:514513 Select only files that are Added (<code>A</code>), Copied (<code>C</code>),
4514 Deleted (<code>D</code>), Modified (<code>M</code>), Renamed (<code>R</code>), have their
4515 type (i.e. regular file, symlink, submodule, &#8230;) changed (<code>T</code>),
4516 are Unmerged (<code>U</code>), are
4517 Unknown (<code>X</code>), or have had their pairing Broken (<code>B</code>).
Junio C Hamanod2c978f2011-03-20 19:42:224518 Any combination of the filter characters (including none) can be used.
Junio C Hamanoac12f0e2014-09-19 22:32:514519 When <code>*</code> (All-or-none) is added to the combination, all
Junio C Hamanod2c978f2011-03-20 19:42:224520 paths are selected if there is any file that matches
4521 other criteria in the comparison; if there is no file
4522 that matches other criteria, nothing is selected.
4523</p>
Junio C Hamanoeed15af2016-07-25 22:49:424524<div class="paragraph"><p>Also, these upper-case letters can be downcased to exclude. E.g.
4525<code>--diff-filter=ad</code> excludes added and deleted paths.</p></div>
Junio C Hamanof1fc6ca2022-02-17 01:32:334526<div class="paragraph"><p>Note that not all diffs can feature all types. For instance, copied and
4527renamed entries cannot appear if detection for those types is disabled.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:224528</dd>
4529<dt class="hdlist1">
4530-S&lt;string&gt;
4531</dt>
4532<dd>
4533<p>
Junio C Hamanof1f5a7b2013-06-11 22:23:524534 Look for differences that change the number of occurrences of
4535 the specified string (i.e. addition/deletion) in a file.
4536 Intended for the scripter&#8217;s use.
Junio C Hamanod2c978f2011-03-20 19:42:224537</p>
Junio C Hamanof1f5a7b2013-06-11 22:23:524538<div class="paragraph"><p>It is useful when you&#8217;re looking for an exact block of code (like a
4539struct), and want to know the history of that block since it first
4540came into being: use the feature iteratively to feed the interesting
Junio C Hamanoac12f0e2014-09-19 22:32:514541block in the preimage back into <code>-S</code>, and keep going until you get the
Junio C Hamanof1f5a7b2013-06-11 22:23:524542very first version of the block.</p></div>
Junio C Hamanoace33e42019-01-18 23:16:054543<div class="paragraph"><p>Binary files are searched as well.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:224544</dd>
4545<dt class="hdlist1">
4546-G&lt;regex&gt;
4547</dt>
4548<dd>
4549<p>
Junio C Hamanof1f5a7b2013-06-11 22:23:524550 Look for differences whose patch text contains added/removed
4551 lines that match &lt;regex&gt;.
Junio C Hamanod2c978f2011-03-20 19:42:224552</p>
Junio C Hamanoac12f0e2014-09-19 22:32:514553<div class="paragraph"><p>To illustrate the difference between <code>-S&lt;regex&gt; --pickaxe-regex</code> and
4554<code>-G&lt;regex&gt;</code>, consider a commit with the following diff in the same
Junio C Hamanof1f5a7b2013-06-11 22:23:524555file:</p></div>
4556<div class="listingblock">
4557<div class="content">
Junio C Hamanob7e497f2020-02-12 21:41:374558<pre><code>+ return frotz(nitfol, two-&gt;ptr, 1, 0);
Junio C Hamanof1f5a7b2013-06-11 22:23:524559...
Junio C Hamanob7e497f2020-02-12 21:41:374560- hit = frotz(nitfol, mf2.ptr, 1, 0);</code></pre>
Junio C Hamanof1f5a7b2013-06-11 22:23:524561</div></div>
Junio C Hamanob7e497f2020-02-12 21:41:374562<div class="paragraph"><p>While <code>git log -G"frotz\(nitfol"</code> will show this commit, <code>git log
4563-S"frotz\(nitfol" --pickaxe-regex</code> will not (because the number of
Junio C Hamanof1f5a7b2013-06-11 22:23:524564occurrences of that string did not change).</p></div>
Junio C Hamanoace33e42019-01-18 23:16:054565<div class="paragraph"><p>Unless <code>--text</code> is supplied patches of binary files without a textconv
4566filter will be ignored.</p></div>
Junio C Hamanof1f5a7b2013-06-11 22:23:524567<div class="paragraph"><p>See the <em>pickaxe</em> entry in <a href="gitdiffcore.html">gitdiffcore(7)</a> for more
4568information.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:224569</dd>
4570<dt class="hdlist1">
Junio C Hamano7b9cce92018-01-23 22:34:274571--find-object=&lt;object-id&gt;
4572</dt>
4573<dd>
4574<p>
4575 Look for differences that change the number of occurrences of
4576 the specified object. Similar to <code>-S</code>, just the argument is different
4577 in that it doesn&#8217;t search for a specific string but for a specific
4578 object id.
4579</p>
4580<div class="paragraph"><p>The object can be a blob or a submodule commit. It implies the <code>-t</code> option in
4581<code>git-log</code> to also find trees.</p></div>
4582</dd>
4583<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:224584--pickaxe-all
4585</dt>
4586<dd>
4587<p>
Junio C Hamanoac12f0e2014-09-19 22:32:514588 When <code>-S</code> or <code>-G</code> finds a change, show all the changes in that
Junio C Hamanod2c978f2011-03-20 19:42:224589 changeset, not just the files that contain the change
4590 in &lt;string&gt;.
4591</p>
4592</dd>
4593<dt class="hdlist1">
4594--pickaxe-regex
4595</dt>
4596<dd>
4597<p>
Junio C Hamanoac12f0e2014-09-19 22:32:514598 Treat the &lt;string&gt; given to <code>-S</code> as an extended POSIX regular
Junio C Hamanof1f5a7b2013-06-11 22:23:524599 expression to match.
Junio C Hamanod2c978f2011-03-20 19:42:224600</p>
4601</dd>
4602<dt class="hdlist1">
4603-O&lt;orderfile&gt;
4604</dt>
4605<dd>
4606<p>
Junio C Hamanobcd98f42017-01-24 00:12:164607 Control the order in which files appear in the output.
Junio C Hamano322c6242015-03-23 21:32:464608 This overrides the <code>diff.orderFile</code> configuration variable
4609 (see <a href="git-config.html">git-config(1)</a>). To cancel <code>diff.orderFile</code>,
Junio C Hamanoac12f0e2014-09-19 22:32:514610 use <code>-O/dev/null</code>.
Junio C Hamanod2c978f2011-03-20 19:42:224611</p>
Junio C Hamanobcd98f42017-01-24 00:12:164612<div class="paragraph"><p>The output order is determined by the order of glob patterns in
4613&lt;orderfile&gt;.
4614All files with pathnames that match the first pattern are output
4615first, all files with pathnames that match the second pattern (but not
4616the first) are output next, and so on.
4617All files with pathnames that do not match any pattern are output
4618last, as if there was an implicit match-all pattern at the end of the
4619file.
4620If multiple pathnames have the same rank (they match the same pattern
4621but no earlier patterns), their output order relative to each other is
4622the normal order.</p></div>
4623<div class="paragraph"><p>&lt;orderfile&gt; is parsed as follows:</p></div>
4624<div class="openblock">
4625<div class="content">
4626<div class="ulist"><ul>
4627<li>
4628<p>
4629Blank lines are ignored, so they can be used as separators for
4630 readability.
4631</p>
4632</li>
4633<li>
4634<p>
4635Lines starting with a hash ("<code>#</code>") are ignored, so they can be used
4636 for comments. Add a backslash ("<code>\</code>") to the beginning of the
4637 pattern if it starts with a hash.
4638</p>
4639</li>
4640<li>
4641<p>
4642Each other line contains a single pattern.
4643</p>
4644</li>
4645</ul></div>
4646</div></div>
4647<div class="paragraph"><p>Patterns have the same syntax and semantics as patterns used for
Junio C Hamano96153bf2018-04-25 08:25:344648fnmatch(3) without the FNM_PATHNAME flag, except a pathname also
Junio C Hamanobcd98f42017-01-24 00:12:164649matches a pattern if removing any number of the final pathname
4650components matches the pattern. For example, the pattern "<code>foo*bar</code>"
4651matches "<code>fooasdfbar</code>" and "<code>foo/bar/baz/asdf</code>" but not "<code>foobarx</code>".</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:224652</dd>
4653<dt class="hdlist1">
Junio C Hamanoa372d5b2021-02-26 01:34:374654--skip-to=&lt;file&gt;
4655</dt>
4656<dt class="hdlist1">
4657--rotate-to=&lt;file&gt;
4658</dt>
4659<dd>
4660<p>
4661 Discard the files before the named &lt;file&gt; from the output
4662 (i.e. <em>skip to</em>), or move them to the end of the output
4663 (i.e. <em>rotate to</em>). These were invented primarily for use
4664 of the <code>git difftool</code> command, and may not be very useful
4665 otherwise.
4666</p>
4667</dd>
4668<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:224669-R
4670</dt>
4671<dd>
4672<p>
4673 Swap two inputs; that is, show differences from index or
4674 on-disk file to tree contents.
4675</p>
4676</dd>
4677<dt class="hdlist1">
4678--relative[=&lt;path&gt;]
4679</dt>
Junio C Hamano3ef9e672020-06-02 21:51:314680<dt class="hdlist1">
4681--no-relative
4682</dt>
Junio C Hamanod2c978f2011-03-20 19:42:224683<dd>
4684<p>
4685 When run from a subdirectory of the project, it can be
4686 told to exclude changes outside the directory and show
4687 pathnames relative to it with this option. When you are
4688 not in a subdirectory (e.g. in a bare repository), you
4689 can name which subdirectory to make the output relative
4690 to by giving a &lt;path&gt; as an argument.
Junio C Hamano3ef9e672020-06-02 21:51:314691 <code>--no-relative</code> can be used to countermand both <code>diff.relative</code> config
4692 option and previous <code>--relative</code>.
Junio C Hamanod2c978f2011-03-20 19:42:224693</p>
4694</dd>
4695<dt class="hdlist1">
4696-a
4697</dt>
4698<dt class="hdlist1">
4699--text
4700</dt>
4701<dd>
4702<p>
4703 Treat all files as text.
4704</p>
4705</dd>
4706<dt class="hdlist1">
Junio C Hamano4886c772017-11-27 03:33:284707--ignore-cr-at-eol
4708</dt>
4709<dd>
4710<p>
Junio C Hamano96153bf2018-04-25 08:25:344711 Ignore carriage-return at the end of line when doing a comparison.
Junio C Hamano4886c772017-11-27 03:33:284712</p>
4713</dd>
4714<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:224715--ignore-space-at-eol
4716</dt>
4717<dd>
4718<p>
4719 Ignore changes in whitespace at EOL.
4720</p>
4721</dd>
4722<dt class="hdlist1">
4723-b
4724</dt>
4725<dt class="hdlist1">
4726--ignore-space-change
4727</dt>
4728<dd>
4729<p>
4730 Ignore changes in amount of whitespace. This ignores whitespace
4731 at line end, and considers all other sequences of one or
4732 more whitespace characters to be equivalent.
4733</p>
4734</dd>
4735<dt class="hdlist1">
4736-w
4737</dt>
4738<dt class="hdlist1">
4739--ignore-all-space
4740</dt>
4741<dd>
4742<p>
4743 Ignore whitespace when comparing lines. This ignores
4744 differences even if one line has whitespace where the other
4745 line has none.
4746</p>
4747</dd>
4748<dt class="hdlist1">
Junio C Hamanoa1952302013-07-01 21:31:184749--ignore-blank-lines
4750</dt>
4751<dd>
4752<p>
4753 Ignore changes whose lines are all blank.
4754</p>
4755</dd>
4756<dt class="hdlist1">
Junio C Hamanodf3d3cd2020-11-02 22:05:054757-I&lt;regex&gt;
4758</dt>
4759<dt class="hdlist1">
4760--ignore-matching-lines=&lt;regex&gt;
4761</dt>
4762<dd>
4763<p>
4764 Ignore changes whose all lines match &lt;regex&gt;. This option may
4765 be specified more than once.
4766</p>
4767</dd>
4768<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:224769--inter-hunk-context=&lt;lines&gt;
4770</dt>
4771<dd>
4772<p>
4773 Show the context between diff hunks, up to the specified number
4774 of lines, thereby fusing hunks that are close to each other.
Junio C Hamanobcd98f42017-01-24 00:12:164775 Defaults to <code>diff.interHunkContext</code> or 0 if the config option
4776 is unset.
Junio C Hamanod2c978f2011-03-20 19:42:224777</p>
4778</dd>
4779<dt class="hdlist1">
Junio C Hamano11821ed2011-10-19 18:42:094780-W
4781</dt>
4782<dt class="hdlist1">
4783--function-context
4784</dt>
4785<dd>
4786<p>
Junio C Hamanob7676d52020-11-18 22:15:084787 Show whole function as context lines for each change.
4788 The function names are determined in the same way as
4789 <code>git diff</code> works out patch hunk headers (see <em>Defining a
4790 custom hunk-header</em> in <a href="gitattributes.html">gitattributes(5)</a>).
Junio C Hamano11821ed2011-10-19 18:42:094791</p>
4792</dd>
4793<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:224794--ext-diff
4795</dt>
4796<dd>
4797<p>
4798 Allow an external diff helper to be executed. If you set an
Junio C Hamanoa28a9202012-06-21 07:08:234799 external diff driver with <a href="gitattributes.html">gitattributes(5)</a>, you need
4800 to use this option with <a href="git-log.html">git-log(1)</a> and friends.
Junio C Hamanod2c978f2011-03-20 19:42:224801</p>
4802</dd>
4803<dt class="hdlist1">
4804--no-ext-diff
4805</dt>
4806<dd>
4807<p>
4808 Disallow external diff drivers.
4809</p>
4810</dd>
4811<dt class="hdlist1">
Junio C Hamanoc652aed2011-07-07 01:14:314812--textconv
4813</dt>
4814<dt class="hdlist1">
4815--no-textconv
4816</dt>
4817<dd>
4818<p>
4819 Allow (or disallow) external text conversion filters to be run
Junio C Hamanoa28a9202012-06-21 07:08:234820 when comparing binary files. See <a href="gitattributes.html">gitattributes(5)</a> for
Junio C Hamanoc652aed2011-07-07 01:14:314821 details. Because textconv filters are typically a one-way
4822 conversion, the resulting diff is suitable for human
4823 consumption, but cannot be applied. For this reason, textconv
Junio C Hamanoa28a9202012-06-21 07:08:234824 filters are enabled by default only for <a href="git-diff.html">git-diff(1)</a> and
4825 <a href="git-log.html">git-log(1)</a>, but not for <a href="git-format-patch.html">git-format-patch(1)</a> or
Junio C Hamanoc652aed2011-07-07 01:14:314826 diff plumbing commands.
4827</p>
4828</dd>
4829<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:224830--ignore-submodules[=&lt;when&gt;]
4831</dt>
4832<dd>
4833<p>
4834 Ignore changes to submodules in the diff generation. &lt;when&gt; can be
Junio C Hamanoc7102962013-05-29 23:57:174835 either "none", "untracked", "dirty" or "all", which is the default.
Junio C Hamanod2c978f2011-03-20 19:42:224836 Using "none" will consider the submodule modified when it either contains
4837 untracked or modified files or its HEAD differs from the commit recorded
4838 in the superproject and can be used to override any settings of the
Junio C Hamanoa28a9202012-06-21 07:08:234839 <em>ignore</em> option in <a href="git-config.html">git-config(1)</a> or <a href="gitmodules.html">gitmodules(5)</a>. When
Junio C Hamanod2c978f2011-03-20 19:42:224840 "untracked" is used submodules are not considered dirty when they only
4841 contain untracked content (but they are still scanned for modified
4842 content). Using "dirty" ignores all changes to the work tree of submodules,
4843 only changes to the commits stored in the superproject are shown (this was
4844 the behavior until 1.7.0). Using "all" hides all changes to submodules.
4845</p>
4846</dd>
4847<dt class="hdlist1">
4848--src-prefix=&lt;prefix&gt;
4849</dt>
4850<dd>
4851<p>
4852 Show the given source prefix instead of "a/".
4853</p>
4854</dd>
4855<dt class="hdlist1">
4856--dst-prefix=&lt;prefix&gt;
4857</dt>
4858<dd>
4859<p>
4860 Show the given destination prefix instead of "b/".
4861</p>
4862</dd>
4863<dt class="hdlist1">
4864--no-prefix
4865</dt>
4866<dd>
4867<p>
4868 Do not show any source or destination prefix.
4869</p>
4870</dd>
Junio C Hamanocd451662016-09-13 00:54:094871<dt class="hdlist1">
4872--line-prefix=&lt;prefix&gt;
4873</dt>
4874<dd>
4875<p>
4876 Prepend an additional prefix to every line of output.
4877</p>
4878</dd>
Junio C Hamanof7017f12016-10-27 23:31:344879<dt class="hdlist1">
4880--ita-invisible-in-index
4881</dt>
4882<dd>
4883<p>
4884 By default entries added by "git add -N" appear as an existing
4885 empty file in "git diff" and a new file in "git diff --cached".
4886 This option makes the entry appear as a new file in "git diff"
4887 and non-existent in "git diff --cached". This option could be
4888 reverted with <code>--ita-visible-in-index</code>. Both options are
4889 experimental and could be removed in future.
4890</p>
4891</dd>
Junio C Hamanod2c978f2011-03-20 19:42:224892</dl></div>
4893<div class="paragraph"><p>For more detailed explanation on these common options, see also
Junio C Hamanoa28a9202012-06-21 07:08:234894<a href="gitdiffcore.html">gitdiffcore(7)</a>.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:224895</div>
Junio C Hamano9629d4f2012-12-19 00:28:274896</div>
4897<div class="sect1">
Junio C Hamanoa75aada2023-01-22 01:54:304898<h2 id="generate_patch_text_with_p">Generating patch text with -p</h2>
Junio C Hamano00b8b632007-12-07 09:50:494899<div class="sectionbody">
Junio C Hamano48cd3f12019-10-09 05:55:304900<div class="paragraph"><p>Running
4901<a href="git-diff.html">git-diff(1)</a>,
4902<a href="git-log.html">git-log(1)</a>,
4903<a href="git-show.html">git-show(1)</a>,
4904<a href="git-diff-index.html">git-diff-index(1)</a>,
4905<a href="git-diff-tree.html">git-diff-tree(1)</a>, or
4906<a href="git-diff-files.html">git-diff-files(1)</a>
4907with the <code>-p</code> option produces patch text.
4908You can customize the creation of patch text via the
Junio C Hamano558abd22020-09-03 20:22:344909<code>GIT_EXTERNAL_DIFF</code> and the <code>GIT_DIFF_OPTS</code> environment variables
Junio C Hamanobe601db2021-05-07 04:20:284910(see <a href="git.html">git(1)</a>), and the <code>diff</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:594911<div class="paragraph"><p>What the -p option produces is slightly different from the traditional
Junio C Hamano7f9fa862010-10-19 23:51:144912diff format:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:594913<div class="olist arabic"><ol class="arabic">
Junio C Hamano00b8b632007-12-07 09:50:494914<li>
4915<p>
Junio C Hamano7f9fa862010-10-19 23:51:144916It is preceded with a "git diff" header that looks like this:
Junio C Hamano00b8b632007-12-07 09:50:494917</p>
4918<div class="literalblock">
4919<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:514920<pre><code>diff --git a/file1 b/file2</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:494921</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:514922<div class="paragraph"><p>The <code>a/</code> and <code>b/</code> filenames are the same unless rename/copy is
Junio C Hamano00b8b632007-12-07 09:50:494923involved. Especially, even for a creation or a deletion,
Junio C Hamanoac12f0e2014-09-19 22:32:514924<code>/dev/null</code> is <em>not</em> used in place of the <code>a/</code> or <code>b/</code> filenames.</p></div>
4925<div class="paragraph"><p>When rename/copy is involved, <code>file1</code> and <code>file2</code> show the
Junio C Hamano00b8b632007-12-07 09:50:494926name of the source file of the rename/copy and the name of
Junio C Hamanoba4b9282008-07-06 05:20:314927the file that rename/copy produces, respectively.</p></div>
Junio C Hamano00b8b632007-12-07 09:50:494928</li>
4929<li>
4930<p>
4931It is followed by one or more extended header lines:
4932</p>
4933<div class="literalblock">
4934<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:514935<pre><code>old mode &lt;mode&gt;
Junio C Hamano00b8b632007-12-07 09:50:494936new mode &lt;mode&gt;
4937deleted file mode &lt;mode&gt;
4938new file mode &lt;mode&gt;
4939copy from &lt;path&gt;
4940copy to &lt;path&gt;
4941rename from &lt;path&gt;
4942rename to &lt;path&gt;
4943similarity index &lt;number&gt;
4944dissimilarity index &lt;number&gt;
Junio C Hamanoac12f0e2014-09-19 22:32:514945index &lt;hash&gt;..&lt;hash&gt; &lt;mode&gt;</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:494946</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:594947<div class="paragraph"><p>File modes are printed as 6-digit octal numbers including the file type
Junio C Hamano7f9fa862010-10-19 23:51:144948and file permission bits.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:514949<div class="paragraph"><p>Path names in extended headers do not include the <code>a/</code> and <code>b/</code> prefixes.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:594950<div class="paragraph"><p>The similarity index is the percentage of unchanged lines, and
Junio C Hamano7f9fa862010-10-19 23:51:144951the dissimilarity index is the percentage of changed lines. It
4952is a rounded down integer, followed by a percent sign. The
4953similarity index value of 100% is thus reserved for two equal
4954files, while 100% dissimilarity means that no line from the old
4955file made it into the new one.</p></div>
Junio C Hamano48cd3f12019-10-09 05:55:304956<div class="paragraph"><p>The index line includes the blob object names before and after the change.
Junio C Hamano7f9fa862010-10-19 23:51:144957The &lt;mode&gt; is included if the file mode does not change; otherwise,
4958separate lines indicate the old and the new mode.</p></div>
Junio C Hamano00b8b632007-12-07 09:50:494959</li>
4960<li>
4961<p>
Junio C Hamano0f6f3bf2017-03-13 07:01:534962Pathnames with "unusual" characters are quoted as explained for
4963 the configuration variable <code>core.quotePath</code> (see
4964 <a href="git-config.html">git-config(1)</a>).
Junio C Hamano00b8b632007-12-07 09:50:494965</p>
4966</li>
Junio C Hamano7f9fa862010-10-19 23:51:144967<li>
4968<p>
Junio C Hamanoac12f0e2014-09-19 22:32:514969All the <code>file1</code> files in the output refer to files before the
4970 commit, and all the <code>file2</code> files refer to files after the commit.
Junio C Hamano7f9fa862010-10-19 23:51:144971 It is incorrect to apply each change to each file sequentially. For
4972 example, this patch will swap a and b:
4973</p>
4974<div class="literalblock">
4975<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:514976<pre><code>diff --git a/a b/b
Junio C Hamano7f9fa862010-10-19 23:51:144977rename from a
4978rename to b
4979diff --git a/b b/a
4980rename from b
Junio C Hamanoac12f0e2014-09-19 22:32:514981rename to a</code></pre>
Junio C Hamano7f9fa862010-10-19 23:51:144982</div></div>
4983</li>
Junio C Hamanobe601db2021-05-07 04:20:284984<li>
4985<p>
4986Hunk headers mention the name of the function to which the hunk
4987 applies. See "Defining a custom hunk-header" in
4988 <a href="gitattributes.html">gitattributes(5)</a> for details of how to tailor to this to
4989 specific languages.
4990</p>
4991</li>
Junio C Hamanoba4b9282008-07-06 05:20:314992</ol></div>
Junio C Hamano00b8b632007-12-07 09:50:494993</div>
Junio C Hamano9629d4f2012-12-19 00:28:274994</div>
4995<div class="sect1">
Junio C Hamano48cd3f12019-10-09 05:55:304996<h2 id="_combined_diff_format">Combined diff format</h2>
Junio C Hamano00b8b632007-12-07 09:50:494997<div class="sectionbody">
Junio C Hamano1dbca522015-05-22 20:48:554998<div class="paragraph"><p>Any diff-generating command can take the <code>-c</code> or <code>--cc</code> option to
Junio C Hamanoc5be4cc2011-03-09 07:20:434999produce a <em>combined diff</em> when showing a merge. This is the default
Junio C Hamanoa28a9202012-06-21 07:08:235000format when showing merges with <a href="git-diff.html">git-diff(1)</a> or
Junio C Hamano8c860d62021-02-06 01:37:475001<a href="git-show.html">git-show(1)</a>. Note also that you can give suitable
5002<code>--diff-merges</code> option to any of these commands to force generation of
5003diffs in specific format.</p></div>
Junio C Hamano48cd3f12019-10-09 05:55:305004<div class="paragraph"><p>A "combined diff" format looks like this:</p></div>
Junio C Hamano00b8b632007-12-07 09:50:495005<div class="listingblock">
5006<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:515007<pre><code>diff --combined describe.c
Junio C Hamano00b8b632007-12-07 09:50:495008index fabadb8,cc95eb0..4866510
5009--- a/describe.c
5010+++ b/describe.c
5011@@@ -98,20 -98,12 +98,20 @@@
5012 return (a_date &gt; b_date) ? -1 : (a_date == b_date) ? 0 : 1;
5013 }
5014
5015- static void describe(char *arg)
5016 -static void describe(struct commit *cmit, int last_one)
5017++static void describe(char *arg, int last_one)
5018 {
5019 + unsigned char sha1[20];
5020 + struct commit *cmit;
5021 struct commit_list *list;
5022 static int initialized = 0;
5023 struct commit_name *n;
5024
5025 + if (get_sha1(arg, sha1) &lt; 0)
5026 + usage(describe_usage);
5027 + cmit = lookup_commit_reference(sha1);
5028 + if (!cmit)
5029 + usage(describe_usage);
5030 +
5031 if (!initialized) {
5032 initialized = 1;
Junio C Hamanoac12f0e2014-09-19 22:32:515033 for_each_ref(get_name);</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:495034</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:595035<div class="olist arabic"><ol class="arabic">
Junio C Hamano00b8b632007-12-07 09:50:495036<li>
5037<p>
5038It is preceded with a "git diff" header, that looks like
Junio C Hamano48cd3f12019-10-09 05:55:305039 this (when the <code>-c</code> option is used):
Junio C Hamano00b8b632007-12-07 09:50:495040</p>
5041<div class="literalblock">
5042<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:515043<pre><code>diff --combined file</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:495044</div></div>
Junio C Hamano48cd3f12019-10-09 05:55:305045<div class="paragraph"><p>or like this (when the <code>--cc</code> option is used):</p></div>
Junio C Hamano00b8b632007-12-07 09:50:495046<div class="literalblock">
5047<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:515048<pre><code>diff --cc file</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:495049</div></div>
5050</li>
5051<li>
5052<p>
5053It is followed by one or more extended header lines
5054 (this example shows a merge with two parents):
5055</p>
5056<div class="literalblock">
5057<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:515058<pre><code>index &lt;hash&gt;,&lt;hash&gt;..&lt;hash&gt;
Junio C Hamano00b8b632007-12-07 09:50:495059mode &lt;mode&gt;,&lt;mode&gt;..&lt;mode&gt;
5060new file mode &lt;mode&gt;
Junio C Hamanoac12f0e2014-09-19 22:32:515061deleted file mode &lt;mode&gt;,&lt;mode&gt;</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:495062</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:515063<div class="paragraph"><p>The <code>mode &lt;mode&gt;,&lt;mode&gt;..&lt;mode&gt;</code> line appears only if at least one of
Junio C Hamano00b8b632007-12-07 09:50:495064the &lt;mode&gt; is different from the rest. Extended headers with
5065information about detected contents movement (renames and
5066copying detection) are designed to work with diff of two
Junio C Hamanoba4b9282008-07-06 05:20:315067&lt;tree-ish&gt; and are not used by combined diff format.</p></div>
Junio C Hamano00b8b632007-12-07 09:50:495068</li>
5069<li>
5070<p>
5071It is followed by two-line from-file/to-file header
5072</p>
5073<div class="literalblock">
5074<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:515075<pre><code>--- a/file
5076+++ b/file</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:495077</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:595078<div class="paragraph"><p>Similar to two-line header for traditional <em>unified</em> diff
Junio C Hamanoac12f0e2014-09-19 22:32:515079format, <code>/dev/null</code> is used to signal created or deleted
Junio C Hamanoba4b9282008-07-06 05:20:315080files.</p></div>
Junio C Hamano11f15372019-03-07 03:17:005081<div class="paragraph"><p>However, if the --combined-all-paths option is provided, instead of a
5082two-line from-file/to-file you get a N+1 line from-file/to-file header,
5083where N is the number of parents in the merge commit</p></div>
5084<div class="literalblock">
5085<div class="content">
5086<pre><code>--- a/file
5087--- a/file
5088--- a/file
5089+++ b/file</code></pre>
5090</div></div>
5091<div class="paragraph"><p>This extended format can be useful if rename or copy detection is
5092active, to allow you to see the original name of the file in different
5093parents.</p></div>
Junio C Hamano00b8b632007-12-07 09:50:495094</li>
5095<li>
5096<p>
5097Chunk header format is modified to prevent people from
Junio C Hamanoac12f0e2014-09-19 22:32:515098 accidentally feeding it to <code>patch -p1</code>. Combined diff format
Junio C Hamano00b8b632007-12-07 09:50:495099 was created for review of merge commit changes, and was not
Junio C Hamano48cd3f12019-10-09 05:55:305100 meant to be applied. The change is similar to the change in the
Junio C Hamano00b8b632007-12-07 09:50:495101 extended <em>index</em> header:
5102</p>
5103<div class="literalblock">
5104<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:515105<pre><code>@@@ &lt;from-file-range&gt; &lt;from-file-range&gt; &lt;to-file-range&gt; @@@</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:495106</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:515107<div class="paragraph"><p>There are (number of parents + 1) <code>@</code> characters in the chunk
Junio C Hamanoba4b9282008-07-06 05:20:315108header for combined diff format.</p></div>
Junio C Hamano00b8b632007-12-07 09:50:495109</li>
Junio C Hamanoba4b9282008-07-06 05:20:315110</ol></div>
Junio C Hamano68cf15a2010-11-06 01:01:595111<div class="paragraph"><p>Unlike the traditional <em>unified</em> diff format, which shows two
Junio C Hamanoac12f0e2014-09-19 22:32:515112files A and B with a single column that has <code>-</code> (minus&#8201;&#8212;&#8201;appears in A but removed in B), <code>+</code> (plus&#8201;&#8212;&#8201;missing in A but
5113added to B), or <code>" "</code> (space&#8201;&#8212;&#8201;unchanged) prefix, this format
Junio C Hamano00b8b632007-12-07 09:50:495114compares two or more files file1, file2,&#8230; with one file X, and
5115shows how X differs from each of fileN. One column for each of
Junio C Hamano68cf15a2010-11-06 01:01:595116fileN is prepended to the output line to note how X&#8217;s line is
Junio C Hamanoba4b9282008-07-06 05:20:315117different from it.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:515118<div class="paragraph"><p>A <code>-</code> character in the column N means that the line appears in
5119fileN but it does not appear in the result. A <code>+</code> character
Junio C Hamano54bf1e22008-12-20 06:30:115120in the column N means that the line appears in the result,
Junio C Hamano00b8b632007-12-07 09:50:495121and fileN does not have that line (in other words, the line was
Junio C Hamanoba4b9282008-07-06 05:20:315122added, from the point of view of that parent).</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:595123<div class="paragraph"><p>In the above example output, the function signature was changed
Junio C Hamanoac12f0e2014-09-19 22:32:515124from both files (hence two <code>-</code> removals from both file1 and
5125file2, plus <code>++</code> to mean one line that was added does not appear
Junio C Hamanod75148a2014-04-08 19:48:385126in either file1 or file2). Also eight other lines are the same
Junio C Hamanoac12f0e2014-09-19 22:32:515127from file1 but do not appear in file2 (hence prefixed with <code>+</code>).</p></div>
5128<div class="paragraph"><p>When shown by <code>git diff-tree -c</code>, it compares the parents of a
Junio C Hamano00b8b632007-12-07 09:50:495129merge commit with the merge result (i.e. file1..fileN are the
Junio C Hamanoac12f0e2014-09-19 22:32:515130parents). When shown by <code>git diff-files -c</code>, it compares the
Junio C Hamano00b8b632007-12-07 09:50:495131two unresolved merge parents with the working tree file
5132(i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka
Junio C Hamanoba4b9282008-07-06 05:20:315133"their version").</p></div>
Junio C Hamano00b8b632007-12-07 09:50:495134</div>
Junio C Hamano9629d4f2012-12-19 00:28:275135</div>
5136<div class="sect1">
Junio C Hamano58f587a2013-07-22 19:20:595137<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano1a4e8412005-12-27 08:17:235138<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:595139<div class="dlist"><dl>
5140<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:515141<code>git log --no-merges</code>
Junio C Hamano1a4e8412005-12-27 08:17:235142</dt>
5143<dd>
5144<p>
5145 Show the whole commit history, but skip any merges
5146</p>
5147</dd>
Junio C Hamano68cf15a2010-11-06 01:01:595148<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:515149<code>git log v2.6.12.. include/scsi drivers/scsi</code>
Junio C Hamano1a4e8412005-12-27 08:17:235150</dt>
5151<dd>
5152<p>
5153 Show all commits since version <em>v2.6.12</em> that changed any file
Junio C Hamanoac12f0e2014-09-19 22:32:515154 in the <code>include/scsi</code> or <code>drivers/scsi</code> subdirectories
Junio C Hamano1a4e8412005-12-27 08:17:235155</p>
5156</dd>
Junio C Hamano68cf15a2010-11-06 01:01:595157<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:515158<code>git log --since="2 weeks ago" -- gitk</code>
Junio C Hamano1a4e8412005-12-27 08:17:235159</dt>
5160<dd>
5161<p>
5162 Show the changes during the last two weeks to the file <em>gitk</em>.
Junio C Hamanoccb82522018-05-08 07:52:095163 The <code>--</code> is necessary to avoid confusion with the <strong>branch</strong> named
Junio C Hamano1a4e8412005-12-27 08:17:235164 <em>gitk</em>
5165</p>
5166</dd>
Junio C Hamano68cf15a2010-11-06 01:01:595167<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:515168<code>git log --name-status release..test</code>
Junio C Hamanoba7c8d82006-04-15 06:17:425169</dt>
5170<dd>
5171<p>
5172 Show the commits that are in the "test" branch but not yet
5173 in the "release" branch, along with the list of paths
5174 each commit modifies.
5175</p>
5176</dd>
Junio C Hamano68cf15a2010-11-06 01:01:595177<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:515178<code>git log --follow builtin/rev-list.c</code>
Junio C Hamano235d53f2007-07-13 00:25:155179</dt>
5180<dd>
5181<p>
Junio C Hamanoac12f0e2014-09-19 22:32:515182 Shows the commits that changed <code>builtin/rev-list.c</code>, including
Junio C Hamano235d53f2007-07-13 00:25:155183 those commits that occurred before the file was given its
5184 present name.
5185</p>
5186</dd>
Junio C Hamano68cf15a2010-11-06 01:01:595187<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:515188<code>git log --branches --not --remotes=origin</code>
Junio C Hamano57827fb2010-01-23 03:02:505189</dt>
5190<dd>
5191<p>
5192 Shows all commits that are in any of local branches but not in
Junio C Hamano97bcb482010-11-25 03:16:075193 any of remote-tracking branches for <em>origin</em> (what you have that
Junio C Hamano68cf15a2010-11-06 01:01:595194 origin doesn&#8217;t).
Junio C Hamano57827fb2010-01-23 03:02:505195</p>
5196</dd>
Junio C Hamano68cf15a2010-11-06 01:01:595197<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:515198<code>git log master --not --remotes=*/master</code>
Junio C Hamano57827fb2010-01-23 03:02:505199</dt>
5200<dd>
5201<p>
5202 Shows all commits that are in local master but not in any remote
5203 repository master branches.
5204</p>
5205</dd>
Junio C Hamano68cf15a2010-11-06 01:01:595206<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:515207<code>git log -p -m --first-parent</code>
Junio C Hamano31667362010-03-25 00:38:535208</dt>
5209<dd>
5210<p>
5211 Shows the history including change diffs, but only from the
Junio C Hamanob73af6c2013-12-03 22:07:115212 &#8220;main branch&#8221; perspective, skipping commits that come from merged
Junio C Hamano31667362010-03-25 00:38:535213 branches, and showing full diffs of changes introduced by the merges.
5214 This makes sense only when following a strict policy of merging all
5215 topic branches when staying on a single integration branch.
5216</p>
5217</dd>
Junio C Hamano693e7092012-09-12 22:56:535218<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:515219<code>git log -L '/int main/',/^}/:main.c</code>
Junio C Hamano7e590a12013-06-02 23:46:525220</dt>
5221<dd>
5222<p>
Junio C Hamanoac12f0e2014-09-19 22:32:515223 Shows how the function <code>main()</code> in the file <code>main.c</code> evolved
Junio C Hamano7e590a12013-06-02 23:46:525224 over time.
5225</p>
5226</dd>
5227<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:515228<code>git log -3</code>
Junio C Hamano693e7092012-09-12 22:56:535229</dt>
5230<dd>
5231<p>
5232 Limits the number of commits to show to 3.
5233</p>
5234</dd>
Junio C Hamanoba4b9282008-07-06 05:20:315235</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:235236</div>
Junio C Hamano9629d4f2012-12-19 00:28:275237</div>
5238<div class="sect1">
Junio C Hamano58f587a2013-07-22 19:20:595239<h2 id="_discussion">DISCUSSION</h2>
Junio C Hamano775a0f42006-12-31 01:19:145240<div class="sectionbody">
Junio C Hamanod7ed4042015-08-03 19:43:005241<div class="paragraph"><p>Git is to some extent character encoding agnostic.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:595242<div class="ulist"><ul>
Junio C Hamano775a0f42006-12-31 01:19:145243<li>
5244<p>
Junio C Hamano54bf1e22008-12-20 06:30:115245The contents of the blob objects are uninterpreted sequences
Junio C Hamano775a0f42006-12-31 01:19:145246 of bytes. There is no encoding translation at the core
5247 level.
5248</p>
5249</li>
5250<li>
5251<p>
Junio C Hamanod7ed4042015-08-03 19:43:005252Path names are encoded in UTF-8 normalization form C. This
5253 applies to tree objects, the index file, ref names, as well as
5254 path names in command line arguments, environment variables
5255 and config files (<code>.git/config</code> (see <a href="git-config.html">git-config(1)</a>),
5256 <a href="gitignore.html">gitignore(5)</a>, <a href="gitattributes.html">gitattributes(5)</a> and
5257 <a href="gitmodules.html">gitmodules(5)</a>).
5258</p>
5259<div class="paragraph"><p>Note that Git at the core level treats path names simply as
5260sequences of non-NUL bytes, there are no path name encoding
5261conversions (except on Mac and Windows). Therefore, using
5262non-ASCII path names will mostly work even on platforms and file
5263systems that use legacy extended ASCII encodings. However,
5264repositories created on such systems will not work properly on
5265UTF-8-based systems (e.g. Linux, Mac, Windows) and vice versa.
5266Additionally, many Git-based tools simply assume path names to
5267be UTF-8 and will fail to display other encodings correctly.</p></div>
5268</li>
5269<li>
5270<p>
5271Commit log messages are typically encoded in UTF-8, but other
5272 extended ASCII encodings are also supported. This includes
5273 ISO-8859-x, CP125x and many others, but <em>not</em> UTF-16/32,
5274 EBCDIC and CJK multi-byte encodings (GBK, Shift-JIS, Big5,
5275 EUC-x, CP9xx etc.).
Junio C Hamano775a0f42006-12-31 01:19:145276</p>
5277</li>
Junio C Hamanoba4b9282008-07-06 05:20:315278</ul></div>
Junio C Hamano68cf15a2010-11-06 01:01:595279<div class="paragraph"><p>Although we encourage that the commit log messages are encoded
Junio C Hamano076ffcc2013-02-06 05:13:215280in UTF-8, both the core and Git Porcelain are designed not to
Junio C Hamano775a0f42006-12-31 01:19:145281force UTF-8 on projects. If all participants of a particular
Junio C Hamano076ffcc2013-02-06 05:13:215282project find it more convenient to use legacy encodings, Git
Junio C Hamano775a0f42006-12-31 01:19:145283does not forbid it. However, there are a few things to keep in
Junio C Hamanoba4b9282008-07-06 05:20:315284mind.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:595285<div class="olist arabic"><ol class="arabic">
Junio C Hamano775a0f42006-12-31 01:19:145286<li>
5287<p>
Junio C Hamano1aa40d22010-01-21 17:46:435288<em>git commit</em> and <em>git commit-tree</em> issues
Junio C Hamano14b76482008-01-05 10:32:265289 a warning if the commit log message given to it does not look
Junio C Hamano775a0f42006-12-31 01:19:145290 like a valid UTF-8 string, unless you explicitly say your
5291 project uses a legacy encoding. The way to say this is to
Junio C Hamanoa372d5b2021-02-26 01:34:375292 have <code>i18n.commitEncoding</code> in <code>.git/config</code> file, like this:
Junio C Hamano775a0f42006-12-31 01:19:145293</p>
5294<div class="listingblock">
5295<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:515296<pre><code>[i18n]
Junio C Hamanobb34c102017-07-21 22:42:285297 commitEncoding = ISO-8859-1</code></pre>
Junio C Hamano775a0f42006-12-31 01:19:145298</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:595299<div class="paragraph"><p>Commit objects created with the above setting record the value
Junio C Hamanobb34c102017-07-21 22:42:285300of <code>i18n.commitEncoding</code> in its <code>encoding</code> header. This is to
Junio C Hamano775a0f42006-12-31 01:19:145301help other people who look at them later. Lack of this header
Junio C Hamanoba4b9282008-07-06 05:20:315302implies that the commit log message is encoded in UTF-8.</p></div>
Junio C Hamano775a0f42006-12-31 01:19:145303</li>
5304<li>
5305<p>
Junio C Hamano1aa40d22010-01-21 17:46:435306<em>git log</em>, <em>git show</em>, <em>git blame</em> and friends look at the
Junio C Hamanoac12f0e2014-09-19 22:32:515307 <code>encoding</code> header of a commit object, and try to re-code the
Junio C Hamanoaa17c7c2008-11-03 04:36:585308 log message into UTF-8 unless otherwise specified. You can
Junio C Hamano775a0f42006-12-31 01:19:145309 specify the desired output encoding with
Junio C Hamanobb34c102017-07-21 22:42:285310 <code>i18n.logOutputEncoding</code> in <code>.git/config</code> file, like this:
Junio C Hamano775a0f42006-12-31 01:19:145311</p>
5312<div class="listingblock">
5313<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:515314<pre><code>[i18n]
Junio C Hamanobb34c102017-07-21 22:42:285315 logOutputEncoding = ISO-8859-1</code></pre>
Junio C Hamano775a0f42006-12-31 01:19:145316</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:595317<div class="paragraph"><p>If you do not have this configuration variable, the value of
Junio C Hamanobb34c102017-07-21 22:42:285318<code>i18n.commitEncoding</code> is used instead.</p></div>
Junio C Hamano775a0f42006-12-31 01:19:145319</li>
Junio C Hamanoba4b9282008-07-06 05:20:315320</ol></div>
Junio C Hamano68cf15a2010-11-06 01:01:595321<div class="paragraph"><p>Note that we deliberately chose not to re-code the commit log
Junio C Hamano775a0f42006-12-31 01:19:145322message when a commit is made to force UTF-8 at the commit
5323object level, because re-coding to UTF-8 is not necessarily a
Junio C Hamanoba4b9282008-07-06 05:20:315324reversible operation.</p></div>
Junio C Hamano775a0f42006-12-31 01:19:145325</div>
Junio C Hamano9629d4f2012-12-19 00:28:275326</div>
5327<div class="sect1">
Junio C Hamano58f587a2013-07-22 19:20:595328<h2 id="_configuration">CONFIGURATION</h2>
Junio C Hamanoa574a092010-06-13 19:57:105329<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:235330<div class="paragraph"><p>See <a href="git-config.html">git-config(1)</a> for core variables and <a href="git-diff.html">git-diff(1)</a>
Junio C Hamanoa574a092010-06-13 19:57:105331for settings related to diff generation.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:595332<div class="dlist"><dl>
5333<dt class="hdlist1">
Junio C Hamanoa574a092010-06-13 19:57:105334format.pretty
5335</dt>
5336<dd>
5337<p>
Junio C Hamanoac12f0e2014-09-19 22:32:515338 Default for the <code>--format</code> option. (See <em>Pretty Formats</em> above.)
5339 Defaults to <code>medium</code>.
Junio C Hamanoa574a092010-06-13 19:57:105340</p>
5341</dd>
Junio C Hamano68cf15a2010-11-06 01:01:595342<dt class="hdlist1">
Junio C Hamanoa574a092010-06-13 19:57:105343i18n.logOutputEncoding
5344</dt>
5345<dd>
5346<p>
Junio C Hamanob73af6c2013-12-03 22:07:115347 Encoding to use when displaying logs. (See <em>Discussion</em> above.)
Junio C Hamanoac12f0e2014-09-19 22:32:515348 Defaults to the value of <code>i18n.commitEncoding</code> if set, and UTF-8
Junio C Hamanoa574a092010-06-13 19:57:105349 otherwise.
5350</p>
5351</dd>
Junio C Hamanoba8baee2022-09-14 20:25:235352</dl></div>
5353<div class="paragraph"><p>Everything above this line in this section isn&#8217;t included from the
5354<a href="git-config.html">git-config(1)</a> documentation. The content that follows is the
5355same as what&#8217;s found there:</p></div>
5356<div class="dlist"><dl>
5357<dt class="hdlist1">
5358log.abbrevCommit
5359</dt>
5360<dd>
5361<p>
5362 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
5363 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
5364 override this option with <code>--no-abbrev-commit</code>.
5365</p>
5366</dd>
Junio C Hamano68cf15a2010-11-06 01:01:595367<dt class="hdlist1">
Junio C Hamanoa574a092010-06-13 19:57:105368log.date
5369</dt>
5370<dd>
5371<p>
Junio C Hamanoba8baee2022-09-14 20:25:235372 Set the default date-time mode for the <em>log</em> command.
5373 Setting a value for log.date is similar to using <em>git log</em>'s
5374 <code>--date</code> option. See <a href="git-log.html">git-log(1)</a> for details.
Junio C Hamanoa574a092010-06-13 19:57:105375</p>
Junio C Hamano23168ef2019-02-07 07:20:475376<div class="paragraph"><p>If the format is set to "auto:foo" and the pager is in use, format
5377"foo" will be the used for the date format. Otherwise "default" will
5378be used.</p></div>
Junio C Hamanoa574a092010-06-13 19:57:105379</dd>
Junio C Hamano68cf15a2010-11-06 01:01:595380<dt class="hdlist1">
Junio C Hamanoba8baee2022-09-14 20:25:235381log.decorate
5382</dt>
5383<dd>
5384<p>
5385 Print out the ref names of any commits that are shown by the log
5386 command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
5387 <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
5388 specified, the full ref name (including prefix) will be printed.
5389 If <em>auto</em> is specified, then if the output is going to a terminal,
5390 the ref names are shown as if <em>short</em> were given, otherwise no ref
5391 names are shown. This is the same as the <code>--decorate</code> option
5392 of the <code>git log</code>.
5393</p>
5394</dd>
5395<dt class="hdlist1">
5396log.initialDecorationSet
5397</dt>
5398<dd>
5399<p>
5400 By default, <code>git log</code> only shows decorations for certain known ref
5401 namespaces. If <em>all</em> is specified, then show all refs as
5402 decorations.
5403</p>
5404</dd>
5405<dt class="hdlist1">
5406log.excludeDecoration
5407</dt>
5408<dd>
5409<p>
5410 Exclude the specified patterns from the log decorations. This is
5411 similar to the <code>--decorate-refs-exclude</code> command-line option, but
5412 the config option can be overridden by the <code>--decorate-refs</code>
5413 option.
5414</p>
5415</dd>
5416<dt class="hdlist1">
5417log.diffMerges
5418</dt>
5419<dd>
5420<p>
Junio C Hamano53cd02b2022-10-10 21:42:315421 Set diff format to be used when <code>--diff-merges=on</code> is
5422 specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
5423 details. Defaults to <code>separate</code>.
Junio C Hamanoba8baee2022-09-14 20:25:235424</p>
5425</dd>
5426<dt class="hdlist1">
Junio C Hamanod7ed4042015-08-03 19:43:005427log.follow
5428</dt>
5429<dd>
5430<p>
Junio C Hamanob0a1e832015-10-15 23:08:315431 If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
5432 a single &lt;path&gt; is given. This has the same limitations as <code>--follow</code>,
5433 i.e. it cannot be used to follow multiple files and does not work well
5434 on non-linear history.
Junio C Hamanod7ed4042015-08-03 19:43:005435</p>
5436</dd>
5437<dt class="hdlist1">
Junio C Hamanoba8baee2022-09-14 20:25:235438log.graphColors
5439</dt>
5440<dd>
5441<p>
5442 A list of colors, separated by commas, that can be used to draw
5443 history lines in <code>git log --graph</code>.
5444</p>
5445</dd>
5446<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:465447log.showRoot
Junio C Hamanoa574a092010-06-13 19:57:105448</dt>
5449<dd>
5450<p>
Junio C Hamanoba8baee2022-09-14 20:25:235451 If true, the initial commit will be shown as a big creation event.
5452 This is equivalent to a diff against an empty tree.
5453 Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
5454 normally hide the root commit will now show it. True by default.
Junio C Hamanoa574a092010-06-13 19:57:105455</p>
5456</dd>
Junio C Hamano68cf15a2010-11-06 01:01:595457<dt class="hdlist1">
Junio C Hamano48931e22016-07-11 20:08:475458log.showSignature
5459</dt>
5460<dd>
5461<p>
Junio C Hamanoba8baee2022-09-14 20:25:235462 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
5463 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.
Junio C Hamano48931e22016-07-11 20:08:475464</p>
5465</dd>
5466<dt class="hdlist1">
Junio C Hamanoba8baee2022-09-14 20:25:235467log.mailmap
Junio C Hamanoa574a092010-06-13 19:57:105468</dt>
5469<dd>
5470<p>
Junio C Hamanoba8baee2022-09-14 20:25:235471 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
5472 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
5473 assume <code>--no-use-mailmap</code>. True by default.
5474</p>
5475</dd>
5476<dt class="hdlist1">
5477notes.mergeStrategy
5478</dt>
5479<dd>
5480<p>
5481 Which merge strategy to choose by default when resolving notes
5482 conflicts. Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
5483 <code>cat_sort_uniq</code>. Defaults to <code>manual</code>. See "NOTES MERGE STRATEGIES"
5484 section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
5485</p>
5486<div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
5487<a href="git-notes.html">git-notes(1)</a>.</p></div>
5488</dd>
5489<dt class="hdlist1">
5490notes.&lt;name&gt;.mergeStrategy
5491</dt>
5492<dd>
5493<p>
5494 Which merge strategy to choose when doing a notes merge into
5495 refs/notes/&lt;name&gt;. This overrides the more general
5496 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
5497 <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
Junio C Hamanoa574a092010-06-13 19:57:105498</p>
5499</dd>
Junio C Hamano68cf15a2010-11-06 01:01:595500<dt class="hdlist1">
Junio C Hamanoa574a092010-06-13 19:57:105501notes.displayRef
5502</dt>
5503<dd>
5504<p>
Junio C Hamanoba8baee2022-09-14 20:25:235505 Which ref (or refs, if a glob or specified more than once), in
5506 addition to the default set by <code>core.notesRef</code> or
5507 <code>GIT_NOTES_REF</code>, to read notes from when showing commit
5508 messages with the <em>git log</em> family of commands.
Junio C Hamanoa574a092010-06-13 19:57:105509</p>
Junio C Hamanoba8baee2022-09-14 20:25:235510<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
5511environment variable, which must be a colon separated list of refs or
5512globs.</p></div>
5513<div class="paragraph"><p>A warning will be issued for refs that do not exist,
Junio C Hamanoa574a092010-06-13 19:57:105514but a glob that does not match any refs is silently ignored.</p></div>
Junio C Hamanoba8baee2022-09-14 20:25:235515<div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
5516log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
5517those commands.</p></div>
5518<div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
5519GIT_NOTES_REF) is also implicitly added to the list of refs to be
5520displayed.</p></div>
5521</dd>
5522<dt class="hdlist1">
5523notes.rewrite.&lt;command&gt;
5524</dt>
5525<dd>
5526<p>
5527 When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
5528 <code>rebase</code>), if this variable is <code>false</code>, git will not copy
5529 notes from the original to the rewritten commit. Defaults to
5530 <code>true</code>. See also "<code>notes.rewriteRef</code>" below.
5531</p>
5532<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
5533environment variable, which must be a colon separated list of refs or
5534globs.</p></div>
5535</dd>
5536<dt class="hdlist1">
5537notes.rewriteMode
5538</dt>
5539<dd>
5540<p>
5541 When copying notes during a rewrite (see the
5542 "notes.rewrite.&lt;command&gt;" option), determines what to do if
5543 the target commit already has a note. Must be one of
5544 <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
5545 Defaults to <code>concatenate</code>.
5546</p>
5547<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
5548environment variable.</p></div>
5549</dd>
5550<dt class="hdlist1">
5551notes.rewriteRef
5552</dt>
5553<dd>
5554<p>
5555 When copying notes during a rewrite, specifies the (fully
5556 qualified) ref whose notes should be copied. May be a glob,
5557 in which case notes in all matching refs will be copied. You
5558 may also specify this configuration several times.
5559</p>
5560<div class="paragraph"><p>Does not have a default value; you must configure this variable to
5561enable note rewriting. Set it to <code>refs/notes/commits</code> to enable
5562rewriting for the default commit notes.</p></div>
5563<div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
5564See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p></div>
Junio C Hamanoa574a092010-06-13 19:57:105565</dd>
5566</dl></div>
5567</div>
Junio C Hamano9629d4f2012-12-19 00:28:275568</div>
5569<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:315570<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:235571<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:235572<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:235573</div>
Junio C Hamano7bd050f2011-09-22 06:32:225574</div>
Junio C Hamano9629d4f2012-12-19 00:28:275575</div>
Junio C Hamano7bd050f2011-09-22 06:32:225576<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:235577<div id="footer">
5578<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:535579Last updated
Junio C Hamanod2309372023-01-16 21:19:045580 2022-09-14 13:23:11 PDT
Junio C Hamano1a4e8412005-12-27 08:17:235581</div>
5582</div>
5583</body>
5584</html>