Google Git
Sign in
chromium / external / gitster / git-htmldocs / 6546a509a43eda541b7749ee45837d7a74ba7339 / . / git-log.html
blob: c2b14a450c0b0855bbf63b22f64e2982f4422922 [file] [log] [blame]
Junio C Hamano96153bf2018-04-25 08:25:34[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2<!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:27[diff] [blame]6<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoa85030a2022-07-27 16:48:21[diff] [blame]7<meta name="generator" content="AsciiDoc 10.2.0" />
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]8<title>git-log(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]9<style type="text/css">
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]10/* 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:23[diff] [blame]25}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]31a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]38
39em {
40 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]41 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]42}
43
44strong {
45 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]46 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]47}
48
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]49h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]57 border-bottom: 2px solid silver;
58}
59h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]60 padding-top: 0.5em;
61}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]62h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]68h5 {
69 font-size: 1.0em;
70}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]71
72div.sectionbody {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]73 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:59[diff] [blame]85ul, ol, li > p {
86 margin-top: 0;
87}
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]88ul > li { color: #aaa; }
89ul > li > * { color: black; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]90
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]91.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]95 padding: 0;
96 margin: 0;
97}
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]98pre {
99 white-space: pre-wrap;
100}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]101
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]102#author {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]103 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]104 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]105 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]106}
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]107#email {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]108}
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]109#revnumber, #revdate, #revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]110}
111
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]112#footer {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]113 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:27[diff] [blame]118#footer-text {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]119 float: left;
120 padding-bottom: 0.5em;
121}
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]122#footer-badges {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]123 float: right;
124 padding-bottom: 0.5em;
125}
126
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]127#preamble {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]131div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]134 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]142}
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:59[diff] [blame]150 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]151 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:27[diff] [blame]172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]181 padding: 0.5em;
182}
183
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]187 margin-right: 10%;
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]188 border-left: 5px solid #f0f0f0;
189 color: #888;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]190}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]191
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]194 text-align: right;
195}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]196
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]200}
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:31[diff] [blame]206div.verseblock + div.attribution {
207 text-align: left;
208}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]209
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:22[diff] [blame]220 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]221}
222
223div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]226}
227
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]228div.imageblock div.content { padding-left: 0; }
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]229span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]230a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]231
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:59[diff] [blame]239 font-style: normal;
240 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]241}
242dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]243 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]244}
245
246ul, ol {
247 list-style-position: outside;
248}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]253 list-style-type: lower-alpha;
254}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]255ol.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:23[diff] [blame]271
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]272tfoot {
273 font-weight: bold;
274}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]275td > div.verse {
276 white-space: pre;
277}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]278
279div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]283div.hdlist tr {
284 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]285}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]290 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]291 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]292 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]293 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]294}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]295td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]296 vertical-align: top;
297}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]298div.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:23[diff] [blame]306
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]307.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:27[diff] [blame]334div.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:23[diff] [blame]341}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]342
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]348 margin-bottom: 2.5em;
349}
350
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]351#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]352 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]353 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:51[diff] [blame]359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]360 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:27[diff] [blame]375
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:51[diff] [blame]417div.unbreakable { page-break-inside: avoid; }
418
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]419
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:40[diff] [blame]439/* Because the table frame attribute is overridden by CSS in most browsers. */
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]440div.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:59[diff] [blame]522 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:27[diff] [blame]527body.manpage h2 {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]528 border-style: none;
529}
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]530body.manpage div.sectionbody {
531 margin-left: 3em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]532}
533
534@media print {
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]535 body.manpage div#toc { display: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]536}
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]537
538
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]539</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]540<script type="text/javascript">
541/*<![CDATA[*/
Junio C Hamano2b153182021-12-15 21:00:31[diff] [blame]542var 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:27[diff] [blame]731asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]732/*]]>*/
733</script>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]734</head>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]735<body class="manpage">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]736<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:22[diff] [blame]747<div id="content">
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]748<div class="sect1">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]749<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]750<div class="sectionbody">
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]751<div class="verseblock">
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]752<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:27[diff] [blame]753<div class="attribution">
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]754</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]755</div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]756</div>
757<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]758<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]759<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]760<div class="paragraph"><p>Shows the commit logs.</p></div>
Junio C Hamano28c33de2020-07-30 21:22:26[diff] [blame]761<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:42[diff] [blame]795command to control what is shown and how, and options applicable to
Junio C Hamano28c33de2020-07-30 21:22:26[diff] [blame]796the <a href="git-diff.html">git-diff(1)</a> command to control how the changes
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]797each commit introduces are shown.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]798</div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]799</div>
800<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]801<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]802<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]803<div class="dlist"><dl>
804<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]805--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:59[diff] [blame]813<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]814--no-decorate
815</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]816<dt class="hdlist1">
Junio C Hamano37cf4082016-05-30 01:22:14[diff] [blame]817--decorate[=short|full|auto|no]
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]818</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:14[diff] [blame]824 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:50[diff] [blame]827 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:45[diff] [blame]830</p>
831</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]832<dt class="hdlist1">
Junio C Hamano371470a2017-12-13 22:26:40[diff] [blame]833--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:50[diff] [blame]840 For each candidate reference, do not use it for decoration if it
Junio C Hamano371470a2017-12-13 22:26:40[diff] [blame]841 matches any patterns given to <code>--decorate-refs-exclude</code> or if it
Junio C Hamano0dd50942020-04-29 21:21:05[diff] [blame]842 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:40[diff] [blame]846</p>
Junio C Hamano594d2d42022-08-30 17:58:50[diff] [blame]847<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:40[diff] [blame]862</dd>
863<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]864--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:59[diff] [blame]872<dt class="hdlist1">
Junio C Hamano0dd50942020-04-29 21:21:05[diff] [blame]873--[no-]mailmap
874</dt>
875<dt class="hdlist1">
Junio C Hamano36594952019-07-25 22:26:52[diff] [blame]876--[no-]use-mailmap
Junio C Hamanoce836cc2013-01-21 02:01:53[diff] [blame]877</dt>
878<dd>
879<p>
880 Use mailmap file to map author and committer names and email
Junio C Hamanob73af6c2013-12-03 22:07:11[diff] [blame]881 addresses to canonical real names and email addresses. See
Junio C Hamanoce836cc2013-01-21 02:01:53[diff] [blame]882 <a href="git-shortlog.html">git-shortlog(1)</a>.
883</p>
884</dd>
885<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]886--full-diff
887</dt>
888<dd>
889<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]890 Without this flag, <code>git log -p &lt;path&gt;...</code> shows commits that
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]891 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:59[diff] [blame]894 commits, and doesn&#8217;t limit diff for those commits.
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]895</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]896<div class="paragraph"><p>Note that this affects all diff-based output types, e.g. those
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]897produced by <code>--stat</code>, etc.</p></div>
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]898</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]899<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]900--log-size
901</dt>
902<dd>
903<p>
Junio C Hamanob73af6c2013-12-03 22:07:11[diff] [blame]904 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:51[diff] [blame]906 Intended to speed up tools that read log messages from <code>git log</code>
Junio C Hamanob73af6c2013-12-03 22:07:11[diff] [blame]907 output by allowing them to allocate space in advance.
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]908</p>
909</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]910<dt class="hdlist1">
Junio C Hamanob7676d52020-11-18 22:15:08[diff] [blame]911-L&lt;start&gt;,&lt;end&gt;:&lt;file&gt;
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]912</dt>
913<dt class="hdlist1">
Junio C Hamanob7676d52020-11-18 22:15:08[diff] [blame]914-L:&lt;funcname&gt;:&lt;file&gt;
Junio C Hamano7e590a12013-06-02 23:46:52[diff] [blame]915</dt>
916<dd>
917<p>
Junio C Hamanob7676d52020-11-18 22:15:08[diff] [blame]918 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:52[diff] [blame]920 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:09[diff] [blame]922 give zero or one positive revision arguments, and
Junio C Hamanob7676d52020-11-18 22:15:08[diff] [blame]923 <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:09[diff] [blame]924 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:52[diff] [blame]928</p>
Junio C Hamanob7676d52020-11-18 22:15:08[diff] [blame]929<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:52[diff] [blame]930<div class="ulist"><ul>
931<li>
932<p>
933number
934</p>
Junio C Hamanob7676d52020-11-18 22:15:08[diff] [blame]935<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:52[diff] [blame]936absolute line number (lines count from 1).</p></div>
937</li>
938<li>
939<p>
Junio C Hamanob7676d52020-11-18 22:15:08[diff] [blame]940<code>/regex/</code>
Junio C Hamano7e590a12013-06-02 23:46:52[diff] [blame]941</p>
942<div class="paragraph"><p>This form will use the first line matching the given
Junio C Hamanob7676d52020-11-18 22:15:08[diff] [blame]943POSIX regex. If <em>&lt;start&gt;</em> is a regex, it will search from the end of
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]944the previous <code>-L</code> range, if any, otherwise from the start of file.
Junio C Hamanob7676d52020-11-18 22:15:08[diff] [blame]945If <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:52[diff] [blame]948</li>
949<li>
950<p>
951+offset or -offset
952</p>
Junio C Hamanob7676d52020-11-18 22:15:08[diff] [blame]953<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:52[diff] [blame]955</li>
Junio C Hamano7e590a12013-06-02 23:46:52[diff] [blame]956</ul></div>
Junio C Hamanob7676d52020-11-18 22:15:08[diff] [blame]957<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:32[diff] [blame]958regular expression that denotes the range from the first funcname line
Junio C Hamanob7676d52020-11-18 22:15:08[diff] [blame]959that matches <em>&lt;funcname&gt;</em>, up to the next funcname line. <code>:&lt;funcname&gt;</code>
Junio C Hamanodd5004a2015-05-06 19:33:32[diff] [blame]960searches from the end of the previous <code>-L</code> range, if any, otherwise
Junio C Hamanob7676d52020-11-18 22:15:08[diff] [blame]961from 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:52[diff] [blame]965</dd>
966<dt class="hdlist1">
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]967&lt;revision-range&gt;
Junio C Hamanof26c77e2013-04-27 00:06:04[diff] [blame]968</dt>
969<dd>
970<p>
971 Show only commits in the specified revision range. When no
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]972 &lt;revision-range&gt; is specified, it defaults to <code>HEAD</code> (i.e. the
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]973 whole history leading to the current commit). <code>origin..HEAD</code>
Junio C Hamanof26c77e2013-04-27 00:06:04[diff] [blame]974 specifies all the commits reachable from the current commit
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]975 (i.e. <code>HEAD</code>), but not from <code>origin</code>. For a complete list of
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]976 ways to spell &lt;revision-range&gt;, see the <em>Specifying Ranges</em>
Junio C Hamanof26c77e2013-04-27 00:06:04[diff] [blame]977 section of <a href="gitrevisions.html">gitrevisions(7)</a>.
978</p>
979</dd>
980<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]981[--] &lt;path&gt;&#8230;
982</dt>
983<dd>
984<p>
Junio C Hamano5723afa2011-08-31 00:49:23[diff] [blame]985 Show only commits that are enough to explain how the files
Junio C Hamanob73af6c2013-12-03 22:07:11[diff] [blame]986 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:23[diff] [blame]988 modes.
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]989</p>
Junio C Hamanoccb82522018-05-08 07:52:09[diff] [blame]990<div class="paragraph"><p>Paths may need to be prefixed with <code>--</code> to separate them from
Junio C Hamanof26c77e2013-04-27 00:06:04[diff] [blame]991options or the revision range, when confusion arises.</p></div>
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]992</dd>
993</dl></div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]994<div class="sect2">
995<h3 id="_commit_limiting">Commit Limiting</h3>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]996<div class="paragraph"><p>Besides specifying a range of commits that should be listed using the
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]997special notations explained in the description, additional commit
Junio C Hamano8ce35d72012-09-18 22:30:42[diff] [blame]998limiting 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:51[diff] [blame]1000<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:42[diff] [blame]1003<div class="paragraph"><p>Note that these are applied before commit
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1004ordering and formatting options, such as <code>--reverse</code>.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1005<div class="dlist"><dl>
1006<dt class="hdlist1">
Junio C Hamano693e7092012-09-12 22:56:53[diff] [blame]1007-&lt;number&gt;
1008</dt>
1009<dt class="hdlist1">
1010-n &lt;number&gt;
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1011</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1012<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1013--max-count=&lt;number&gt;
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1014</dt>
1015<dd>
1016<p>
Junio C Hamanoc5be4cc2011-03-09 07:20:43[diff] [blame]1017 Limit the number of commits to output.
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1018</p>
1019</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1020<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1021--skip=&lt;number&gt;
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1022</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:59[diff] [blame]1028<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1029--since=&lt;date&gt;
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1030</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1031<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1032--after=&lt;date&gt;
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1033</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:59[diff] [blame]1039<dt class="hdlist1">
Junio C Hamano72ea2ca2022-05-21 00:51:23[diff] [blame]1040--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:32[diff] [blame]1050--until=&lt;date&gt;
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1051</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1052<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1053--before=&lt;date&gt;
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1054</dt>
1055<dd>
1056<p>
1057 Show commits older than a specific date.
1058</p>
1059</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1060<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1061--author=&lt;pattern&gt;
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1062</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1063<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1064--committer=&lt;pattern&gt;
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1065</dt>
1066<dd>
1067<p>
1068 Limit the commits output to ones with author/committer
Junio C Hamano8ce35d72012-09-18 22:30:42[diff] [blame]1069 header lines that match the specified pattern (regular
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1070 expression). With more than one <code>--author=&lt;pattern&gt;</code>,
Junio C Hamano8ce35d72012-09-18 22:30:42[diff] [blame]1071 commits whose author matches any of the given patterns are
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1072 chosen (similarly for multiple <code>--committer=&lt;pattern&gt;</code>).
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1073</p>
1074</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1075<dt class="hdlist1">
Junio C Hamano9954ed72012-10-03 04:54:00[diff] [blame]1076--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:51[diff] [blame]1082 more than one <code>--grep-reflog</code>, commits whose reflog message
Junio C Hamano9954ed72012-10-03 04:54:00[diff] [blame]1083 matches any of the given patterns are chosen. It is an
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1084 error to use this option unless <code>--walk-reflogs</code> is in use.
Junio C Hamano9954ed72012-10-03 04:54:00[diff] [blame]1085</p>
1086</dd>
1087<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1088--grep=&lt;pattern&gt;
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1089</dt>
1090<dd>
1091<p>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]1092 Limit the commits output to ones with a log message that
Junio C Hamano8ce35d72012-09-18 22:30:42[diff] [blame]1093 matches the specified pattern (regular expression). With
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1094 more than one <code>--grep=&lt;pattern&gt;</code>, commits whose message
Junio C Hamano8ce35d72012-09-18 22:30:42[diff] [blame]1095 matches any of the given patterns are chosen (but see
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1096 <code>--all-match</code>).
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1097</p>
Junio C Hamanob3f862c2019-12-05 22:22:00[diff] [blame]1098<div class="paragraph"><p>When <code>--notes</code> is in effect, the message from the notes is
Junio C Hamano8152abf2015-04-28 22:48:02[diff] [blame]1099matched as if it were part of the log message.</p></div>
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1100</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1101<dt class="hdlist1">
Junio C Hamanoaa17c7c2008-11-03 04:36:58[diff] [blame]1102--all-match
1103</dt>
1104<dd>
1105<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1106 Limit the commits output to ones that match all given <code>--grep</code>,
Junio C Hamano8ce35d72012-09-18 22:30:42[diff] [blame]1107 instead of ones that match at least one.
Junio C Hamanoaa17c7c2008-11-03 04:36:58[diff] [blame]1108</p>
1109</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1110<dt class="hdlist1">
Junio C Hamano6bb32e62015-02-17 22:11:26[diff] [blame]1111--invert-grep
1112</dt>
1113<dd>
1114<p>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]1115 Limit the commits output to ones with a log message that do not
Junio C Hamano6bb32e62015-02-17 22:11:26[diff] [blame]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:47[diff] [blame]1120-i
1121</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1122<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1123--regexp-ignore-case
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1124</dt>
1125<dd>
1126<p>
Junio C Hamanob73af6c2013-12-03 22:07:11[diff] [blame]1127 Match the regular expression limiting patterns without regard to letter
1128 case.
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1129</p>
1130</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1131<dt class="hdlist1">
Junio C Hamanoa1295452012-11-13 22:32:04[diff] [blame]1132--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:47[diff] [blame]1141-E
1142</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1143<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1144--extended-regexp
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1145</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:59[diff] [blame]1152<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1153-F
1154</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1155<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1156--fixed-strings
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]1157</dt>
1158<dd>
1159<p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1160 Consider the limiting patterns to be fixed strings (don&#8217;t interpret
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]1161 pattern as a regular expression).
1162</p>
1163</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1164<dt class="hdlist1">
Junio C Hamanoa275c1f2017-06-19 20:10:12[diff] [blame]1165-P
1166</dt>
1167<dt class="hdlist1">
Junio C Hamanoa1295452012-11-13 22:32:04[diff] [blame]1168--perl-regexp
1169</dt>
1170<dd>
1171<p>
Junio C Hamano222ed822017-06-02 06:24:06[diff] [blame]1172 Consider the limiting patterns to be Perl-compatible regular
1173 expressions.
Junio C Hamanoa1295452012-11-13 22:32:04[diff] [blame]1174</p>
Junio C Hamano222ed822017-06-02 06:24:06[diff] [blame]1175<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:04[diff] [blame]1178</dd>
1179<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1180--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:59[diff] [blame]1187<dt class="hdlist1">
Junio C Hamano934e1782009-07-16 06:59:15[diff] [blame]1188--merges
1189</dt>
1190<dd>
1191<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1192 Print only merge commits. This is exactly the same as <code>--min-parents=2</code>.
Junio C Hamano934e1782009-07-16 06:59:15[diff] [blame]1193</p>
1194</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1195<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1196--no-merges
1197</dt>
1198<dd>
1199<p>
Junio C Hamanof32ce262011-03-27 07:35:11[diff] [blame]1200 Do not print commits with more than one parent. This is
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1201 exactly the same as <code>--max-parents=1</code>.
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1202</p>
1203</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1204<dt class="hdlist1">
Junio C Hamanof32ce262011-03-27 07:35:11[diff] [blame]1205--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:36[diff] [blame]1218 Show only commits which have at least (or at most) that many parent
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1219 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:11[diff] [blame]1222</p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1223<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:11[diff] [blame]1226</dd>
1227<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1228--first-parent
1229</dt>
1230<dd>
1231<p>
Junio C Hamano034a2ff2022-02-18 00:40:11[diff] [blame]1232 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:00[diff] [blame]1240</p>
Junio C Hamanoa372d5b2021-02-26 01:34:37[diff] [blame]1241<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:00[diff] [blame]1243</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1244<dt class="hdlist1">
Junio C Hamano034a2ff2022-02-18 00:40:11[diff] [blame]1245--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:00[diff] [blame]1257--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:51[diff] [blame]1262 for all following revision specifiers, up to the next <code>--not</code>.
Junio C Hamano293a47b2023-10-04 22:45:56[diff] [blame]1263 When used on the command line before --stdin, the revisions passed
1264 through stdin will not be affected by it. Conversely, when passed
1265 via standard input, the revisions passed on the command line will
1266 not be affected by it.
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1267</p>
1268</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1269<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1270--all
1271</dt>
1272<dd>
1273<p>
Junio C Hamanoe89102f2017-02-15 23:18:15[diff] [blame]1274 Pretend as if all the refs in <code>refs/</code>, along with <code>HEAD</code>, are
1275 listed on the command line as <em>&lt;commit&gt;</em>.
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1276</p>
1277</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1278<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]1279--branches[=&lt;pattern&gt;]
Junio C Hamano50819852008-11-19 02:07:56[diff] [blame]1280</dt>
1281<dd>
1282<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1283 Pretend as if all the refs in <code>refs/heads</code> are listed
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]1284 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:50[diff] [blame]1285 branches to ones matching given shell glob. If pattern lacks <em>?</em>,
Junio C Hamano81d540a2012-03-02 19:52:47[diff] [blame]1286 <em>&#42;</em>, or <em>[</em>, <em>/&#42;</em> at the end is implied.
Junio C Hamano50819852008-11-19 02:07:56[diff] [blame]1287</p>
1288</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1289<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]1290--tags[=&lt;pattern&gt;]
Junio C Hamano50819852008-11-19 02:07:56[diff] [blame]1291</dt>
1292<dd>
1293<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1294 Pretend as if all the refs in <code>refs/tags</code> are listed
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]1295 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:47[diff] [blame]1296 tags to ones matching given shell glob. If pattern lacks <em>?</em>, <em>&#42;</em>,
1297 or <em>[</em>, <em>/&#42;</em> at the end is implied.
Junio C Hamano50819852008-11-19 02:07:56[diff] [blame]1298</p>
1299</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1300<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]1301--remotes[=&lt;pattern&gt;]
Junio C Hamano50819852008-11-19 02:07:56[diff] [blame]1302</dt>
1303<dd>
1304<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1305 Pretend as if all the refs in <code>refs/remotes</code> are listed
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]1306 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:07[diff] [blame]1307 remote-tracking branches to ones matching given shell glob.
Junio C Hamano81d540a2012-03-02 19:52:47[diff] [blame]1308 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:50[diff] [blame]1309</p>
1310</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1311<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]1312--glob=&lt;glob-pattern&gt;
Junio C Hamano57827fb2010-01-23 03:02:50[diff] [blame]1313</dt>
1314<dd>
1315<p>
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]1316 Pretend as if all the refs matching shell glob <em>&lt;glob-pattern&gt;</em>
Junio C Hamano57827fb2010-01-23 03:02:50[diff] [blame]1317 are listed on the command line as <em>&lt;commit&gt;</em>. Leading <em>refs/</em>,
Junio C Hamano81d540a2012-03-02 19:52:47[diff] [blame]1318 is automatically prepended if missing. If pattern lacks <em>?</em>, <em>&#42;</em>,
1319 or <em>[</em>, <em>/&#42;</em> at the end is implied.
Junio C Hamano50819852008-11-19 02:07:56[diff] [blame]1320</p>
1321</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1322<dt class="hdlist1">
Junio C Hamanof079f702013-12-06 23:43:18[diff] [blame]1323--exclude=&lt;glob-pattern&gt;
1324</dt>
1325<dd>
1326<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1327 Do not include refs matching <em>&lt;glob-pattern&gt;</em> that the next <code>--all</code>,
1328 <code>--branches</code>, <code>--tags</code>, <code>--remotes</code>, or <code>--glob</code> would otherwise
Junio C Hamanof079f702013-12-06 23:43:18[diff] [blame]1329 consider. Repetitions of this option accumulate exclusion patterns
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1330 up to the next <code>--all</code>, <code>--branches</code>, <code>--tags</code>, <code>--remotes</code>, or
1331 <code>--glob</code> option (other options or arguments do not clear
Junio C Hamanofb5ffde2014-11-04 22:38:56[diff] [blame]1332 accumulated patterns).
Junio C Hamanof079f702013-12-06 23:43:18[diff] [blame]1333</p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1334<div class="paragraph"><p>The patterns given should not begin with <code>refs/heads</code>, <code>refs/tags</code>, or
1335<code>refs/remotes</code> when applied to <code>--branches</code>, <code>--tags</code>, or <code>--remotes</code>,
1336respectively, and they must begin with <code>refs/</code> when applied to <code>--glob</code>
1337or <code>--all</code>. If a trailing <em>/&#42;</em> is intended, it must be given
Junio C Hamanof079f702013-12-06 23:43:18[diff] [blame]1338explicitly.</p></div>
1339</dd>
1340<dt class="hdlist1">
Junio C Hamano42ce67d2023-03-17 21:36:41[diff] [blame]1341--exclude-hidden=[fetch|receive|uploadpack]
Junio C Hamanoe6ab9192022-11-23 04:01:36[diff] [blame]1342</dt>
1343<dd>
1344<p>
Junio C Hamano42ce67d2023-03-17 21:36:41[diff] [blame]1345 Do not include refs that would be hidden by <code>git-fetch</code>,
1346 <code>git-receive-pack</code> or <code>git-upload-pack</code> by consulting the appropriate
1347 <code>fetch.hideRefs</code>, <code>receive.hideRefs</code> or <code>uploadpack.hideRefs</code>
1348 configuration along with <code>transfer.hideRefs</code> (see
Junio C Hamanoe6ab9192022-11-23 04:01:36[diff] [blame]1349 <a href="git-config.html">git-config(1)</a>). This option affects the next pseudo-ref option
1350 <code>--all</code> or <code>--glob</code> and is cleared after processing them.
1351</p>
1352</dd>
1353<dt class="hdlist1">
Junio C Hamano2a4bcbc2014-10-29 20:07:39[diff] [blame]1354--reflog
1355</dt>
1356<dd>
1357<p>
1358 Pretend as if all objects mentioned by reflogs are listed on the
1359 command line as <code>&lt;commit&gt;</code>.
1360</p>
1361</dd>
1362<dt class="hdlist1">
Junio C Hamanoa42e0332019-07-19 19:49:37[diff] [blame]1363--alternate-refs
1364</dt>
1365<dd>
1366<p>
1367 Pretend as if all objects mentioned as ref tips of alternate
1368 repositories were listed on the command line. An alternate
1369 repository is any repository whose object directory is specified
1370 in <code>objects/info/alternates</code>. The set of included objects may
1371 be modified by <code>core.alternateRefsCommand</code>, etc. See
1372 <a href="git-config.html">git-config(1)</a>.
1373</p>
1374</dd>
1375<dt class="hdlist1">
Junio C Hamano8d57fa92017-09-19 05:01:08[diff] [blame]1376--single-worktree
1377</dt>
1378<dd>
1379<p>
1380 By default, all working trees will be examined by the
1381 following options when there are more than one (see
1382 <a href="git-worktree.html">git-worktree(1)</a>): <code>--all</code>, <code>--reflog</code> and
1383 <code>--indexed-objects</code>.
1384 This option forces them to examine the current working tree
1385 only.
1386</p>
1387</dd>
1388<dt class="hdlist1">
Junio C Hamano084228c2011-05-30 08:13:52[diff] [blame]1389--ignore-missing
1390</dt>
1391<dd>
1392<p>
1393 Upon seeing an invalid object name in the input, pretend as if
1394 the bad input was not given.
1395</p>
1396</dd>
1397<dt class="hdlist1">
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]1398--bisect
1399</dt>
1400<dd>
1401<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1402 Pretend as if the bad bisection ref <code>refs/bisect/bad</code>
1403 was listed and as if it was followed by <code>--not</code> and the good
1404 bisection refs <code>refs/bisect/good-*</code> on the command
Junio C Hamano255163d2020-08-18 00:37:23[diff] [blame]1405 line.
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]1406</p>
1407</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1408<dt class="hdlist1">
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]1409--stdin
1410</dt>
1411<dd>
1412<p>
Junio C Hamano0f401e12023-07-05 05:23:09[diff] [blame]1413 In addition to getting arguments from the command line, read
Junio C Hamano6018d902023-08-18 00:20:22[diff] [blame]1414 them from standard input as well. This accepts commits and
Junio C Hamano0f401e12023-07-05 05:23:09[diff] [blame]1415 pseudo-options like <code>--all</code> and <code>--glob=</code>. When a <code>--</code> separator
1416 is seen, the following input is treated as paths and used to
Junio C Hamano293a47b2023-10-04 22:45:56[diff] [blame]1417 limit the result. Flags like <code>--not</code> which are read via standard input
1418 are only respected for arguments passed in the same way and will not
1419 influence any subsequent command line arguments.
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]1420</p>
1421</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1422<dt class="hdlist1">
Junio C Hamano9a2fb2d2011-03-23 05:40:15[diff] [blame]1423--cherry-mark
1424</dt>
1425<dd>
1426<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1427 Like <code>--cherry-pick</code> (see below) but mark equivalent commits
1428 with <code>=</code> rather than omitting them, and inequivalent ones with <code>+</code>.
Junio C Hamano9a2fb2d2011-03-23 05:40:15[diff] [blame]1429</p>
1430</dd>
1431<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1432--cherry-pick
1433</dt>
1434<dd>
1435<p>
1436 Omit any commit that introduces the same change as
Junio C Hamanob73af6c2013-12-03 22:07:11[diff] [blame]1437 another commit on the &#8220;other side&#8221; when the set of
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1438 commits are limited with symmetric difference.
1439</p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1440<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:00[diff] [blame]1441to list all commits on only one side of them is with
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1442<code>--left-right</code> (see the example below in the description of
1443the <code>--left-right</code> option). However, it shows the commits that were
Junio C Hamanob73af6c2013-12-03 22:07:11[diff] [blame]1444cherry-picked from the other branch (for example, &#8220;3rd on b&#8221; may be
1445cherry-picked from branch A). With this option, such pairs of commits are
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1446excluded from the output.</p></div>
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1447</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1448<dt class="hdlist1">
Junio C Hamano9a2fb2d2011-03-23 05:40:15[diff] [blame]1449--left-only
1450</dt>
1451<dt class="hdlist1">
1452--right-only
1453</dt>
1454<dd>
1455<p>
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]1456 List only commits on the respective side of a symmetric difference,
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1457 i.e. only those which would be marked <code>&lt;</code> resp. <code>&gt;</code> by
1458 <code>--left-right</code>.
Junio C Hamano9a2fb2d2011-03-23 05:40:15[diff] [blame]1459</p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1460<div class="paragraph"><p>For example, <code>--cherry-pick --right-only A...B</code> omits those
1461commits from <code>B</code> which are in <code>A</code> or are patch-equivalent to a commit in
1462<code>A</code>. In other words, this lists the <code>+</code> commits from <code>git cherry A B</code>.
1463More precisely, <code>--cherry-pick --right-only --no-merges</code> gives the exact
Junio C Hamano9a2fb2d2011-03-23 05:40:15[diff] [blame]1464list.</p></div>
1465</dd>
1466<dt class="hdlist1">
1467--cherry
1468</dt>
1469<dd>
1470<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1471 A synonym for <code>--right-only --cherry-mark --no-merges</code>; useful to
Junio C Hamano9a2fb2d2011-03-23 05:40:15[diff] [blame]1472 limit the output to the commits on our side and mark those that
1473 have been applied to the other side of a forked history with
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1474 <code>git log --cherry upstream...mybranch</code>, similar to
1475 <code>git cherry upstream mybranch</code>.
Junio C Hamano9a2fb2d2011-03-23 05:40:15[diff] [blame]1476</p>
1477</dd>
1478<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1479-g
1480</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1481<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1482--walk-reflogs
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1483</dt>
1484<dd>
1485<p>
1486 Instead of walking the commit ancestry chain, walk
1487 reflog entries from the most recent one to older ones.
1488 When this option is used you cannot specify commits to
1489 exclude (that is, <em>&#94;commit</em>, <em>commit1..commit2</em>,
Junio C Hamanod75148a2014-04-08 19:48:38[diff] [blame]1490 and <em>commit1...commit2</em> notations cannot be used).
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1491</p>
Junio C Hamanob4896852019-12-10 23:15:09[diff] [blame]1492<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:00[diff] [blame]1493this causes the output to have two extra lines of information
Junio C Hamanoe548d1b2016-08-08 22:26:49[diff] [blame]1494taken from the reflog. The reflog designator in the output may be shown
1495as <code>ref@{Nth}</code> (where <code>Nth</code> is the reverse-chronological index in the
1496reflog) or as <code>ref@{timestamp}</code> (with the timestamp for that entry),
1497depending on a few rules:</p></div>
1498<div class="openblock">
1499<div class="content">
1500<div class="olist arabic"><ol class="arabic">
1501<li>
1502<p>
1503If the starting point is specified as <code>ref@{Nth}</code>, show the index
Junio C Hamano2567b322019-02-05 23:33:56[diff] [blame]1504 format.
Junio C Hamanoe548d1b2016-08-08 22:26:49[diff] [blame]1505</p>
1506</li>
1507<li>
1508<p>
1509If the starting point was specified as <code>ref@{now}</code>, show the
Junio C Hamano2567b322019-02-05 23:33:56[diff] [blame]1510 timestamp format.
Junio C Hamanoe548d1b2016-08-08 22:26:49[diff] [blame]1511</p>
1512</li>
1513<li>
1514<p>
1515If neither was used, but <code>--date</code> was given on the command line, show
Junio C Hamano2567b322019-02-05 23:33:56[diff] [blame]1516 the timestamp in the format requested by <code>--date</code>.
Junio C Hamanoe548d1b2016-08-08 22:26:49[diff] [blame]1517</p>
1518</li>
1519<li>
1520<p>
1521Otherwise, show the index format.
1522</p>
1523</li>
1524</ol></div>
1525</div></div>
1526<div class="paragraph"><p>Under <code>--pretty=oneline</code>, the commit message is
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1527prefixed with this information on the same line.
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1528This option cannot be combined with <code>--reverse</code>.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1529See also <a href="git-reflog.html">git-reflog(1)</a>.</p></div>
Junio C Hamanob4896852019-12-10 23:15:09[diff] [blame]1530<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:00[diff] [blame]1531</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1532<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1533--merge
1534</dt>
1535<dd>
1536<p>
1537 After a failed merge, show refs that touch files having a
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1538 conflict and don&#8217;t exist on all heads to merge.
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1539</p>
1540</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1541<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1542--boundary
1543</dt>
1544<dd>
1545<p>
Junio C Hamano27159f82013-06-14 17:19:22[diff] [blame]1546 Output excluded boundary commits. Boundary commits are
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1547 prefixed with <code>-</code>.
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1548</p>
1549</dd>
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1550</dl></div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]1551</div>
1552<div class="sect2">
1553<h3 id="_history_simplification">History Simplification</h3>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1554<div class="paragraph"><p>Sometimes you are only interested in parts of the history, for example the
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]1555commits modifying a particular &lt;path&gt;. But there are two parts of
1556<em>History Simplification</em>, one part is selecting the commits and the other
1557is how to do it, as there are various strategies to simplify the history.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1558<div class="paragraph"><p>The following options select the commits to be shown:</p></div>
1559<div class="dlist"><dl>
1560<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]1561&lt;paths&gt;
1562</dt>
1563<dd>
1564<p>
1565 Commits modifying the given &lt;paths&gt; are selected.
1566</p>
1567</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1568<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]1569--simplify-by-decoration
1570</dt>
1571<dd>
1572<p>
1573 Commits that are referred by some branch or tag are selected.
1574</p>
1575</dd>
1576</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1577<div class="paragraph"><p>Note that extra commits can be shown to give a meaningful history.</p></div>
1578<div class="paragraph"><p>The following options affect the way the simplification is performed:</p></div>
1579<div class="dlist"><dl>
1580<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]1581Default mode
1582</dt>
1583<dd>
1584<p>
1585 Simplifies the history to the simplest history explaining the
1586 final state of the tree. Simplest because it prunes some side
1587 branches if the end result is the same (i.e. merging branches
1588 with the same content)
1589</p>
1590</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1591<dt class="hdlist1">
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]1592--show-pulls
1593</dt>
1594<dd>
1595<p>
1596 Include all commits from the default mode, but also any merge
1597 commits that are not TREESAME to the first parent but are
1598 TREESAME to a later parent. This mode is helpful for showing
1599 the merge commits that "first introduced" a change to a branch.
1600</p>
1601</dd>
1602<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]1603--full-history
1604</dt>
1605<dd>
1606<p>
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]1607 Same as the default mode, but does not prune some history.
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]1608</p>
1609</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1610<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]1611--dense
1612</dt>
1613<dd>
1614<p>
1615 Only the selected commits are shown, plus some to have a
1616 meaningful history.
1617</p>
1618</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1619<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]1620--sparse
1621</dt>
1622<dd>
1623<p>
1624 All commits in the simplified history are shown.
1625</p>
1626</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1627<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]1628--simplify-merges
1629</dt>
1630<dd>
1631<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1632 Additional option to <code>--full-history</code> to remove some needless
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]1633 merges from the resulting history, as there are no selected
1634 commits contributing to this merge.
1635</p>
1636</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1637<dt class="hdlist1">
Junio C Hamano594d2d42022-08-30 17:58:50[diff] [blame]1638--ancestry-path[=&lt;commit&gt;]
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]1639</dt>
1640<dd>
1641<p>
1642 When given a range of commits to display (e.g. <em>commit1..commit2</em>
Junio C Hamano594d2d42022-08-30 17:58:50[diff] [blame]1643 or <em>commit2 &#94;commit1</em>), only display commits in that range
1644 that are ancestors of &lt;commit&gt;, descendants of &lt;commit&gt;, or
1645 &lt;commit&gt; itself. If no commit is specified, use <em>commit1</em> (the
1646 excluded part of the range) as &lt;commit&gt;. Can be passed multiple
1647 times; if so, a commit is included if it is any of the commits
1648 given or if it is an ancestor or descendant of one of them.
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]1649</p>
1650</dd>
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]1651</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1652<div class="paragraph"><p>A more detailed explanation follows.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1653<div class="paragraph"><p>Suppose you specified <code>foo</code> as the &lt;paths&gt;. We shall call commits
1654that modify <code>foo</code> !TREESAME, and the rest TREESAME. (In a diff
1655filtered for <code>foo</code>, they look different and equal, respectively.)</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1656<div class="paragraph"><p>In the following, we will always refer to the same example history to
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1657illustrate the differences between simplification settings. We assume
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1658that you are filtering for a file <code>foo</code> in this commit graph:</p></div>
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1659<div class="listingblock">
1660<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1661<pre><code> .-A---M---N---O---P---Q
Junio C Hamano27159f82013-06-14 17:19:22[diff] [blame]1662 / / / / / /
1663 I B C D E Y
1664 \ / / / / /
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1665 `-------------' X</code></pre>
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1666</div></div>
Junio C Hamano27159f82013-06-14 17:19:22[diff] [blame]1667<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:10[diff] [blame]1668each merge. The commits are:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1669<div class="ulist"><ul>
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1670<li>
1671<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1672<code>I</code> is the initial commit, in which <code>foo</code> exists with contents
1673 &#8220;asdf&#8221;, and a file <code>quux</code> exists with contents &#8220;quux&#8221;. Initial
1674 commits are compared to an empty tree, so <code>I</code> is !TREESAME.
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1675</p>
1676</li>
1677<li>
1678<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1679In <code>A</code>, <code>foo</code> contains just &#8220;foo&#8221;.
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1680</p>
1681</li>
1682<li>
1683<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1684<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:10[diff] [blame]1685 hence TREESAME to all parents.
1686</p>
1687</li>
1688<li>
1689<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1690<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:10[diff] [blame]1691 so it is not TREESAME to any parent.
1692</p>
1693</li>
1694<li>
1695<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1696<code>D</code> sets <code>foo</code> to &#8220;baz&#8221;. Its merge <code>O</code> combines the strings from
1697 <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:10[diff] [blame]1698</p>
1699</li>
1700<li>
1701<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1702<code>E</code> changes <code>quux</code> to &#8220;xyzzy&#8221;, and its merge <code>P</code> combines the
1703 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:22[diff] [blame]1704</p>
1705</li>
1706<li>
1707<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1708<code>X</code> is an independent root commit that added a new file <code>side</code>, and <code>Y</code>
1709 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
1710 <code>Q</code> is TREESAME to <code>P</code>, but not to <code>Y</code>.
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1711</p>
1712</li>
1713</ul></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1714<div class="paragraph"><p><code>rev-list</code> walks backwards through history, including or excluding
1715commits based on whether <code>--full-history</code> and/or parent rewriting
1716(via <code>--parents</code> or <code>--children</code>) are used. The following settings
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1717are available.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1718<div class="dlist"><dl>
1719<dt class="hdlist1">
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1720Default mode
1721</dt>
1722<dd>
1723<p>
1724 Commits are included if they are not TREESAME to any parent
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1725 (though this can be changed, see <code>--sparse</code> below). If the
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1726 commit was a merge, and it was TREESAME to one parent, follow
1727 only that parent. (Even if there are several TREESAME
1728 parents, follow only one of them.) Otherwise, follow all
1729 parents.
1730</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1731<div class="paragraph"><p>This results in:</p></div>
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1732<div class="listingblock">
1733<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1734<pre><code> .-A---N---O
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]1735 / / /
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1736 I---------D</code></pre>
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1737</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1738<div class="paragraph"><p>Note how the rule to only follow the TREESAME parent, if one is
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1739available, removed <code>B</code> from consideration entirely. <code>C</code> was
1740considered via <code>N</code>, but is TREESAME. Root commits are compared to an
1741empty tree, so <code>I</code> is !TREESAME.</p></div>
1742<div class="paragraph"><p>Parent/child relations are only visible with <code>--parents</code>, but that does
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1743not affect the commits selected in default mode, so we have shown the
1744parent lines.</p></div>
1745</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1746<dt class="hdlist1">
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1747--full-history without parent rewriting
1748</dt>
1749<dd>
1750<p>
1751 This mode differs from the default in one point: always follow
1752 all parents of a merge, even if it is TREESAME to one of them.
1753 Even if more than one side of the merge has commits that are
1754 included, this does not imply that the merge itself is! In
1755 the example, we get
1756</p>
1757<div class="listingblock">
1758<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1759<pre><code> I A B N D O P Q</code></pre>
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1760</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1761<div class="paragraph"><p><code>M</code> was excluded because it is TREESAME to both parents. <code>E</code>,
1762<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:10[diff] [blame]1763do not appear.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1764<div class="paragraph"><p>Note that without parent rewriting, it is not really possible to talk
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1765about the parent/child relationships between the commits, so we show
1766them disconnected.</p></div>
1767</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1768<dt class="hdlist1">
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1769--full-history with parent rewriting
1770</dt>
1771<dd>
1772<p>
1773 Ordinary commits are only included if they are !TREESAME
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1774 (though this can be changed, see <code>--sparse</code> below).
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1775</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1776<div class="paragraph"><p>Merges are always included. However, their parent list is rewritten:
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1777Along each parent, prune away commits that are not included
1778themselves. This results in</p></div>
1779<div class="listingblock">
1780<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1781<pre><code> .-A---M---N---O---P---Q
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1782 / / / / /
1783 I B / D /
1784 \ / / / /
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1785 `-------------'</code></pre>
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1786</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1787<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:10[diff] [blame]1788was pruned away because it is TREESAME, but the parent list of P was
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1789rewritten to contain <code>E</code>'s parent <code>I</code>. The same happened for <code>C</code> and
1790<code>N</code>, and <code>X</code>, <code>Y</code> and <code>Q</code>.</p></div>
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1791</dd>
1792</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1793<div class="paragraph"><p>In addition to the above settings, you can change whether TREESAME
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1794affects inclusion:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1795<div class="dlist"><dl>
1796<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1797--dense
1798</dt>
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1799<dd>
1800<p>
1801 Commits that are walked are included if they are not TREESAME
1802 to any parent.
1803</p>
1804</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1805<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1806--sparse
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1807</dt>
1808<dd>
1809<p>
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1810 All commits that are walked are included.
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1811</p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1812<div class="paragraph"><p>Note that without <code>--full-history</code>, this still simplifies merges: if
Junio C Hamanoa76cb0d2008-08-13 20:04:10[diff] [blame]1813one of the parents is TREESAME, we follow only that one, so the other
1814sides of the merge are never walked.</p></div>
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]1815</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1816<dt class="hdlist1">
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]1817--simplify-merges
1818</dt>
1819<dd>
1820<p>
1821 First, build a history graph in the same way that
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1822 <code>--full-history</code> with parent rewriting does (see above).
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]1823</p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1824<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:31[diff] [blame]1825history according to the following rules:</p></div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]1826<div class="openblock">
1827<div class="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1828<div class="ulist"><ul>
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]1829<li>
1830<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1831Set <code>C'</code> to <code>C</code>.
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]1832</p>
1833</li>
1834<li>
1835<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1836Replace each parent <code>P</code> of <code>C'</code> with its simplification <code>P'</code>. In
Junio C Hamano27159f82013-06-14 17:19:22[diff] [blame]1837 the process, drop parents that are ancestors of other parents or that are
1838 root commits TREESAME to an empty tree, and remove duplicates, but take care
1839 to never drop all parents that we are TREESAME to.
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]1840</p>
1841</li>
1842<li>
1843<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1844If after this parent rewriting, <code>C'</code> is a root or merge commit (has
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]1845 zero or &gt;1 parents), a boundary commit, or !TREESAME, it remains.
1846 Otherwise, it is replaced with its only parent.
1847</p>
1848</li>
1849</ul></div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]1850</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1851<div class="paragraph"><p>The effect of this is best shown by way of comparing to
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1852<code>--full-history</code> with parent rewriting. The example turns into:</p></div>
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]1853<div class="listingblock">
1854<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1855<pre><code> .-A---M---N---O
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]1856 / / /
1857 I B D
1858 \ / /
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1859 `---------'</code></pre>
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]1860</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1861<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:27[diff] [blame]1862<div class="openblock">
1863<div class="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1864<div class="ulist"><ul>
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]1865<li>
1866<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1867<code>N</code>'s parent list had <code>I</code> removed, because it is an ancestor of the
1868 other parent <code>M</code>. Still, <code>N</code> remained because it is !TREESAME.
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]1869</p>
1870</li>
1871<li>
1872<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1873<code>P</code>'s parent list similarly had <code>I</code> removed. <code>P</code> was then
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]1874 removed completely, because it had one parent and is TREESAME.
1875</p>
1876</li>
Junio C Hamano27159f82013-06-14 17:19:22[diff] [blame]1877<li>
1878<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1879<code>Q</code>'s parent list had <code>Y</code> simplified to <code>X</code>. <code>X</code> was then removed, because it
1880 was a TREESAME root. <code>Q</code> was then removed completely, because it had one
Junio C Hamano27159f82013-06-14 17:19:22[diff] [blame]1881 parent and is TREESAME.
1882</p>
1883</li>
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]1884</ul></div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]1885</div></div>
Junio C Hamanoa2f46622008-09-03 05:20:31[diff] [blame]1886</dd>
1887</dl></div>
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]1888<div class="paragraph"><p>There is another simplification mode available:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1889<div class="dlist"><dl>
1890<dt class="hdlist1">
Junio C Hamano594d2d42022-08-30 17:58:50[diff] [blame]1891--ancestry-path[=&lt;commit&gt;]
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]1892</dt>
1893<dd>
1894<p>
Junio C Hamano594d2d42022-08-30 17:58:50[diff] [blame]1895 Limit the displayed commits to those which are an ancestor of
1896 &lt;commit&gt;, or which are a descendant of &lt;commit&gt;, or are &lt;commit&gt;
1897 itself.
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]1898</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1899<div class="paragraph"><p>As an example use case, consider the following commit history:</p></div>
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]1900<div class="listingblock">
1901<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1902<pre><code> D---E-------F
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]1903 / \ \
1904 B---C---G---H---I---J
1905 / \
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1906 A-------K---------------L--M</code></pre>
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]1907</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1908<div class="paragraph"><p>A regular <em>D..M</em> computes the set of commits that are ancestors of <code>M</code>,
1909but excludes the ones that are ancestors of <code>D</code>. This is useful to see
1910what happened to the history leading to <code>M</code> since <code>D</code>, in the sense
1911that &#8220;what does <code>M</code> have that did not exist in <code>D</code>&#8221;. The result in this
1912example 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:55[diff] [blame]1913of course).</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1914<div class="paragraph"><p>When we want to find out what commits in <code>M</code> are contaminated with the
1915bug introduced by <code>D</code> and need fixing, however, we might want to view
1916only the subset of <em>D..M</em> that are actually descendants of <code>D</code>, i.e.
1917excluding <code>C</code> and <code>K</code>. This is exactly what the <code>--ancestry-path</code>
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]1918option does. Applied to the <em>D..M</em> range, it results in:</p></div>
1919<div class="listingblock">
1920<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1921<pre><code> E-------F
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]1922 \ \
1923 G---H---I---J
1924 \
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1925 L--M</code></pre>
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]1926</div></div>
Junio C Hamano594d2d42022-08-30 17:58:50[diff] [blame]1927<div class="paragraph"><p>We can also use <code>--ancestry-path=D</code> instead of <code>--ancestry-path</code> which
1928means the same thing when applied to the <em>D..M</em> range but is just more
1929explicit.</p></div>
1930<div class="paragraph"><p>If we instead are interested in a given topic within this range, and all
1931commits affected by that topic, we may only want to view the subset of
1932<code>D..M</code> which contain that topic in their ancestry path. So, using
1933<code>--ancestry-path=H D..M</code> for example would result in:</p></div>
1934<div class="listingblock">
1935<div class="content">
1936<pre><code> E
1937 \
1938 G---H---I---J
1939 \
1940 L--M</code></pre>
1941</div></div>
1942<div class="paragraph"><p>Whereas <code>--ancestry-path=K D..M</code> would result in</p></div>
1943<div class="listingblock">
1944<div class="content">
1945<pre><code> K---------------L--M</code></pre>
1946</div></div>
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]1947</dd>
1948</dl></div>
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]1949<div class="paragraph"><p>Before discussing another option, <code>--show-pulls</code>, we need to
1950create a new example history.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:39[diff] [blame]1951<div class="paragraph"><p>A common problem users face when looking at simplified history is that a
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]1952commit they know changed a file somehow does not appear in the file&#8217;s
1953simplified history. Let&#8217;s demonstrate a new example and show how options
1954such as <code>--full-history</code> and <code>--simplify-merges</code> works in that case:</p></div>
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]1955<div class="listingblock">
1956<div class="content">
1957<pre><code> .-A---M-----C--N---O---P
1958 / / \ \ \/ / /
1959 I B \ R-'`-Z' /
1960 \ / \/ /
1961 \ / /\ /
1962 `---X--' `---Y--'</code></pre>
1963</div></div>
Junio C Hamano0cb719f2020-05-31 20:04:39[diff] [blame]1964<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:44[diff] [blame]1965<code>A</code>, <code>B</code>, and <code>X</code> in different ways. The single-parent commits <code>C</code>, <code>Z</code>,
1966and <code>Y</code> do not change <code>file.txt</code>. The merge commit <code>M</code> was created by
1967resolving the merge conflict to include both changes from <code>A</code> and <code>B</code>
1968and hence is not TREESAME to either. The merge commit <code>R</code>, however, was
1969created by ignoring the contents of <code>file.txt</code> at <code>M</code> and taking only
1970the contents of <code>file.txt</code> at <code>X</code>. Hence, <code>R</code> is TREESAME to <code>X</code> but not
1971<code>M</code>. Finally, the natural merge resolution to create <code>N</code> is to take the
1972contents of <code>file.txt</code> at <code>R</code>, so <code>N</code> is TREESAME to <code>R</code> but not <code>C</code>.
1973The merge commits <code>O</code> and <code>P</code> are TREESAME to their first parents, but
1974not to their second parents, <code>Z</code> and <code>Y</code> respectively.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:39[diff] [blame]1975<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:44[diff] [blame]1976those edges are walked and the others are ignored. The resulting history
1977graph is:</p></div>
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]1978<div class="listingblock">
1979<div class="content">
1980<pre><code> I---X</code></pre>
1981</div></div>
Junio C Hamano0cb719f2020-05-31 20:04:39[diff] [blame]1982<div class="paragraph"><p>When using <code>--full-history</code>, Git walks every edge. This will discover
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]1983the commits <code>A</code> and <code>B</code> and the merge <code>M</code>, but also will reveal the
1984merge commits <code>O</code> and <code>P</code>. With parent rewriting, the resulting graph is:</p></div>
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]1985<div class="listingblock">
1986<div class="content">
1987<pre><code> .-A---M--------N---O---P
1988 / / \ \ \/ / /
1989 I B \ R-'`--' /
1990 \ / \/ /
1991 \ / /\ /
1992 `---X--' `------'</code></pre>
1993</div></div>
Junio C Hamano0cb719f2020-05-31 20:04:39[diff] [blame]1994<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:44[diff] [blame]1995not actually contribute a change to <code>file.txt</code>. They only merged a topic
1996that was based on an older version of <code>file.txt</code>. This is a common
1997issue in repositories using a workflow where many contributors work in
Junio C Hamano594d2d42022-08-30 17:58:50[diff] [blame]1998parallel and merge their topic branches along a single trunk: many
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]1999unrelated merges appear in the <code>--full-history</code> results.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:39[diff] [blame]2000<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:44[diff] [blame]2001disappear from the results. This is because the rewritten second parents
2002of <code>O</code> and <code>P</code> are reachable from their first parents. Those edges are
2003removed and then the commits look like single-parent commits that are
2004TREESAME to their parent. This also happens to the commit <code>N</code>, resulting
2005in a history view as follows:</p></div>
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]2006<div class="listingblock">
2007<div class="content">
2008<pre><code> .-A---M--.
2009 / / \
2010 I B R
2011 \ / /
2012 \ / /
2013 `---X--'</code></pre>
2014</div></div>
Junio C Hamano0cb719f2020-05-31 20:04:39[diff] [blame]2015<div class="paragraph"><p>In this view, we see all of the important single-parent changes from
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]2016<code>A</code>, <code>B</code>, and <code>X</code>. We also see the carefully-resolved merge <code>M</code> and the
2017not-so-carefully-resolved merge <code>R</code>. This is usually enough information
2018to determine why the commits <code>A</code> and <code>B</code> "disappeared" from history in
2019the default view. However, there are a few issues with this approach.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:39[diff] [blame]2020<div class="paragraph"><p>The first issue is performance. Unlike any previous option, the
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]2021<code>--simplify-merges</code> option requires walking the entire commit history
2022before returning a single result. This can make the option difficult to
2023use for very large repositories.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:39[diff] [blame]2024<div class="paragraph"><p>The second issue is one of auditing. When many contributors are working
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]2025on the same repository, it is important which merge commits introduced
2026a change into an important branch. The problematic merge <code>R</code> above is
2027not likely to be the merge commit that was used to merge into an
2028important branch. Instead, the merge <code>N</code> was used to merge <code>R</code> and <code>X</code>
2029into the important branch. This commit may have information about why
2030the change <code>X</code> came to override the changes from <code>A</code> and <code>B</code> in its
2031commit message.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:39[diff] [blame]2032<div class="dlist"><dl>
2033<dt class="hdlist1">
2034--show-pulls
2035</dt>
2036<dd>
2037<p>
2038 In addition to the commits shown in the default history, show
2039 each merge commit that is not TREESAME to its first parent but
2040 is TREESAME to a later parent.
2041</p>
2042<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:44[diff] [blame]2043treated as if it "pulled" the change from another branch. When using
2044<code>--show-pulls</code> on this example (and no other options) the resulting
2045graph is:</p></div>
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]2046<div class="listingblock">
2047<div class="content">
2048<pre><code> I---X---R---N</code></pre>
2049</div></div>
Junio C Hamano0cb719f2020-05-31 20:04:39[diff] [blame]2050<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:44[diff] [blame]2051the commits <code>X</code> and <code>R</code> into the base branch, respectively. These
2052merges are the reason the commits <code>A</code> and <code>B</code> do not appear in the
2053default history.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:39[diff] [blame]2054<div class="paragraph"><p>When <code>--show-pulls</code> is paired with <code>--simplify-merges</code>, the
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]2055graph includes all of the necessary information:</p></div>
Junio C Hamano67bf2242020-04-22 21:41:44[diff] [blame]2056<div class="listingblock">
2057<div class="content">
2058<pre><code> .-A---M--. N
2059 / / \ /
2060 I B R
2061 \ / /
2062 \ / /
2063 `---X--'</code></pre>
2064</div></div>
Junio C Hamano0cb719f2020-05-31 20:04:39[diff] [blame]2065<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:44[diff] [blame]2066was simplified away. However, <code>N</code> still appears in the history as an
2067important commit because it "pulled" the change <code>R</code> into the main
2068branch.</p></div>
Junio C Hamano0cb719f2020-05-31 20:04:39[diff] [blame]2069</dd>
2070</dl></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2071<div class="paragraph"><p>The <code>--simplify-by-decoration</code> option allows you to view only the
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]2072big picture of the topology of the history, by omitting commits
2073that are not referenced by tags. Commits are marked as !TREESAME
2074(in other words, kept after history simplification rules described
2075above) if (1) they are referenced by tags, or (2) they change the
2076contents of the paths given on the command line. All other
2077commits are marked as TREESAME (subject to be simplified away).</p></div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]2078</div>
2079<div class="sect2">
2080<h3 id="_commit_ordering">Commit Ordering</h3>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2081<div class="paragraph"><p>By default, the commits are shown in reverse chronological order.</p></div>
2082<div class="dlist"><dl>
2083<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]2084--date-order
2085</dt>
2086<dd>
2087<p>
Junio C Hamanod0316112012-08-22 19:55:29[diff] [blame]2088 Show no parents before all of its children are shown, but
2089 otherwise show commits in the commit timestamp order.
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]2090</p>
2091</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2092<dt class="hdlist1">
Junio C Hamanoa1952302013-07-01 21:31:18[diff] [blame]2093--author-date-order
2094</dt>
2095<dd>
2096<p>
2097 Show no parents before all of its children are shown, but
2098 otherwise show commits in the author timestamp order.
2099</p>
2100</dd>
2101<dt class="hdlist1">
Junio C Hamanod0316112012-08-22 19:55:29[diff] [blame]2102--topo-order
2103</dt>
2104<dd>
2105<p>
2106 Show no parents before all of its children are shown, and
2107 avoid showing commits on multiple lines of history
2108 intermixed.
2109</p>
2110<div class="paragraph"><p>For example, in a commit history like this:</p></div>
2111<div class="listingblock">
2112<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2113<pre><code> ---1----2----4----7
Junio C Hamanod0316112012-08-22 19:55:29[diff] [blame]2114 \ \
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2115 3----5----6----8---</code></pre>
Junio C Hamanod0316112012-08-22 19:55:29[diff] [blame]2116</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2117<div class="paragraph"><p>where the numbers denote the order of commit timestamps, <code>git
2118rev-list</code> and friends with <code>--date-order</code> show the commits in the
Junio C Hamanod0316112012-08-22 19:55:29[diff] [blame]2119timestamp order: 8 7 6 5 4 3 2 1.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2120<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:29[diff] [blame]21213 1); some older commits are shown before newer ones in order to
2122avoid showing the commits from two parallel development track mixed
2123together.</p></div>
2124</dd>
2125<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]2126--reverse
2127</dt>
2128<dd>
2129<p>
Junio C Hamanof3ca7b82016-10-03 22:27:02[diff] [blame]2130 Output the commits chosen to be shown (see Commit Limiting
2131 section above) in reverse order. Cannot be combined with
2132 <code>--walk-reflogs</code>.
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]2133</p>
2134</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2135</dl></div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]2136</div>
2137<div class="sect2">
2138<h3 id="_object_traversal">Object Traversal</h3>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]2139<div class="paragraph"><p>These options are mostly targeted for packing of Git repositories.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2140<div class="dlist"><dl>
2141<dt class="hdlist1">
Junio C Hamanoeccdd4a2012-09-10 23:28:17[diff] [blame]2142--no-walk[=(sorted|unsorted)]
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]2143</dt>
2144<dd>
2145<p>
Junio C Hamanoeccdd4a2012-09-10 23:28:17[diff] [blame]2146 Only show the given commits, but do not traverse their ancestors.
2147 This has no effect if a range is specified. If the argument
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2148 <code>unsorted</code> is given, the commits are shown in the order they were
2149 given on the command line. Otherwise (if <code>sorted</code> or no argument
Junio C Hamanob73af6c2013-12-03 22:07:11[diff] [blame]2150 was given), the commits are shown in reverse chronological order
Junio C Hamanoeccdd4a2012-09-10 23:28:17[diff] [blame]2151 by commit time.
Junio C Hamanoe8fdbbb2021-11-12 23:42:03[diff] [blame]2152 Cannot be combined with <code>--graph</code>.
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]2153</p>
2154</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2155<dt class="hdlist1">
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]2156--do-walk
2157</dt>
2158<dd>
2159<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2160 Overrides a previous <code>--no-walk</code>.
Junio C Hamanob0e02952008-01-19 08:02:00[diff] [blame]2161</p>
2162</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2163</dl></div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]2164</div>
2165<div class="sect2">
2166<h3 id="_commit_formatting">Commit Formatting</h3>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2167<div class="dlist"><dl>
2168<dt class="hdlist1">
2169--pretty[=&lt;format&gt;]
2170</dt>
2171<dt class="hdlist1">
2172--format=&lt;format&gt;
2173</dt>
2174<dd>
2175<p>
2176 Pretty-print the contents of the commit logs in a given format,
2177 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:09[diff] [blame]2178 <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:26[diff] [blame]2179 and <em>tformat:&lt;string&gt;</em>. When <em>&lt;format&gt;</em> is none of the above,
2180 and has <em>%placeholder</em> in it, it acts as if
2181 <em>--pretty=tformat:&lt;format&gt;</em> were given.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2182</p>
Junio C Hamano6bb32e62015-02-17 22:11:26[diff] [blame]2183<div class="paragraph"><p>See the "PRETTY FORMATS" section for some additional details for each
2184format. When <em>=&lt;format&gt;</em> part is omitted, it defaults to <em>medium</em>.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2185<div class="paragraph"><p>Note: you can specify the default pretty format in the repository
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2186configuration (see <a href="git-config.html">git-config(1)</a>).</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2187</dd>
2188<dt class="hdlist1">
2189--abbrev-commit
2190</dt>
2191<dd>
2192<p>
2193 Instead of showing the full 40-byte hexadecimal commit object
Junio C Hamanoee43d182020-11-11 22:10:41[diff] [blame]2194 name, show a prefix that names the object uniquely.
2195 "--abbrev=&lt;n&gt;" (which also modifies diff output, if it is displayed)
2196 option can be used to specify the minimum length of the prefix.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2197</p>
2198<div class="paragraph"><p>This should make "--pretty=oneline" a whole lot more readable for
2199people using 80-column terminals.</p></div>
2200</dd>
2201<dt class="hdlist1">
Junio C Hamanof93530e2011-05-25 23:59:59[diff] [blame]2202--no-abbrev-commit
2203</dt>
2204<dd>
2205<p>
2206 Show the full 40-byte hexadecimal commit object name. This negates
Junio C Hamano558abd22020-09-03 20:22:34[diff] [blame]2207 <code>--abbrev-commit</code>, either explicit or implied by other options such
2208 as "--oneline". It also overrides the <code>log.abbrevCommit</code> variable.
Junio C Hamanof93530e2011-05-25 23:59:59[diff] [blame]2209</p>
2210</dd>
2211<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2212--oneline
2213</dt>
2214<dd>
2215<p>
2216 This is a shorthand for "--pretty=oneline --abbrev-commit"
2217 used together.
2218</p>
2219</dd>
2220<dt class="hdlist1">
Junio C Hamanoc5bb3b32013-08-05 22:43:36[diff] [blame]2221--encoding=&lt;encoding&gt;
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2222</dt>
2223<dd>
2224<p>
Junio C Hamano7d6f46e2021-09-10 19:54:21[diff] [blame]2225 Commit objects record the character encoding used for the log message
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2226 in their encoding header; this option can be used to tell the
2227 command to re-code the commit log message in the encoding
2228 preferred by the user. For non plumbing commands this
Junio C Hamano823eebb2015-07-10 22:29:34[diff] [blame]2229 defaults to UTF-8. Note that if an object claims to be encoded
2230 in <code>X</code> and we are outputting in <code>X</code>, we will output the object
2231 verbatim; this means that invalid sequences in the original
Junio C Hamano7d6f46e2021-09-10 19:54:21[diff] [blame]2232 commit may be copied to the output. Likewise, if iconv(3) fails
Junio C Hamano19dcd3f2021-10-29 23:20:47[diff] [blame]2233 to convert the commit, we will quietly output the original
2234 object verbatim.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2235</p>
2236</dd>
2237<dt class="hdlist1">
Junio C Hamano5996b672016-04-13 22:01:41[diff] [blame]2238--expand-tabs=&lt;n&gt;
2239</dt>
2240<dt class="hdlist1">
2241--expand-tabs
2242</dt>
2243<dt class="hdlist1">
2244--no-expand-tabs
2245</dt>
2246<dd>
2247<p>
2248 Perform a tab expansion (replace each tab with enough spaces
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]2249 to fill to the next display column that is a multiple of <em>&lt;n&gt;</em>)
Junio C Hamano5996b672016-04-13 22:01:41[diff] [blame]2250 in the log message before showing it in the output.
2251 <code>--expand-tabs</code> is a short-hand for <code>--expand-tabs=8</code>, and
2252 <code>--no-expand-tabs</code> is a short-hand for <code>--expand-tabs=0</code>,
2253 which disables tab expansion.
2254</p>
2255<div class="paragraph"><p>By default, tabs are expanded in pretty formats that indent the log
2256message by 4 spaces (i.e. <em>medium</em>, which is the default, <em>full</em>,
2257and <em>fuller</em>).</p></div>
2258</dd>
2259<dt class="hdlist1">
Junio C Hamanob3f862c2019-12-05 22:22:00[diff] [blame]2260--notes[=&lt;ref&gt;]
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2261</dt>
2262<dd>
2263<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2264 Show the notes (see <a href="git-notes.html">git-notes(1)</a>) that annotate the
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2265 commit, when showing the commit log message. This is the default
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2266 for <code>git log</code>, <code>git show</code> and <code>git whatchanged</code> commands when
2267 there is no <code>--pretty</code>, <code>--format</code>, or <code>--oneline</code> option given
Junio C Hamano60033462011-05-03 00:48:43[diff] [blame]2268 on the command line.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2269</p>
Junio C Hamano60033462011-05-03 00:48:43[diff] [blame]2270<div class="paragraph"><p>By default, the notes shown are from the notes refs listed in the
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]2271<code>core.notesRef</code> and <code>notes.displayRef</code> variables (or corresponding
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2272environment overrides). See <a href="git-config.html">git-config(1)</a> for more details.</p></div>
Junio C Hamanob3f862c2019-12-05 22:22:00[diff] [blame]2273<div class="paragraph"><p>With an optional <em>&lt;ref&gt;</em> argument, use the ref to find the notes
2274to display. The ref can specify the full refname when it begins
Junio C Hamano1f7c4a52015-10-14 22:15:51[diff] [blame]2275with <code>refs/notes/</code>; when it begins with <code>notes/</code>, <code>refs/</code> and otherwise
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]2276<code>refs/notes/</code> is prefixed to form the full name of the ref.</p></div>
Junio C Hamano60033462011-05-03 00:48:43[diff] [blame]2277<div class="paragraph"><p>Multiple --notes options can be combined to control which notes are
2278being displayed. Examples: "--notes=foo" will show only notes from
2279"refs/notes/foo"; "--notes=foo --notes" will show both notes from
2280"refs/notes/foo" and from the default notes ref(s).</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2281</dd>
2282<dt class="hdlist1">
Junio C Hamano60033462011-05-03 00:48:43[diff] [blame]2283--no-notes
2284</dt>
2285<dd>
2286<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2287 Do not show notes. This negates the above <code>--notes</code> option, by
Junio C Hamano60033462011-05-03 00:48:43[diff] [blame]2288 resetting the list of notes refs from which notes are shown.
2289 Options are parsed in the order given on the command line, so e.g.
2290 "--notes --notes=foo --no-notes --notes=bar" will only show notes
2291 from "refs/notes/bar".
2292</p>
2293</dd>
2294<dt class="hdlist1">
Junio C Hamano2b1164d2023-09-29 16:43:29[diff] [blame]2295--show-notes-by-default
2296</dt>
2297<dd>
2298<p>
2299 Show the default notes unless options for displaying specific
2300 notes are given.
2301</p>
2302</dd>
2303<dt class="hdlist1">
Junio C Hamanob3f862c2019-12-05 22:22:00[diff] [blame]2304--show-notes[=&lt;ref&gt;]
Junio C Hamano60033462011-05-03 00:48:43[diff] [blame]2305</dt>
2306<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2307--[no-]standard-notes
2308</dt>
2309<dd>
2310<p>
Junio C Hamano60033462011-05-03 00:48:43[diff] [blame]2311 These options are deprecated. Use the above --notes/--no-notes
2312 options instead.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2313</p>
2314</dd>
2315<dt class="hdlist1">
Junio C Hamano0acb1ae2012-09-24 21:28:13[diff] [blame]2316--show-signature
2317</dt>
2318<dd>
2319<p>
2320 Check the validity of a signed commit object by passing the signature
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2321 to <code>gpg --verify</code> and show the output.
Junio C Hamano0acb1ae2012-09-24 21:28:13[diff] [blame]2322</p>
2323</dd>
2324<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2325--relative-date
2326</dt>
2327<dd>
2328<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2329 Synonym for <code>--date=relative</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2330</p>
2331</dd>
2332<dt class="hdlist1">
Junio C Hamano1eb56092015-10-05 20:39:53[diff] [blame]2333--date=&lt;format&gt;
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2334</dt>
2335<dd>
2336<p>
2337 Only takes effect for dates shown in human-readable format, such
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2338 as when using <code>--pretty</code>. <code>log.date</code> config variable sets a default
Junio C Hamano1eb56092015-10-05 20:39:53[diff] [blame]2339 value for the log command&#8217;s <code>--date</code> option. By default, dates
2340 are shown in the original time zone (either committer&#8217;s or
2341 author&#8217;s). If <code>-local</code> is appended to the format (e.g.,
2342 <code>iso-local</code>), the user&#8217;s local time zone is used instead.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2343</p>
Junio C Hamanob5513772019-04-22 03:38:39[diff] [blame]2344<div class="openblock">
2345<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2346<div class="paragraph"><p><code>--date=relative</code> shows dates relative to the current time,
Junio C Hamanoe548d1b2016-08-08 22:26:49[diff] [blame]2347e.g. &#8220;2 hours ago&#8221;. The <code>-local</code> option has no effect for
2348<code>--date=relative</code>.</p></div>
Junio C Hamano1eb56092015-10-05 20:39:53[diff] [blame]2349<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:51[diff] [blame]2350<div class="paragraph"><p><code>--date=iso</code> (or <code>--date=iso8601</code>) shows timestamps in a ISO 8601-like format.
2351The differences to the strict ISO 8601 format are:</p></div>
2352<div class="ulist"><ul>
2353<li>
2354<p>
2355a space instead of the <code>T</code> date/time delimiter
2356</p>
2357</li>
2358<li>
2359<p>
2360a space between time and time zone
2361</p>
2362</li>
2363<li>
2364<p>
2365no colon between hours and minutes of the time zone
2366</p>
2367</li>
2368</ul></div>
2369<div class="paragraph"><p><code>--date=iso-strict</code> (or <code>--date=iso8601-strict</code>) shows timestamps in strict
2370ISO 8601 format.</p></div>
2371<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:11[diff] [blame]2372format, often found in email messages.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2373<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:49[diff] [blame]2374<div class="paragraph"><p><code>--date=raw</code> shows the date as seconds since the epoch (1970-01-01
237500:00:00 UTC), followed by a space, and then the timezone as an offset
2376from UTC (a <code>+</code> or <code>-</code> with four digits; the first two are hours, and
2377the second two are minutes). I.e., as if the timestamp were formatted
2378with <code>strftime("%s %z")</code>).
2379Note that the <code>-local</code> option does not affect the seconds-since-epoch
2380value (which is always measured in UTC), but does switch the accompanying
2381timezone value.</p></div>
Junio C Hamano23168ef2019-02-07 07:20:47[diff] [blame]2382<div class="paragraph"><p><code>--date=human</code> shows the timezone if the timezone does not match the
2383current time-zone, and doesn&#8217;t print the whole date if that matches
2384(ie skip printing year for dates that are "this year", but also skip
2385the whole date itself if it&#8217;s in the last few days and we can just say
2386what weekday it was). For older dates the hour and minute is also
2387omitted.</p></div>
Junio C Hamanoe548d1b2016-08-08 22:26:49[diff] [blame]2388<div class="paragraph"><p><code>--date=unix</code> shows the date as a Unix epoch timestamp (seconds since
23891970). As with <code>--raw</code>, this is always in UTC and therefore <code>-local</code>
2390has no effect.</p></div>
Junio C Hamano55d91912017-06-22 22:32:46[diff] [blame]2391<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:38[diff] [blame]2392except for %s, %z, and %Z, which are handled internally.
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]2393Use <code>--date=format:%c</code> to show the date in your system locale&#8217;s
2394preferred format. See the <code>strftime</code> manual for a complete list of
Junio C Hamano1eb56092015-10-05 20:39:53[diff] [blame]2395format placeholders. When using <code>-local</code>, the correct syntax is
2396<code>--date=format-local:...</code>.</p></div>
Junio C Hamano613334c2023-02-24 19:54:38[diff] [blame]2397<div class="paragraph"><p><code>--date=default</code> is the default format, and is based on ctime(3)
2398output. It shows a single line with three-letter day of the week,
2399three-letter month, day-of-month, hour-minute-seconds in "HH:MM:SS"
2400format, followed by 4-digit year, plus timezone information, unless
2401the local time zone is used, e.g. <code>Thu Jan 1 00:00:00 1970 +0000</code>.</p></div>
Junio C Hamanob5513772019-04-22 03:38:39[diff] [blame]2402</div></div>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2403</dd>
2404<dt class="hdlist1">
2405--parents
2406</dt>
2407<dd>
2408<p>
2409 Print also the parents of the commit (in the form "commit parent&#8230;").
Junio C Hamanoce019c02017-10-30 05:57:46[diff] [blame]2410 Also enables parent rewriting, see <em>History Simplification</em> above.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2411</p>
2412</dd>
2413<dt class="hdlist1">
2414--children
2415</dt>
2416<dd>
2417<p>
2418 Print also the children of the commit (in the form "commit child&#8230;").
Junio C Hamanoce019c02017-10-30 05:57:46[diff] [blame]2419 Also enables parent rewriting, see <em>History Simplification</em> above.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2420</p>
2421</dd>
2422<dt class="hdlist1">
2423--left-right
2424</dt>
2425<dd>
2426<p>
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]2427 Mark which side of a symmetric difference a commit is reachable from.
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2428 Commits from the left side are prefixed with <code>&lt;</code> and those from
2429 the right with <code>&gt;</code>. If combined with <code>--boundary</code>, those
2430 commits are prefixed with <code>-</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2431</p>
2432<div class="paragraph"><p>For example, if you have this topology:</p></div>
2433<div class="listingblock">
2434<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2435<pre><code> y---b---b branch B
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2436 / \ /
2437 / .
2438 / / \
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2439 o---x---a---a branch A</code></pre>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2440</div></div>
2441<div class="paragraph"><p>you would get an output like this:</p></div>
2442<div class="listingblock">
2443<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2444<pre><code> $ git rev-list --left-right --boundary --pretty=oneline A...B
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2445
2446 &gt;bbbbbbb... 3rd on b
2447 &gt;bbbbbbb... 2nd on b
2448 &lt;aaaaaaa... 3rd on a
2449 &lt;aaaaaaa... 2nd on a
2450 -yyyyyyy... 1st on b
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2451 -xxxxxxx... 1st on a</code></pre>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2452</div></div>
2453</dd>
2454<dt class="hdlist1">
2455--graph
2456</dt>
2457<dd>
2458<p>
2459 Draw a text-based graphical representation of the commit history
2460 on the left hand side of the output. This may cause extra lines
2461 to be printed in between commits, in order for the graph history
2462 to be drawn properly.
Junio C Hamanoef57d1e2015-03-25 21:23:00[diff] [blame]2463 Cannot be combined with <code>--no-walk</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2464</p>
Junio C Hamanoce019c02017-10-30 05:57:46[diff] [blame]2465<div class="paragraph"><p>This enables parent rewriting, see <em>History Simplification</em> above.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2466<div class="paragraph"><p>This implies the <code>--topo-order</code> option by default, but the
2467<code>--date-order</code> option may also be specified.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2468</dd>
Junio C Hamano624dd4c2014-04-03 21:56:30[diff] [blame]2469<dt class="hdlist1">
2470--show-linear-break[=&lt;barrier&gt;]
2471</dt>
2472<dd>
2473<p>
2474 When --graph is not used, all history branches are flattened
2475 which can make it hard to see that the two consecutive commits
2476 do not belong to a linear branch. This option puts a barrier
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2477 in between them in that case. If <code>&lt;barrier&gt;</code> is specified, it
Junio C Hamano624dd4c2014-04-03 21:56:30[diff] [blame]2478 is the string that will be shown instead of the default one.
2479</p>
2480</dd>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]2481</dl></div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]2482</div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]2483</div>
2484</div>
2485<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2486<h2 id="_pretty_formats">PRETTY FORMATS</h2>
Junio C Hamano0430e3a2007-05-15 03:13:17[diff] [blame]2487<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2488<div class="paragraph"><p>If the commit is a merge, and if the pretty-format
Junio C Hamano0430e3a2007-05-15 03:13:17[diff] [blame]2489is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is
2490inserted before the <em>Author:</em> line. This line begins with
Junio C Hamanob4896852019-12-10 23:15:09[diff] [blame]2491"Merge: " and the hashes of ancestral commits are printed,
Junio C Hamano0430e3a2007-05-15 03:13:17[diff] [blame]2492separated by spaces. Note that the listed commits may not
2493necessarily be the list of the <strong>direct</strong> parent commits if you
2494have limited your view of history: for example, if you are
2495only interested in changes related to a certain directory or
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2496file.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2497<div class="paragraph"><p>There are several built-in formats, and you can define
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]2498additional formats by setting a pretty.&lt;name&gt;
2499config option to either another format name, or a
2500<em>format:</em> string, as described below (see
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2501<a href="git-config.html">git-config(1)</a>). Here are the details of the
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]2502built-in formats:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2503<div class="ulist"><ul>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2504<li>
2505<p>
2506<em>oneline</em>
2507</p>
2508<div class="literalblock">
2509<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2510<pre><code>&lt;hash&gt; &lt;title-line&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2511</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2512<div class="paragraph"><p>This is designed to be as compact as possible.</p></div>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2513</li>
2514<li>
2515<p>
2516<em>short</em>
2517</p>
2518<div class="literalblock">
2519<div class="content">
Junio C Hamanob4896852019-12-10 23:15:09[diff] [blame]2520<pre><code>commit &lt;hash&gt;
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2521Author: &lt;author&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2522</div></div>
2523<div class="literalblock">
2524<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2525<pre><code>&lt;title-line&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2526</div></div>
2527</li>
2528<li>
2529<p>
2530<em>medium</em>
2531</p>
2532<div class="literalblock">
2533<div class="content">
Junio C Hamanob4896852019-12-10 23:15:09[diff] [blame]2534<pre><code>commit &lt;hash&gt;
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2535Author: &lt;author&gt;
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2536Date: &lt;author-date&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2537</div></div>
2538<div class="literalblock">
2539<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2540<pre><code>&lt;title-line&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2541</div></div>
2542<div class="literalblock">
2543<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2544<pre><code>&lt;full-commit-message&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2545</div></div>
2546</li>
2547<li>
2548<p>
2549<em>full</em>
2550</p>
2551<div class="literalblock">
2552<div class="content">
Junio C Hamanob4896852019-12-10 23:15:09[diff] [blame]2553<pre><code>commit &lt;hash&gt;
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2554Author: &lt;author&gt;
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2555Commit: &lt;committer&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2556</div></div>
2557<div class="literalblock">
2558<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2559<pre><code>&lt;title-line&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2560</div></div>
2561<div class="literalblock">
2562<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2563<pre><code>&lt;full-commit-message&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2564</div></div>
2565</li>
2566<li>
2567<p>
2568<em>fuller</em>
2569</p>
2570<div class="literalblock">
2571<div class="content">
Junio C Hamanob4896852019-12-10 23:15:09[diff] [blame]2572<pre><code>commit &lt;hash&gt;
Junio C Hamano6a3c8272008-12-19 21:38:18[diff] [blame]2573Author: &lt;author&gt;
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2574AuthorDate: &lt;author-date&gt;
Junio C Hamano6a3c8272008-12-19 21:38:18[diff] [blame]2575Commit: &lt;committer&gt;
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2576CommitDate: &lt;committer-date&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2577</div></div>
2578<div class="literalblock">
2579<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2580<pre><code>&lt;title-line&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2581</div></div>
2582<div class="literalblock">
2583<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2584<pre><code>&lt;full-commit-message&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2585</div></div>
2586</li>
2587<li>
2588<p>
Junio C Hamanob4896852019-12-10 23:15:09[diff] [blame]2589<em>reference</em>
2590</p>
2591<div class="literalblock">
2592<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2593<pre><code>&lt;abbrev-hash&gt; (&lt;title-line&gt;, &lt;short-author-date&gt;)</code></pre>
Junio C Hamanob4896852019-12-10 23:15:09[diff] [blame]2594</div></div>
2595<div class="paragraph"><p>This format is used to refer to another commit in a commit message and
2596is the same as <code>--pretty='format:%C(auto)%h (%s, %ad)'</code>. By default,
2597the date is formatted with <code>--date=short</code> unless another <code>--date</code> option
2598is explicitly specified. As with any <code>format:</code> with format
2599placeholders, its output is not affected by other options like
2600<code>--decorate</code> and <code>--walk-reflogs</code>.</p></div>
2601</li>
2602<li>
2603<p>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2604<em>email</em>
2605</p>
2606<div class="literalblock">
2607<div class="content">
Junio C Hamanob4896852019-12-10 23:15:09[diff] [blame]2608<pre><code>From &lt;hash&gt; &lt;date&gt;
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2609From: &lt;author&gt;
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2610Date: &lt;author-date&gt;
2611Subject: [PATCH] &lt;title-line&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2612</div></div>
2613<div class="literalblock">
2614<div class="content">
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2615<pre><code>&lt;full-commit-message&gt;</code></pre>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2616</div></div>
2617</li>
2618<li>
2619<p>
Junio C Hamano0dd50942020-04-29 21:21:05[diff] [blame]2620<em>mboxrd</em>
2621</p>
2622<div class="paragraph"><p>Like <em>email</em>, but lines in the commit message starting with "From "
2623(preceded by zero or more "&gt;") are quoted with "&gt;" so they aren&#8217;t
2624confused as starting a new commit.</p></div>
2625</li>
2626<li>
2627<p>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2628<em>raw</em>
2629</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2630<div class="paragraph"><p>The <em>raw</em> format shows the entire commit exactly as
Junio C Hamanob4896852019-12-10 23:15:09[diff] [blame]2631stored in the commit object. Notably, the hashes are
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2632displayed in full, regardless of whether --abbrev or
2633--no-abbrev are used, and <em>parents</em> information show the
Junio C Hamanod75148a2014-04-08 19:48:38[diff] [blame]2634true parent commits, without taking grafts or history
Junio C Hamano85f1fde2015-06-01 20:37:32[diff] [blame]2635simplification into account. Note that this format affects the way
2636commits are displayed, but not the way the diff is shown e.g. with
2637<code>git log --raw</code>. To get full object names in a raw diff format,
2638use <code>--no-abbrev</code>.</p></div>
Junio C Hamanoa340aaa2006-11-23 02:47:33[diff] [blame]2639</li>
Junio C Hamanoa3fd83c2007-03-02 10:34:36[diff] [blame]2640<li>
2641<p>
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2642<em>format:&lt;format-string&gt;</em>
Junio C Hamanoa3fd83c2007-03-02 10:34:36[diff] [blame]2643</p>
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]2644<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:36[diff] [blame]2645you want to show. It works a little bit like printf format,
2646with the notable exception that you get a newline with <em>%n</em>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2647instead of <em>\n</em>.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2648<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:31[diff] [blame]2649would show something like this:</p></div>
Junio C Hamano0430e3a2007-05-15 03:13:17[diff] [blame]2650<div class="listingblock">
2651<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]2652<pre><code>The author of fe6e0ee was Junio C Hamano, 23 hours ago
2653The 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:17[diff] [blame]2654</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2655<div class="paragraph"><p>The placeholders are:</p></div>
2656<div class="ulist"><ul>
Junio C Hamanoa3fd83c2007-03-02 10:34:36[diff] [blame]2657<li>
2658<p>
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2659Placeholders that expand to a single literal character:
2660</p>
2661<div class="dlist"><dl>
2662<dt class="hdlist1">
2663<em>%n</em>
2664</dt>
2665<dd>
2666<p>
2667newline
2668</p>
2669</dd>
2670<dt class="hdlist1">
2671<em>%%</em>
2672</dt>
2673<dd>
2674<p>
2675a raw <em>%</em>
2676</p>
2677</dd>
2678<dt class="hdlist1">
2679<em>%x00</em>
2680</dt>
2681<dd>
2682<p>
Junio C Hamano73a9b3e2023-09-14 18:21:28[diff] [blame]2683<em>%x</em> followed by two hexadecimal digits is replaced with a
2684 byte with the hexadecimal digits' value (we will call this
2685 "literal formatting code" in the rest of this document).
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2686</p>
2687</dd>
2688</dl></div>
2689</li>
2690<li>
2691<p>
2692Placeholders that affect formatting of later placeholders:
2693</p>
2694<div class="dlist"><dl>
2695<dt class="hdlist1">
2696<em>%Cred</em>
2697</dt>
2698<dd>
2699<p>
2700switch color to red
2701</p>
2702</dd>
2703<dt class="hdlist1">
2704<em>%Cgreen</em>
2705</dt>
2706<dd>
2707<p>
2708switch color to green
2709</p>
2710</dd>
2711<dt class="hdlist1">
2712<em>%Cblue</em>
2713</dt>
2714<dd>
2715<p>
2716switch color to blue
2717</p>
2718</dd>
2719<dt class="hdlist1">
2720<em>%Creset</em>
2721</dt>
2722<dd>
2723<p>
2724reset color
2725</p>
2726</dd>
2727<dt class="hdlist1">
2728<em>%C(&#8230;)</em>
2729</dt>
2730<dd>
2731<p>
2732color specification, as described under Values in the
2733 "CONFIGURATION FILE" section of <a href="git-config.html">git-config(1)</a>. By
2734 default, colors are shown only when enabled for log output
2735 (by <code>color.diff</code>, <code>color.ui</code>, or <code>--color</code>, and respecting
2736 the <code>auto</code> settings of the former if we are going to a
2737 terminal). <code>%C(auto,...)</code> is accepted as a historical
2738 synonym for the default (e.g., <code>%C(auto,red)</code>). Specifying
2739 <code>%C(always,...)</code> will show the colors even when color is
2740 not otherwise enabled (though consider just using
2741 <code>--color=always</code> to enable color for the whole output,
2742 including this format and anything else git might color).
2743 <code>auto</code> alone (i.e. <code>%C(auto)</code>) will turn on auto coloring
2744 on the next placeholders until the color is switched
2745 again.
2746</p>
2747</dd>
2748<dt class="hdlist1">
2749<em>%m</em>
2750</dt>
2751<dd>
2752<p>
2753left (<code>&lt;</code>), right (<code>&gt;</code>) or boundary (<code>-</code>) mark
2754</p>
2755</dd>
2756<dt class="hdlist1">
2757<em>%w([&lt;w&gt;[,&lt;i1&gt;[,&lt;i2&gt;]]])</em>
2758</dt>
2759<dd>
2760<p>
2761switch line wrapping, like the -w option of
2762 <a href="git-shortlog.html">git-shortlog(1)</a>.
2763</p>
2764</dd>
2765<dt class="hdlist1">
Junio C Hamano11f1df12023-01-30 22:48:08[diff] [blame]2766<em>%&lt;( &lt;N&gt; [,trunc|ltrunc|mtrunc])</em>
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2767</dt>
2768<dd>
2769<p>
2770make the next placeholder take at
Junio C Hamano11f1df12023-01-30 22:48:08[diff] [blame]2771 least N column widths, padding spaces on
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2772 the right if necessary. Optionally
Junio C Hamano11f1df12023-01-30 22:48:08[diff] [blame]2773 truncate (with ellipsis <em>..</em>) at the left (ltrunc) <code>..ft</code>,
2774 the middle (mtrunc) <code>mi..le</code>, or the end
2775 (trunc) <code>rig..</code>, if the output is longer than
2776 N columns.
2777 Note 1: that truncating
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2778 only works correctly with N &gt;= 2.
Junio C Hamano11f1df12023-01-30 22:48:08[diff] [blame]2779 Note 2: spaces around the N and M (see below)
2780 values are optional.
2781 Note 3: Emojis and other wide characters
2782 will take two display columns, which may
2783 over-run column boundaries.
2784 Note 4: decomposed character combining marks
2785 may be misplaced at padding boundaries.
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2786</p>
2787</dd>
2788<dt class="hdlist1">
Junio C Hamano11f1df12023-01-30 22:48:08[diff] [blame]2789<em>%&lt;|( &lt;M&gt; )</em>
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2790</dt>
2791<dd>
2792<p>
Junio C Hamano11f1df12023-01-30 22:48:08[diff] [blame]2793make the next placeholder take at least until Mth
2794 display column, padding spaces on the right if necessary.
2795 Use negative M values for column positions measured
2796 from the right hand edge of the terminal window.
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2797</p>
2798</dd>
2799<dt class="hdlist1">
Junio C Hamano11f1df12023-01-30 22:48:08[diff] [blame]2800<em>%&gt;( &lt;N&gt; )</em>, <em>%&gt;|( &lt;M&gt; )</em>
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2801</dt>
2802<dd>
2803<p>
Junio C Hamano11f1df12023-01-30 22:48:08[diff] [blame]2804similar to <em>%&lt;( &lt;N&gt; )</em>, <em>%&lt;|( &lt;M&gt; )</em> respectively,
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2805 but padding spaces on the left
2806</p>
2807</dd>
2808<dt class="hdlist1">
Junio C Hamano11f1df12023-01-30 22:48:08[diff] [blame]2809<em>%&gt;&gt;( &lt;N&gt; )</em>, <em>%&gt;&gt;|( &lt;M&gt; )</em>
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2810</dt>
2811<dd>
2812<p>
Junio C Hamano11f1df12023-01-30 22:48:08[diff] [blame]2813similar to <em>%&gt;( &lt;N&gt; )</em>, <em>%&gt;|( &lt;M&gt; )</em>
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2814 respectively, except that if the next
2815 placeholder takes more spaces than given and
2816 there are spaces on its left, use those
2817 spaces
2818</p>
2819</dd>
2820<dt class="hdlist1">
Junio C Hamano11f1df12023-01-30 22:48:08[diff] [blame]2821<em>%&gt;&lt;( &lt;N&gt; )</em>, <em>%&gt;&lt;|( &lt;M&gt; )</em>
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2822</dt>
2823<dd>
2824<p>
Junio C Hamano11f1df12023-01-30 22:48:08[diff] [blame]2825similar to <em>%&lt;( &lt;N&gt; )</em>, <em>%&lt;|( &lt;M&gt; )</em>
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2826 respectively, but padding both sides
2827 (i.e. the text is centered)
2828</p>
2829</dd>
2830</dl></div>
2831</li>
2832<li>
2833<p>
2834Placeholders that expand to information extracted from the commit:
2835</p>
2836<div class="dlist"><dl>
2837<dt class="hdlist1">
2838<em>%H</em>
2839</dt>
2840<dd>
2841<p>
2842commit hash
2843</p>
2844</dd>
2845<dt class="hdlist1">
2846<em>%h</em>
2847</dt>
2848<dd>
2849<p>
2850abbreviated commit hash
2851</p>
2852</dd>
2853<dt class="hdlist1">
2854<em>%T</em>
2855</dt>
2856<dd>
2857<p>
2858tree hash
2859</p>
2860</dd>
2861<dt class="hdlist1">
2862<em>%t</em>
2863</dt>
2864<dd>
2865<p>
2866abbreviated tree hash
2867</p>
2868</dd>
2869<dt class="hdlist1">
2870<em>%P</em>
2871</dt>
2872<dd>
2873<p>
2874parent hashes
2875</p>
2876</dd>
2877<dt class="hdlist1">
2878<em>%p</em>
2879</dt>
2880<dd>
2881<p>
2882abbreviated parent hashes
2883</p>
2884</dd>
2885<dt class="hdlist1">
2886<em>%an</em>
2887</dt>
2888<dd>
2889<p>
2890author name
2891</p>
2892</dd>
2893<dt class="hdlist1">
2894<em>%aN</em>
2895</dt>
2896<dd>
2897<p>
2898author name (respecting .mailmap, see <a href="git-shortlog.html">git-shortlog(1)</a>
2899 or <a href="git-blame.html">git-blame(1)</a>)
2900</p>
2901</dd>
2902<dt class="hdlist1">
2903<em>%ae</em>
2904</dt>
2905<dd>
2906<p>
2907author email
2908</p>
2909</dd>
2910<dt class="hdlist1">
2911<em>%aE</em>
2912</dt>
2913<dd>
2914<p>
2915author email (respecting .mailmap, see <a href="git-shortlog.html">git-shortlog(1)</a>
2916 or <a href="git-blame.html">git-blame(1)</a>)
2917</p>
2918</dd>
2919<dt class="hdlist1">
Junio C Hamano8ac8a3d2019-11-11 04:33:46[diff] [blame]2920<em>%al</em>
2921</dt>
2922<dd>
2923<p>
2924author email local-part (the part before the <em>@</em> sign)
2925</p>
2926</dd>
2927<dt class="hdlist1">
2928<em>%aL</em>
2929</dt>
2930<dd>
2931<p>
2932author local-part (see <em>%al</em>) respecting .mailmap, see
2933 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
2934</p>
2935</dd>
2936<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]2937<em>%ad</em>
2938</dt>
2939<dd>
2940<p>
2941author date (format respects --date= option)
2942</p>
2943</dd>
2944<dt class="hdlist1">
2945<em>%aD</em>
2946</dt>
2947<dd>
2948<p>
2949author date, RFC2822 style
2950</p>
2951</dd>
2952<dt class="hdlist1">
2953<em>%ar</em>
2954</dt>
2955<dd>
2956<p>
2957author date, relative
2958</p>
2959</dd>
2960<dt class="hdlist1">
2961<em>%at</em>
2962</dt>
2963<dd>
2964<p>
2965author date, UNIX timestamp
2966</p>
2967</dd>
2968<dt class="hdlist1">
2969<em>%ai</em>
2970</dt>
2971<dd>
2972<p>
2973author date, ISO 8601-like format
2974</p>
2975</dd>
2976<dt class="hdlist1">
2977<em>%aI</em>
2978</dt>
2979<dd>
2980<p>
2981author date, strict ISO 8601 format
2982</p>
2983</dd>
2984<dt class="hdlist1">
Junio C Hamanob4896852019-12-10 23:15:09[diff] [blame]2985<em>%as</em>
2986</dt>
2987<dd>
2988<p>
2989author date, short format (<code>YYYY-MM-DD</code>)
2990</p>
2991</dd>
2992<dt class="hdlist1">
Junio C Hamanobe601db2021-05-07 04:20:28[diff] [blame]2993<em>%ah</em>
2994</dt>
2995<dd>
2996<p>
2997author date, human style (like the <code>--date=human</code> option of
2998 <a href="git-rev-list.html">git-rev-list(1)</a>)
2999</p>
3000</dd>
3001<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3002<em>%cn</em>
3003</dt>
3004<dd>
3005<p>
3006committer name
3007</p>
3008</dd>
3009<dt class="hdlist1">
3010<em>%cN</em>
3011</dt>
3012<dd>
3013<p>
3014committer name (respecting .mailmap, see
3015 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3016</p>
3017</dd>
3018<dt class="hdlist1">
3019<em>%ce</em>
3020</dt>
3021<dd>
3022<p>
3023committer email
3024</p>
3025</dd>
3026<dt class="hdlist1">
3027<em>%cE</em>
3028</dt>
3029<dd>
3030<p>
3031committer email (respecting .mailmap, see
3032 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3033</p>
3034</dd>
3035<dt class="hdlist1">
Junio C Hamano8ac8a3d2019-11-11 04:33:46[diff] [blame]3036<em>%cl</em>
3037</dt>
3038<dd>
3039<p>
Junio C Hamanoa8911782020-07-07 05:35:57[diff] [blame]3040committer email local-part (the part before the <em>@</em> sign)
Junio C Hamano8ac8a3d2019-11-11 04:33:46[diff] [blame]3041</p>
3042</dd>
3043<dt class="hdlist1">
3044<em>%cL</em>
3045</dt>
3046<dd>
3047<p>
Junio C Hamanoa8911782020-07-07 05:35:57[diff] [blame]3048committer local-part (see <em>%cl</em>) respecting .mailmap, see
Junio C Hamano8ac8a3d2019-11-11 04:33:46[diff] [blame]3049 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3050</p>
3051</dd>
3052<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3053<em>%cd</em>
3054</dt>
3055<dd>
3056<p>
3057committer date (format respects --date= option)
3058</p>
3059</dd>
3060<dt class="hdlist1">
3061<em>%cD</em>
3062</dt>
3063<dd>
3064<p>
3065committer date, RFC2822 style
3066</p>
3067</dd>
3068<dt class="hdlist1">
3069<em>%cr</em>
3070</dt>
3071<dd>
3072<p>
3073committer date, relative
3074</p>
3075</dd>
3076<dt class="hdlist1">
3077<em>%ct</em>
3078</dt>
3079<dd>
3080<p>
3081committer date, UNIX timestamp
3082</p>
3083</dd>
3084<dt class="hdlist1">
3085<em>%ci</em>
3086</dt>
3087<dd>
3088<p>
3089committer date, ISO 8601-like format
3090</p>
3091</dd>
3092<dt class="hdlist1">
3093<em>%cI</em>
3094</dt>
3095<dd>
3096<p>
3097committer date, strict ISO 8601 format
3098</p>
3099</dd>
3100<dt class="hdlist1">
Junio C Hamanob4896852019-12-10 23:15:09[diff] [blame]3101<em>%cs</em>
3102</dt>
3103<dd>
3104<p>
3105committer date, short format (<code>YYYY-MM-DD</code>)
3106</p>
3107</dd>
3108<dt class="hdlist1">
Junio C Hamanobe601db2021-05-07 04:20:28[diff] [blame]3109<em>%ch</em>
3110</dt>
3111<dd>
3112<p>
Junio C Hamano608b11d2021-05-16 21:40:45[diff] [blame]3113committer date, human style (like the <code>--date=human</code> option of
Junio C Hamanobe601db2021-05-07 04:20:28[diff] [blame]3114 <a href="git-rev-list.html">git-rev-list(1)</a>)
3115</p>
3116</dd>
3117<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3118<em>%d</em>
3119</dt>
3120<dd>
3121<p>
3122ref names, like the --decorate option of <a href="git-log.html">git-log(1)</a>
3123</p>
3124</dd>
3125<dt class="hdlist1">
3126<em>%D</em>
3127</dt>
3128<dd>
3129<p>
3130ref names without the " (", ")" wrapping.
3131</p>
3132</dd>
3133<dt class="hdlist1">
Junio C Hamano73a9b3e2023-09-14 18:21:28[diff] [blame]3134<em>%(decorate[:&lt;options&gt;])</em>
Junio C Hamano458281a2021-03-22 21:20:26[diff] [blame]3135</dt>
3136<dd>
3137<p>
Junio C Hamano73a9b3e2023-09-14 18:21:28[diff] [blame]3138ref names with custom decorations. The <code>decorate</code> string may be followed by a
3139colon and zero or more comma-separated options. Option values may contain
3140literal formatting codes. These must be used for commas (<code>%x2C</code>) and closing
3141parentheses (<code>%x29</code>), due to their role in the option syntax.
3142</p>
3143<div class="ulist"><ul>
3144<li>
3145<p>
3146<em>prefix=&lt;value&gt;</em>: Shown before the list of ref names. Defaults to "&#160;<code>(</code>".
3147</p>
3148</li>
3149<li>
3150<p>
3151<em>suffix=&lt;value&gt;</em>: Shown after the list of ref names. Defaults to "<code>)</code>".
3152</p>
3153</li>
3154<li>
3155<p>
3156<em>separator=&lt;value&gt;</em>: Shown between ref names. Defaults to "<code>,</code>&#160;".
3157</p>
3158</li>
3159<li>
3160<p>
3161<em>pointer=&lt;value&gt;</em>: Shown between HEAD and the branch it points to, if any.
3162 Defaults to "&#160;<code>-&gt;</code>&#160;".
3163</p>
3164</li>
3165<li>
3166<p>
3167<em>tag=&lt;value&gt;</em>: Shown before tag names. Defaults to "<code>tag:</code>&#160;".
3168</p>
3169</li>
3170</ul></div>
3171<div class="paragraph"><p>For example, to produce decorations with no wrapping
3172or tag annotations, and spaces as separators:</p></div>
3173<div class="paragraph"><p><code>%(decorate:prefix=,suffix=,tag=,separator= )</code></p></div>
3174</dd>
3175<dt class="hdlist1">
3176<em>%(describe[:&lt;options&gt;])</em>
3177</dt>
3178<dd>
3179<p>
3180human-readable name, like <a href="git-describe.html">git-describe(1)</a>; empty string for
3181undescribable commits. The <code>describe</code> string may be followed by a colon and
3182zero or more comma-separated options. Descriptions can be inconsistent when
3183tags are added or removed at the same time.
Junio C Hamano458281a2021-03-22 21:20:26[diff] [blame]3184</p>
3185<div class="ulist"><ul>
3186<li>
3187<p>
Junio C Hamano2b153182021-12-15 21:00:31[diff] [blame]3188<em>tags[=&lt;bool-value&gt;]</em>: Instead of only considering annotated tags,
3189 consider lightweight tags as well.
3190</p>
3191</li>
3192<li>
3193<p>
3194<em>abbrev=&lt;number&gt;</em>: Instead of using the default number of hexadecimal digits
3195 (which will vary according to the number of objects in the repository with a
3196 default of 7) of the abbreviated object name, use &lt;number&gt; digits, or as many
3197 digits as needed to form a unique object name.
3198</p>
3199</li>
3200<li>
3201<p>
Junio C Hamano458281a2021-03-22 21:20:26[diff] [blame]3202<em>match=&lt;pattern&gt;</em>: Only consider tags matching the given
3203 <code>glob(7)</code> pattern, excluding the "refs/tags/" prefix.
3204</p>
3205</li>
3206<li>
3207<p>
3208<em>exclude=&lt;pattern&gt;</em>: Do not consider tags matching the given
3209 <code>glob(7)</code> pattern, excluding the "refs/tags/" prefix.
3210</p>
3211</li>
3212</ul></div>
3213</dd>
3214<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3215<em>%S</em>
3216</dt>
3217<dd>
3218<p>
3219ref name given on the command line by which the commit was reached
3220 (like <code>git log --source</code>), only works with <code>git log</code>
3221</p>
3222</dd>
3223<dt class="hdlist1">
3224<em>%e</em>
3225</dt>
3226<dd>
3227<p>
3228encoding
3229</p>
3230</dd>
3231<dt class="hdlist1">
3232<em>%s</em>
3233</dt>
3234<dd>
3235<p>
3236subject
3237</p>
3238</dd>
3239<dt class="hdlist1">
3240<em>%f</em>
3241</dt>
3242<dd>
3243<p>
3244sanitized subject line, suitable for a filename
3245</p>
3246</dd>
3247<dt class="hdlist1">
3248<em>%b</em>
3249</dt>
3250<dd>
3251<p>
3252body
3253</p>
3254</dd>
3255<dt class="hdlist1">
3256<em>%B</em>
3257</dt>
3258<dd>
3259<p>
3260raw body (unwrapped subject and body)
3261</p>
3262</dd>
3263<dt class="hdlist1">
3264<em>%N</em>
3265</dt>
3266<dd>
3267<p>
3268commit notes
3269</p>
3270</dd>
3271<dt class="hdlist1">
3272<em>%GG</em>
3273</dt>
3274<dd>
3275<p>
3276raw verification message from GPG for a signed commit
3277</p>
3278</dd>
3279<dt class="hdlist1">
3280<em>%G?</em>
3281</dt>
3282<dd>
3283<p>
3284show "G" for a good (valid) signature,
3285 "B" for a bad signature,
3286 "U" for a good signature with unknown validity,
3287 "X" for a good signature that has expired,
3288 "Y" for a good signature made by an expired key,
3289 "R" for a good signature made by a revoked key,
3290 "E" if the signature cannot be checked (e.g. missing key)
3291 and "N" for no signature
3292</p>
3293</dd>
3294<dt class="hdlist1">
3295<em>%GS</em>
3296</dt>
3297<dd>
3298<p>
3299show the name of the signer for a signed commit
3300</p>
3301</dd>
3302<dt class="hdlist1">
3303<em>%GK</em>
3304</dt>
3305<dd>
3306<p>
3307show the key used to sign a signed commit
3308</p>
3309</dd>
3310<dt class="hdlist1">
3311<em>%GF</em>
3312</dt>
3313<dd>
3314<p>
3315show the fingerprint of the key used to sign a signed commit
3316</p>
3317</dd>
3318<dt class="hdlist1">
3319<em>%GP</em>
3320</dt>
3321<dd>
3322<p>
3323show the fingerprint of the primary key whose subkey was used
3324 to sign a signed commit
3325</p>
3326</dd>
3327<dt class="hdlist1">
Junio C Hamanobee061d2020-01-30 23:21:18[diff] [blame]3328<em>%GT</em>
3329</dt>
3330<dd>
3331<p>
3332show the trust level for the key used to sign a signed commit
3333</p>
3334</dd>
3335<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3336<em>%gD</em>
3337</dt>
3338<dd>
3339<p>
3340reflog selector, e.g., <code>refs/stash@{1}</code> or <code>refs/stash@{2
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]3341 minutes ago}</code>; the format follows the rules described for the
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3342 <code>-g</code> option. The portion before the <code>@</code> is the refname as
3343 given on the command line (so <code>git log -g refs/heads/master</code>
3344 would yield <code>refs/heads/master@{0}</code>).
3345</p>
3346</dd>
3347<dt class="hdlist1">
3348<em>%gd</em>
3349</dt>
3350<dd>
3351<p>
3352shortened reflog selector; same as <code>%gD</code>, but the refname
3353 portion is shortened for human readability (so
3354 <code>refs/heads/master</code> becomes just <code>master</code>).
3355</p>
3356</dd>
3357<dt class="hdlist1">
3358<em>%gn</em>
3359</dt>
3360<dd>
3361<p>
3362reflog identity name
3363</p>
3364</dd>
3365<dt class="hdlist1">
3366<em>%gN</em>
3367</dt>
3368<dd>
3369<p>
3370reflog identity name (respecting .mailmap, see
3371 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3372</p>
3373</dd>
3374<dt class="hdlist1">
3375<em>%ge</em>
3376</dt>
3377<dd>
3378<p>
3379reflog identity email
3380</p>
3381</dd>
3382<dt class="hdlist1">
3383<em>%gE</em>
3384</dt>
3385<dd>
3386<p>
3387reflog identity email (respecting .mailmap, see
3388 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3389</p>
3390</dd>
3391<dt class="hdlist1">
3392<em>%gs</em>
3393</dt>
3394<dd>
3395<p>
3396reflog subject
3397</p>
3398</dd>
3399<dt class="hdlist1">
Junio C Hamano73a9b3e2023-09-14 18:21:28[diff] [blame]3400<em>%(trailers[:&lt;options&gt;])</em>
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3401</dt>
3402<dd>
3403<p>
Junio C Hamano73a9b3e2023-09-14 18:21:28[diff] [blame]3404display the trailers of the body as interpreted by
3405<a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>. The <code>trailers</code> string may be followed by
3406a colon and zero or more comma-separated options. If any option is provided
3407multiple times, the last occurrence wins.
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3408</p>
3409<div class="ulist"><ul>
3410<li>
3411<p>
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]3412<em>key=&lt;key&gt;</em>: only show trailers with specified &lt;key&gt;. Matching is done
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3413 case-insensitively and trailing colon is optional. If option is
3414 given multiple times trailer lines matching any of the keys are
3415 shown. This option automatically enables the <code>only</code> option so that
3416 non-trailer lines in the trailer block are hidden. If that is not
3417 desired it can be disabled with <code>only=false</code>. E.g.,
3418 <code>%(trailers:key=Reviewed-by)</code> shows trailer lines with key
3419 <code>Reviewed-by</code>.
Junio C Hamanoa3fd83c2007-03-02 10:34:36[diff] [blame]3420</p>
3421</li>
3422<li>
3423<p>
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]3424<em>only[=&lt;bool&gt;]</em>: select whether non-trailer lines from the trailer
Junio C Hamano674f3e12021-01-07 08:42:49[diff] [blame]3425 block should be included.
Junio C Hamanoa3fd83c2007-03-02 10:34:36[diff] [blame]3426</p>
3427</li>
3428<li>
3429<p>
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]3430<em>separator=&lt;sep&gt;</em>: specify a separator inserted between trailer
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3431 lines. When this option is not given each trailer line is
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]3432 terminated with a line feed character. The string &lt;sep&gt; may contain
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3433 the literal formatting codes described above. To use comma as
3434 separator one must use <code>%x2C</code> as it would otherwise be parsed as
Junio C Hamano674f3e12021-01-07 08:42:49[diff] [blame]3435 next option. E.g., <code>%(trailers:key=Ticket,separator=%x2C )</code>
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3436 shows all trailer lines whose key is "Ticket" separated by a comma
3437 and a space.
Junio C Hamanoa3fd83c2007-03-02 10:34:36[diff] [blame]3438</p>
3439</li>
3440<li>
3441<p>
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]3442<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:49[diff] [blame]3443 option was given. E.g.,
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3444 <code>%(trailers:only,unfold=true)</code> unfolds and shows all trailer lines.
Junio C Hamanoa3fd83c2007-03-02 10:34:36[diff] [blame]3445</p>
3446</li>
3447<li>
3448<p>
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]3449<em>keyonly[=&lt;bool&gt;]</em>: only show the key part of the trailer.
Junio C Hamano674f3e12021-01-07 08:42:49[diff] [blame]3450</p>
3451</li>
3452<li>
3453<p>
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]3454<em>valueonly[=&lt;bool&gt;]</em>: only show the value part of the trailer.
Junio C Hamano674f3e12021-01-07 08:42:49[diff] [blame]3455</p>
3456</li>
3457<li>
3458<p>
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]3459<em>key_value_separator=&lt;sep&gt;</em>: specify a separator inserted between
Junio C Hamano674f3e12021-01-07 08:42:49[diff] [blame]3460 trailer lines. When this option is not given each trailer key-value
3461 pair is separated by ": ". Otherwise it shares the same semantics
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]3462 as <em>separator=&lt;sep&gt;</em> above.
Junio C Hamanoa3fd83c2007-03-02 10:34:36[diff] [blame]3463</p>
3464</li>
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3465</ul></div>
3466</dd>
3467</dl></div>
Junio C Hamano04e768d2013-04-23 19:19:26[diff] [blame]3468</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]3469</ul></div>
Junio C Hamanoa3fd83c2007-03-02 10:34:36[diff] [blame]3470</li>
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]3471</ul></div>
3472<div class="admonitionblock">
3473<table><tr>
3474<td class="icon">
3475<div class="title">Note</div>
3476</td>
3477<td class="content">Some placeholders may depend on other options given to the
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3478revision traversal engine. For example, the <code>%g*</code> reflog options will
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]3479insert an empty string unless we are traversing reflog entries (e.g., by
Junio C Hamano00b9f1a2014-09-29 23:11:28[diff] [blame]3480<code>git log -g</code>). The <code>%d</code> and <code>%D</code> placeholders will use the "short"
3481decoration format if <code>--decorate</code> was not already provided on the command
3482line.</td>
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]3483</tr></table>
3484</div>
Junio C Hamano2b153182021-12-15 21:00:31[diff] [blame]3485<div class="paragraph"><p>The boolean options accept an optional value <code>[=&lt;bool-value&gt;]</code>. The values
3486<code>true</code>, <code>false</code>, <code>on</code>, <code>off</code> etc. are all accepted. See the "boolean"
3487sub-section in "EXAMPLES" in <a href="git-config.html">git-config(1)</a>. If a boolean
3488option is given with no value, it&#8217;s enabled.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3489<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:59[diff] [blame]3490is inserted immediately before the expansion if and only if the
3491placeholder expands to a non-empty string.</p></div>
Junio C Hamano535c65c2017-06-24 22:51:58[diff] [blame]3492<div class="paragraph"><p>If you add a <code>-</code> (minus sign) after <em>%</em> of a placeholder, all consecutive
3493line-feeds immediately preceding the expansion are deleted if and only if the
Junio C Hamano2bd8a742009-12-01 21:16:59[diff] [blame]3494placeholder expands to an empty string.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3495<div class="paragraph"><p>If you add a ` ` (space) after <em>%</em> of a placeholder, a space
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]3496is inserted immediately before the expansion if and only if the
3497placeholder expands to a non-empty string.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3498<div class="ulist"><ul>
Junio C Hamano6fb124c2008-06-13 10:04:01[diff] [blame]3499<li>
3500<p>
3501<em>tformat:</em>
3502</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3503<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:01[diff] [blame]3504provides "terminator" semantics instead of "separator" semantics. In
3505other words, each commit has the message terminator character (usually a
3506newline) appended, rather than a separator placed between entries.
3507This means that the final entry of a single-line format will be properly
3508terminated with a new line, just as the "oneline" format does.
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]3509For example:</p></div>
Junio C Hamano6fb124c2008-06-13 10:04:01[diff] [blame]3510<div class="listingblock">
3511<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3512<pre><code>$ git log -2 --pretty=format:%h 4da45bef \
Junio C Hamano6fb124c2008-06-13 10:04:01[diff] [blame]3513 | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
35144da45be
35157134973 -- NO NEWLINE
3516
3517$ git log -2 --pretty=tformat:%h 4da45bef \
3518 | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
35194da45be
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]35207134973</code></pre>
Junio C Hamano6fb124c2008-06-13 10:04:01[diff] [blame]3521</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3522<div class="paragraph"><p>In addition, any unrecognized string that has a <code>%</code> in it is interpreted
3523as if it has <code>tformat:</code> in front of it. For example, these two are
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]3524equivalent:</p></div>
3525<div class="listingblock">
3526<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3527<pre><code>$ git log -2 --pretty=tformat:%h 4da45bef
3528$ git log -2 --pretty=%h 4da45bef</code></pre>
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]3529</div></div>
Junio C Hamano6fb124c2008-06-13 10:04:01[diff] [blame]3530</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]3531</ul></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]3532</div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]3533</div>
3534<div class="sect1">
Junio C Hamano255163d2020-08-18 00:37:23[diff] [blame]3535<h2 id="_diff_formatting">DIFF FORMATTING</h2>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3536<div class="sectionbody">
Junio C Hamano255163d2020-08-18 00:37:23[diff] [blame]3537<div class="paragraph"><p>By default, <code>git log</code> does not generate any diff output. The options
3538below can be used to show the changes made by each commit.</p></div>
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]3539<div class="paragraph"><p>Note that unless one of <code>--diff-merges</code> variants (including short
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3540<code>-m</code>, <code>-c</code>, <code>--cc</code>, and <code>--dd</code> options) is explicitly given, merge commits
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]3541will not show a diff, even if a diff format like <code>--patch</code> is
3542selected, nor will they match search options like <code>-S</code>. The exception
3543is when <code>--first-parent</code> is in use, in which case <code>first-parent</code> is
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3544the default format for merge commits.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3545<div class="dlist"><dl>
3546<dt class="hdlist1">
3547-p
3548</dt>
3549<dt class="hdlist1">
3550-u
3551</dt>
3552<dt class="hdlist1">
3553--patch
3554</dt>
3555<dd>
3556<p>
Junio C Hamano73a9b3e2023-09-14 18:21:28[diff] [blame]3557 Generate patch (see <a href="#generate_patch_text_with_p">[generate_patch_text_with_p]</a>).
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3558</p>
3559</dd>
3560<dt class="hdlist1">
Junio C Hamano58f587a2013-07-22 19:20:59[diff] [blame]3561-s
3562</dt>
3563<dt class="hdlist1">
3564--no-patch
3565</dt>
3566<dd>
3567<p>
Junio C Hamanoa7b2c102023-06-13 21:00:15[diff] [blame]3568 Suppress all output from the diff machinery. Useful for
3569 commands like <code>git show</code> that show the patch by default to
3570 squelch their output, or to cancel the effect of options like
3571 <code>--patch</code>, <code>--stat</code> earlier on the command line in an alias.
Junio C Hamano58f587a2013-07-22 19:20:59[diff] [blame]3572</p>
3573</dd>
3574<dt class="hdlist1">
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3575-m
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]3576</dt>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3577<dd>
3578<p>
3579 Show diffs for merge commits in the default format. This is
3580 similar to <em>--diff-merges=on</em>, except <code>-m</code> will
3581 produce no output unless <code>-p</code> is given as well.
3582</p>
3583</dd>
3584<dt class="hdlist1">
3585-c
3586</dt>
3587<dd>
3588<p>
3589 Produce combined diff output for merge commits.
3590 Shortcut for <em>--diff-merges=combined -p</em>.
3591</p>
3592</dd>
3593<dt class="hdlist1">
3594--cc
3595</dt>
3596<dd>
3597<p>
3598 Produce dense combined diff output for merge commits.
3599 Shortcut for <em>--diff-merges=dense-combined -p</em>.
3600</p>
3601</dd>
3602<dt class="hdlist1">
3603--dd
3604</dt>
3605<dd>
3606<p>
3607 Produce diff with respect to first parent for both merge and
3608 regular commits.
3609 Shortcut for <em>--diff-merges=first-parent -p</em>.
3610</p>
3611</dd>
3612<dt class="hdlist1">
3613--remerge-diff
3614</dt>
3615<dd>
3616<p>
3617 Produce remerge-diff output for merge commits.
3618 Shortcut for <em>--diff-merges=remerge -p</em>.
3619</p>
3620</dd>
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]3621<dt class="hdlist1">
3622--no-diff-merges
3623</dt>
3624<dd>
3625<p>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3626 Synonym for <em>--diff-merges=off</em>.
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]3627</p>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3628</dd>
3629<dt class="hdlist1">
3630--diff-merges=&lt;format&gt;
3631</dt>
3632<dd>
3633<p>
3634 Specify diff format to be used for merge commits. Default is
3635 <code>off</code> unless <code>--first-parent</code> is in use, in
3636 which case <code>first-parent</code> is the default.
3637</p>
3638<div class="paragraph"><p>The following formats are supported:</p></div>
3639<div class="openblock">
3640<div class="content">
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]3641<div class="dlist"><dl>
3642<dt class="hdlist1">
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3643off, none
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]3644</dt>
3645<dd>
3646<p>
3647 Disable output of diffs for merge commits. Useful to override
3648 implied value.
3649</p>
3650</dd>
3651<dt class="hdlist1">
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3652on, m
Junio C Hamano4078a552021-04-30 06:08:10[diff] [blame]3653</dt>
3654<dd>
3655<p>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3656 Make diff output for merge commits to be shown in the default
Junio C Hamano918a6972023-10-29 23:44:11[diff] [blame]3657 format. The default format can be changed using
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3658 <code>log.diffMerges</code> configuration variable, whose default value
Junio C Hamano86505432021-08-11 20:13:58[diff] [blame]3659 is <code>separate</code>.
Junio C Hamano4078a552021-04-30 06:08:10[diff] [blame]3660</p>
3661</dd>
3662<dt class="hdlist1">
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3663first-parent, 1
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]3664</dt>
3665<dd>
3666<p>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3667 Show full diff with respect to first parent. This is the same
3668 format as <code>--patch</code> produces for non-merge commits.
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]3669</p>
3670</dd>
3671<dt class="hdlist1">
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3672separate
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]3673</dt>
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]3674<dd>
3675<p>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3676 Show full diff with respect to each of parents.
3677 Separate log entry and diff is generated for each parent.
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]3678</p>
3679</dd>
3680<dt class="hdlist1">
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3681combined, c
Junio C Hamanof1fc6ca2022-02-17 01:32:33[diff] [blame]3682</dt>
3683<dd>
3684<p>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3685 Show differences from each of the parents to the merge
3686 result simultaneously instead of showing pairwise diff between
3687 a parent and the result one at a time. Furthermore, it lists
3688 only files which were modified from all parents.
3689</p>
3690</dd>
3691<dt class="hdlist1">
3692dense-combined, cc
3693</dt>
3694<dd>
3695<p>
3696 Further compress output produced by <code>--diff-merges=combined</code>
3697 by omitting uninteresting hunks whose contents in the parents
3698 have only two variants and the merge result picks one of them
3699 without modification.
3700</p>
3701</dd>
3702<dt class="hdlist1">
3703remerge, r
3704</dt>
3705<dd>
3706<p>
3707 Remerge two-parent merge commits to create a temporary tree
3708 object&#8212;potentially containing files with conflict markers
3709 and such. A diff is then shown between that temporary tree
3710 and the actual merge commit.
Junio C Hamanof1fc6ca2022-02-17 01:32:33[diff] [blame]3711</p>
3712<div class="paragraph"><p>The output emitted when this option is used is subject to change, and
3713so is its interaction with other options (unless explicitly
3714documented).</p></div>
3715</dd>
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]3716</dl></div>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]3717</div></div>
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]3718</dd>
3719<dt class="hdlist1">
3720--combined-all-paths
3721</dt>
3722<dd>
3723<p>
3724 This flag causes combined diffs (used for merge commits) to
3725 list the name of the file from all parents. It thus only has
3726 effect when <code>--diff-merges=[dense-]combined</code> is in use, and
3727 is likely only useful if filename changes are detected (i.e.
3728 when either rename or copy detection have been requested).
3729</p>
3730</dd>
3731<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3732-U&lt;n&gt;
3733</dt>
3734<dt class="hdlist1">
3735--unified=&lt;n&gt;
3736</dt>
3737<dd>
3738<p>
3739 Generate diffs with &lt;n&gt; lines of context instead of
Junio C Hamanoee43d182020-11-11 22:10:41[diff] [blame]3740 the usual three.
3741 Implies <code>--patch</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3742</p>
3743</dd>
3744<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3745--output=&lt;file&gt;
3746</dt>
3747<dd>
3748<p>
3749 Output to a specific file instead of stdout.
3750</p>
3751</dd>
3752<dt class="hdlist1">
3753--output-indicator-new=&lt;char&gt;
3754</dt>
3755<dt class="hdlist1">
3756--output-indicator-old=&lt;char&gt;
3757</dt>
3758<dt class="hdlist1">
3759--output-indicator-context=&lt;char&gt;
3760</dt>
3761<dd>
3762<p>
3763 Specify the character used to indicate new, old or context
3764 lines in the generated patch. Normally they are <em>+</em>, <em>-</em> and
3765 ' ' respectively.
3766</p>
3767</dd>
3768<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3769--raw
3770</dt>
3771<dd>
3772<p>
Junio C Hamano85f1fde2015-06-01 20:37:32[diff] [blame]3773 For each commit, show a summary of changes using the raw diff
3774 format. See the "RAW OUTPUT FORMAT" section of
3775 <a href="git-diff.html">git-diff(1)</a>. This is different from showing the log
3776 itself in raw format, which you can achieve with
3777 <code>--format=raw</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3778</p>
3779</dd>
3780<dt class="hdlist1">
3781--patch-with-raw
3782</dt>
3783<dd>
3784<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3785 Synonym for <code>-p --raw</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3786</p>
3787</dd>
3788<dt class="hdlist1">
Junio C Hamano255163d2020-08-18 00:37:23[diff] [blame]3789-t
3790</dt>
3791<dd>
3792<p>
3793 Show the tree objects in the diff output.
3794</p>
3795</dd>
3796<dt class="hdlist1">
Junio C Hamanoad70bf02016-09-26 23:44:27[diff] [blame]3797--indent-heuristic
3798</dt>
Junio C Hamanoa65b6762017-11-06 04:45:42[diff] [blame]3799<dd>
3800<p>
Junio C Hamano14e66832018-06-18 18:32:19[diff] [blame]3801 Enable the heuristic that shifts diff hunk boundaries to make patches
Junio C Hamanoa65b6762017-11-06 04:45:42[diff] [blame]3802 easier to read. This is the default.
3803</p>
3804</dd>
Junio C Hamanoad70bf02016-09-26 23:44:27[diff] [blame]3805<dt class="hdlist1">
3806--no-indent-heuristic
3807</dt>
Junio C Hamano5f888332016-06-13 19:28:31[diff] [blame]3808<dd>
3809<p>
Junio C Hamanoa65b6762017-11-06 04:45:42[diff] [blame]3810 Disable the indent heuristic.
Junio C Hamano5f888332016-06-13 19:28:31[diff] [blame]3811</p>
3812</dd>
3813<dt class="hdlist1">
Junio C Hamano5a73f302011-10-14 05:58:34[diff] [blame]3814--minimal
3815</dt>
3816<dd>
3817<p>
3818 Spend extra time to make sure the smallest possible
3819 diff is produced.
3820</p>
3821</dd>
3822<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3823--patience
3824</dt>
3825<dd>
3826<p>
3827 Generate a diff using the "patience diff" algorithm.
3828</p>
3829</dd>
3830<dt class="hdlist1">
Junio C Hamanoaea9e6b2012-03-07 00:17:11[diff] [blame]3831--histogram
3832</dt>
3833<dd>
3834<p>
3835 Generate a diff using the "histogram diff" algorithm.
3836</p>
3837</dd>
3838<dt class="hdlist1">
Junio C Hamano047135e2017-12-19 21:57:54[diff] [blame]3839--anchored=&lt;text&gt;
3840</dt>
3841<dd>
3842<p>
3843 Generate a diff using the "anchored diff" algorithm.
3844</p>
3845<div class="paragraph"><p>This option may be specified more than once.</p></div>
3846<div class="paragraph"><p>If a line exists in both the source and destination, exists only once,
3847and starts with this text, this algorithm attempts to prevent it from
3848appearing as a deletion or addition in the output. It uses the "patience
3849diff" algorithm internally.</p></div>
3850</dd>
3851<dt class="hdlist1">
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]3852--diff-algorithm={patience|minimal|histogram|myers}
3853</dt>
3854<dd>
3855<p>
3856 Choose a diff algorithm. The variants are as follows:
3857</p>
3858<div class="openblock">
3859<div class="content">
3860<div class="dlist"><dl>
3861<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3862<code>default</code>, <code>myers</code>
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]3863</dt>
3864<dd>
3865<p>
3866 The basic greedy diff algorithm. Currently, this is the default.
3867</p>
3868</dd>
3869<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3870<code>minimal</code>
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]3871</dt>
3872<dd>
3873<p>
3874 Spend extra time to make sure the smallest possible diff is
3875 produced.
3876</p>
3877</dd>
3878<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3879<code>patience</code>
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]3880</dt>
3881<dd>
3882<p>
3883 Use "patience diff" algorithm when generating patches.
3884</p>
3885</dd>
3886<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3887<code>histogram</code>
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]3888</dt>
3889<dd>
3890<p>
3891 This algorithm extends the patience algorithm to "support
3892 low-occurrence common elements".
3893</p>
3894</dd>
3895</dl></div>
3896</div></div>
Junio C Hamano14e66832018-06-18 18:32:19[diff] [blame]3897<div class="paragraph"><p>For instance, if you configured the <code>diff.algorithm</code> variable to a
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]3898non-default value and want to use the default one, then you
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3899have to use <code>--diff-algorithm=default</code> option.</p></div>
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]3900</dd>
3901<dt class="hdlist1">
Junio C Hamano4c4b0122011-06-30 01:19:32[diff] [blame]3902--stat[=&lt;width&gt;[,&lt;name-width&gt;[,&lt;count&gt;]]]
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3903</dt>
3904<dd>
3905<p>
Junio C Hamanoaea9e6b2012-03-07 00:17:11[diff] [blame]3906 Generate a diffstat. By default, as much space as necessary
3907 will be used for the filename part, and the rest for the graph
3908 part. Maximum width defaults to terminal width, or 80 columns
Junio C Hamano7f2b3cb2012-06-22 22:42:39[diff] [blame]3909 if not connected to a terminal, and can be overridden by
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3910 <code>&lt;width&gt;</code>. The width of the filename part can be limited by
Junio C Hamano2b1164d2023-09-29 16:43:29[diff] [blame]3911 giving another width <code>&lt;name-width&gt;</code> after a comma or by setting
3912 <code>diff.statNameWidth=&lt;width&gt;</code>. The width of the graph part can be
3913 limited by using <code>--stat-graph-width=&lt;width&gt;</code> or by setting
3914 <code>diff.statGraphWidth=&lt;width&gt;</code>. Using <code>--stat</code> or
3915 <code>--stat-graph-width</code> affects all commands generating a stat graph,
3916 while setting <code>diff.statNameWidth</code> or <code>diff.statGraphWidth</code>
3917 does not affect <code>git format-patch</code>.
3918 By giving a third parameter <code>&lt;count&gt;</code>, you can limit the output to
3919 the first <code>&lt;count&gt;</code> lines, followed by <code>...</code> if there are more.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3920</p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3921<div class="paragraph"><p>These parameters can also be set individually with <code>--stat-width=&lt;width&gt;</code>,
3922<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:22[diff] [blame]3923</dd>
3924<dt class="hdlist1">
Junio C Hamano45badf02018-03-14 21:56:41[diff] [blame]3925--compact-summary
3926</dt>
3927<dd>
3928<p>
3929 Output a condensed summary of extended header information such
3930 as file creations or deletions ("new" or "gone", optionally "+l"
3931 if it&#8217;s a symlink) and mode changes ("+x" or "-x" for adding
3932 or removing executable bit respectively) in diffstat. The
Junio C Hamanofa2915c2018-06-19 19:50:18[diff] [blame]3933 information is put between the filename part and the graph
Junio C Hamano45badf02018-03-14 21:56:41[diff] [blame]3934 part. Implies <code>--stat</code>.
3935</p>
3936</dd>
3937<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3938--numstat
3939</dt>
3940<dd>
3941<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3942 Similar to <code>--stat</code>, but shows number of added and
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3943 deleted lines in decimal notation and pathname without
3944 abbreviation, to make it more machine friendly. For
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3945 binary files, outputs two <code>-</code> instead of saying
3946 <code>0 0</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3947</p>
3948</dd>
3949<dt class="hdlist1">
3950--shortstat
3951</dt>
3952<dd>
3953<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3954 Output only the last line of the <code>--stat</code> format containing total
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3955 number of modified files, as well as number of added and deleted
3956 lines.
3957</p>
3958</dd>
3959<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]3960-X[&lt;param1,param2,&#8230;&gt;]
3961</dt>
3962<dt class="hdlist1">
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3963--dirstat[=&lt;param1,param2,&#8230;&gt;]
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3964</dt>
3965<dd>
3966<p>
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3967 Output the distribution of relative amount of changes for each
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3968 sub-directory. The behavior of <code>--dirstat</code> can be customized by
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3969 passing it a comma separated list of parameters.
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3970 The defaults are controlled by the <code>diff.dirstat</code> configuration
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]3971 variable (see <a href="git-config.html">git-config(1)</a>).
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3972 The following parameters are available:
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3973</p>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]3974<div class="openblock">
3975<div class="content">
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3976<div class="dlist"><dl>
3977<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3978<code>changes</code>
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3979</dt>
3980<dd>
3981<p>
3982 Compute the dirstat numbers by counting the lines that have been
3983 removed from the source, or added to the destination. This ignores
3984 the amount of pure code movements within a file. In other words,
3985 rearranging lines in a file is not counted as much as other changes.
3986 This is the default behavior when no parameter is given.
3987</p>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3988</dd>
3989<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3990<code>lines</code>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3991</dt>
3992<dd>
3993<p>
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3994 Compute the dirstat numbers by doing the regular line-based diff
3995 analysis, and summing the removed/added line counts. (For binary
3996 files, count 64-byte chunks instead, since binary files have no
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]3997 natural concept of lines). This is a more expensive <code>--dirstat</code>
3998 behavior than the <code>changes</code> behavior, but it does count rearranged
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3999 lines within a file as much as other changes. The resulting output
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4000 is consistent with what you get from the other <code>--*stat</code> options.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4001</p>
4002</dd>
4003<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4004<code>files</code>
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]4005</dt>
4006<dd>
4007<p>
4008 Compute the dirstat numbers by counting the number of files changed.
4009 Each changed file counts equally in the dirstat analysis. This is
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4010 the computationally cheapest <code>--dirstat</code> behavior, since it does
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]4011 not have to look at the file contents at all.
4012</p>
4013</dd>
4014<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4015<code>cumulative</code>
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]4016</dt>
4017<dd>
4018<p>
4019 Count changes in a child directory for the parent directory as well.
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4020 Note that when using <code>cumulative</code>, the sum of the percentages
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]4021 reported may exceed 100%. The default (non-cumulative) behavior can
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4022 be specified with the <code>noncumulative</code> parameter.
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]4023</p>
4024</dd>
4025<dt class="hdlist1">
4026&lt;limit&gt;
4027</dt>
4028<dd>
4029<p>
4030 An integer parameter specifies a cut-off percent (3% by default).
4031 Directories contributing less than this percentage of the changes
4032 are not shown in the output.
4033</p>
4034</dd>
4035</dl></div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]4036</div></div>
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]4037<div class="paragraph"><p>Example: The following will count changed files, while ignoring
4038directories with less than 10% of the total amount of changed files,
4039and accumulating child directory counts in the parent directories:
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4040<code>--dirstat=files,10,cumulative</code>.</p></div>
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]4041</dd>
4042<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]4043--cumulative
4044</dt>
4045<dd>
4046<p>
4047 Synonym for --dirstat=cumulative
4048</p>
4049</dd>
4050<dt class="hdlist1">
4051--dirstat-by-file[=&lt;param1,param2&gt;&#8230;]
4052</dt>
4053<dd>
4054<p>
Junio C Hamano6546a502024-02-08 23:48:36[diff] [blame^]4055 Synonym for --dirstat=files,&lt;param1&gt;,&lt;param2&gt;&#8230;
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]4056</p>
4057</dd>
4058<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4059--summary
4060</dt>
4061<dd>
4062<p>
4063 Output a condensed summary of extended header information
4064 such as creations, renames and mode changes.
4065</p>
4066</dd>
4067<dt class="hdlist1">
4068--patch-with-stat
4069</dt>
4070<dd>
4071<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4072 Synonym for <code>-p --stat</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4073</p>
4074</dd>
4075<dt class="hdlist1">
4076-z
4077</dt>
4078<dd>
4079<p>
Junio C Hamano918a6972023-10-29 23:44:11[diff] [blame]4080 Separate the commits with NULs instead of newlines.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4081</p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4082<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:22[diff] [blame]4083pathnames and use NULs as output field terminators.</p></div>
Junio C Hamano0f6f3bf2017-03-13 07:01:53[diff] [blame]4084<div class="paragraph"><p>Without this option, pathnames with "unusual" characters are quoted as
4085explained for the configuration variable <code>core.quotePath</code> (see
4086<a href="git-config.html">git-config(1)</a>).</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4087</dd>
4088<dt class="hdlist1">
4089--name-only
4090</dt>
4091<dd>
4092<p>
Junio C Hamano4078a552021-04-30 06:08:10[diff] [blame]4093 Show only names of changed files. The file names are often encoded in UTF-8.
4094 For more information see the discussion about encoding in the <a href="git-log.html">git-log(1)</a>
4095 manual page.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4096</p>
4097</dd>
4098<dt class="hdlist1">
4099--name-status
4100</dt>
4101<dd>
4102<p>
4103 Show only names and status of changed files. See the description
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4104 of the <code>--diff-filter</code> option on what the status letters mean.
Junio C Hamano4078a552021-04-30 06:08:10[diff] [blame]4105 Just like <code>--name-only</code> the file names are often encoded in UTF-8.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4106</p>
4107</dd>
4108<dt class="hdlist1">
4109--submodule[=&lt;format&gt;]
4110</dt>
4111<dd>
4112<p>
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]4113 Specify how differences in submodules are shown. When specifying
4114 <code>--submodule=short</code> the <em>short</em> format is used. This format just
4115 shows the names of the commits at the beginning and end of the range.
4116 When <code>--submodule</code> or <code>--submodule=log</code> is specified, the <em>log</em>
4117 format is used. This format lists the commits in the range like
4118 <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code> does. When <code>--submodule=diff</code>
4119 is specified, the <em>diff</em> format is used. This format shows an
4120 inline diff of the changes in the submodule contents between the
4121 commit range. Defaults to <code>diff.submodule</code> or the <em>short</em> format
4122 if the config option is unset.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4123</p>
4124</dd>
4125<dt class="hdlist1">
4126--color[=&lt;when&gt;]
4127</dt>
4128<dd>
4129<p>
4130 Show colored diff.
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4131 <code>--color</code> (i.e. without <em>=&lt;when&gt;</em>) is the same as <code>--color=always</code>.
4132 <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:22[diff] [blame]4133</p>
4134</dd>
4135<dt class="hdlist1">
4136--no-color
4137</dt>
4138<dd>
4139<p>
Junio C Hamano5f2627d2011-05-06 20:23:48[diff] [blame]4140 Turn off colored diff.
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4141 It is the same as <code>--color=never</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4142</p>
4143</dd>
4144<dt class="hdlist1">
Junio C Hamanofb1fdf12017-08-27 06:14:59[diff] [blame]4145--color-moved[=&lt;mode&gt;]
4146</dt>
4147<dd>
4148<p>
4149 Moved lines of code are colored differently.
4150 The &lt;mode&gt; defaults to <em>no</em> if the option is not given
4151 and to <em>zebra</em> if the option with no mode is given.
4152 The mode must be one of:
4153</p>
4154<div class="openblock">
4155<div class="content">
4156<div class="dlist"><dl>
4157<dt class="hdlist1">
4158no
4159</dt>
4160<dd>
4161<p>
4162 Moved lines are not highlighted.
4163</p>
4164</dd>
4165<dt class="hdlist1">
4166default
4167</dt>
4168<dd>
4169<p>
4170 Is a synonym for <code>zebra</code>. This may change to a more sensible mode
4171 in the future.
4172</p>
4173</dd>
4174<dt class="hdlist1">
4175plain
4176</dt>
4177<dd>
4178<p>
4179 Any line that is added in one location and was removed
4180 in another location will be colored with <em>color.diff.newMoved</em>.
4181 Similarly <em>color.diff.oldMoved</em> will be used for removed lines
4182 that are added somewhere else in the diff. This mode picks up any
4183 moved line, but it is not very useful in a review to determine
4184 if a block of code was moved without permutation.
4185</p>
4186</dd>
4187<dt class="hdlist1">
Junio C Hamanof09b7cd2018-08-02 23:01:45[diff] [blame]4188blocks
Junio C Hamanofb1fdf12017-08-27 06:14:59[diff] [blame]4189</dt>
4190<dd>
4191<p>
4192 Blocks of moved text of at least 20 alphanumeric characters
4193 are detected greedily. The detected blocks are
Junio C Hamanof09b7cd2018-08-02 23:01:45[diff] [blame]4194 painted using either the <em>color.diff.{old,new}Moved</em> color.
4195 Adjacent blocks cannot be told apart.
4196</p>
4197</dd>
4198<dt class="hdlist1">
4199zebra
4200</dt>
4201<dd>
4202<p>
4203 Blocks of moved text are detected as in <em>blocks</em> mode. The blocks
4204 are painted using either the <em>color.diff.{old,new}Moved</em> color or
Junio C Hamanofb1fdf12017-08-27 06:14:59[diff] [blame]4205 <em>color.diff.{old,new}MovedAlternative</em>. The change between
4206 the two colors indicates that a new block was detected.
4207</p>
4208</dd>
4209<dt class="hdlist1">
Junio C Hamanobfd91f42018-08-17 22:21:16[diff] [blame]4210dimmed-zebra
Junio C Hamanofb1fdf12017-08-27 06:14:59[diff] [blame]4211</dt>
4212<dd>
4213<p>
4214 Similar to <em>zebra</em>, but additional dimming of uninteresting parts
4215 of moved code is performed. The bordering lines of two adjacent
4216 blocks are considered interesting, the rest is uninteresting.
Junio C Hamanobfd91f42018-08-17 22:21:16[diff] [blame]4217 <code>dimmed_zebra</code> is a deprecated synonym.
Junio C Hamanofb1fdf12017-08-27 06:14:59[diff] [blame]4218</p>
4219</dd>
4220</dl></div>
4221</div></div>
4222</dd>
4223<dt class="hdlist1">
Junio C Hamanoa90214f2019-01-28 22:05:25[diff] [blame]4224--no-color-moved
4225</dt>
4226<dd>
4227<p>
4228 Turn off move detection. This can be used to override configuration
4229 settings. It is the same as <code>--color-moved=no</code>.
4230</p>
4231</dd>
4232<dt class="hdlist1">
Junio C Hamanof09b7cd2018-08-02 23:01:45[diff] [blame]4233--color-moved-ws=&lt;modes&gt;
4234</dt>
4235<dd>
4236<p>
Junio C Hamanoa90214f2019-01-28 22:05:25[diff] [blame]4237 This configures how whitespace is ignored when performing the
Junio C Hamanof09b7cd2018-08-02 23:01:45[diff] [blame]4238 move detection for <code>--color-moved</code>.
4239 These modes can be given as a comma separated list:
4240</p>
4241<div class="openblock">
4242<div class="content">
4243<div class="dlist"><dl>
4244<dt class="hdlist1">
Junio C Hamanoa90214f2019-01-28 22:05:25[diff] [blame]4245no
4246</dt>
4247<dd>
4248<p>
4249 Do not ignore whitespace when performing move detection.
4250</p>
4251</dd>
4252<dt class="hdlist1">
Junio C Hamanof09b7cd2018-08-02 23:01:45[diff] [blame]4253ignore-space-at-eol
4254</dt>
4255<dd>
4256<p>
4257 Ignore changes in whitespace at EOL.
4258</p>
4259</dd>
4260<dt class="hdlist1">
4261ignore-space-change
4262</dt>
4263<dd>
4264<p>
4265 Ignore changes in amount of whitespace. This ignores whitespace
4266 at line end, and considers all other sequences of one or
4267 more whitespace characters to be equivalent.
4268</p>
4269</dd>
4270<dt class="hdlist1">
4271ignore-all-space
4272</dt>
4273<dd>
4274<p>
4275 Ignore whitespace when comparing lines. This ignores differences
4276 even if one line has whitespace where the other line has none.
4277</p>
4278</dd>
4279<dt class="hdlist1">
4280allow-indentation-change
4281</dt>
4282<dd>
4283<p>
Junio C Hamanoa90214f2019-01-28 22:05:25[diff] [blame]4284 Initially ignore any whitespace in the move detection, then
Junio C Hamanof09b7cd2018-08-02 23:01:45[diff] [blame]4285 group the moved code blocks only into a block if the change in
4286 whitespace is the same per line. This is incompatible with the
4287 other modes.
4288</p>
4289</dd>
4290</dl></div>
4291</div></div>
4292</dd>
4293<dt class="hdlist1">
Junio C Hamanoa90214f2019-01-28 22:05:25[diff] [blame]4294--no-color-moved-ws
4295</dt>
4296<dd>
4297<p>
4298 Do not ignore whitespace when performing move detection. This can be
4299 used to override configuration settings. It is the same as
4300 <code>--color-moved-ws=no</code>.
4301</p>
4302</dd>
4303<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4304--word-diff[=&lt;mode&gt;]
4305</dt>
4306<dd>
4307<p>
4308 Show a word diff, using the &lt;mode&gt; to delimit changed words.
4309 By default, words are delimited by whitespace; see
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4310 <code>--word-diff-regex</code> below. The &lt;mode&gt; defaults to <em>plain</em>, and
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4311 must be one of:
4312</p>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]4313<div class="openblock">
4314<div class="content">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4315<div class="dlist"><dl>
4316<dt class="hdlist1">
4317color
4318</dt>
4319<dd>
4320<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4321 Highlight changed words using only colors. Implies <code>--color</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4322</p>
4323</dd>
4324<dt class="hdlist1">
4325plain
4326</dt>
4327<dd>
4328<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4329 Show words as <code>[-removed-]</code> and <code>{+added+}</code>. Makes no
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4330 attempts to escape the delimiters if they appear in the input,
4331 so the output may be ambiguous.
4332</p>
4333</dd>
4334<dt class="hdlist1">
4335porcelain
4336</dt>
4337<dd>
4338<p>
4339 Use a special line-based format intended for script
4340 consumption. Added/removed/unchanged runs are printed in the
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4341 usual unified diff format, starting with a <code>+</code>/<code>-</code>/` `
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4342 character at the beginning of the line and extending to the
4343 end of the line. Newlines in the input are represented by a
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4344 tilde <code>~</code> on a line of its own.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4345</p>
4346</dd>
4347<dt class="hdlist1">
4348none
4349</dt>
4350<dd>
4351<p>
4352 Disable word diff again.
4353</p>
4354</dd>
4355</dl></div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]4356</div></div>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4357<div class="paragraph"><p>Note that despite the name of the first mode, color is used to
4358highlight the changed parts in all modes if enabled.</p></div>
4359</dd>
4360<dt class="hdlist1">
4361--word-diff-regex=&lt;regex&gt;
4362</dt>
4363<dd>
4364<p>
4365 Use &lt;regex&gt; to decide what a word is, instead of considering
4366 runs of non-whitespace to be a word. Also implies
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4367 <code>--word-diff</code> unless it was already enabled.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4368</p>
4369<div class="paragraph"><p>Every non-overlapping match of the
4370&lt;regex&gt; is considered a word. Anything between these matches is
4371considered whitespace and ignored(!) for the purposes of finding
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4372differences. You may want to append <code>|[^[:space:]]</code> to your regular
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4373expression to make sure that it matches all non-whitespace characters.
4374A match that contains a newline is silently truncated(!) at the
4375newline.</p></div>
Junio C Hamano713eded2015-12-03 00:24:02[diff] [blame]4376<div class="paragraph"><p>For example, <code>--word-diff-regex=.</code> will treat each character as a word
4377and, correspondingly, show differences character by character.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4378<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:24[diff] [blame]4379<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:22[diff] [blame]4380overrides any diff driver or configuration setting. Diff drivers
4381override configuration settings.</p></div>
4382</dd>
4383<dt class="hdlist1">
4384--color-words[=&lt;regex&gt;]
4385</dt>
4386<dd>
4387<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4388 Equivalent to <code>--word-diff=color</code> plus (if a regex was
4389 specified) <code>--word-diff-regex=&lt;regex&gt;</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4390</p>
4391</dd>
4392<dt class="hdlist1">
4393--no-renames
4394</dt>
4395<dd>
4396<p>
4397 Turn off rename detection, even when the configuration
4398 file gives the default to do so.
4399</p>
4400</dd>
4401<dt class="hdlist1">
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]4402--[no-]rename-empty
4403</dt>
4404<dd>
4405<p>
4406 Whether to use empty blobs as rename source.
4407</p>
4408</dd>
4409<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4410--check
4411</dt>
4412<dd>
4413<p>
Junio C Hamano84ea1e42016-04-08 21:53:48[diff] [blame]4414 Warn if changes introduce conflict markers or whitespace errors.
4415 What are considered whitespace errors is controlled by <code>core.whitespace</code>
Junio C Hamano6005bfa2011-06-23 00:51:22[diff] [blame]4416 configuration. By default, trailing whitespaces (including
Junio C Hamano14e66832018-06-18 18:32:19[diff] [blame]4417 lines that consist solely of whitespaces) and a space character
Junio C Hamano6005bfa2011-06-23 00:51:22[diff] [blame]4418 that is immediately followed by a tab character inside the
4419 initial indent of the line are considered whitespace errors.
4420 Exits with non-zero status if problems are found. Not compatible
4421 with --exit-code.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4422</p>
4423</dd>
4424<dt class="hdlist1">
Junio C Hamano8c5d5942015-06-11 19:37:48[diff] [blame]4425--ws-error-highlight=&lt;kind&gt;
4426</dt>
4427<dd>
4428<p>
Junio C Hamano4b2a6c12017-08-22 18:32:37[diff] [blame]4429 Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
4430 lines of the diff. Multiple values are separated by comma,
4431 <code>none</code> resets previous values, <code>default</code> reset the list to
4432 <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>. When
4433 this option is not given, and the configuration variable
4434 <code>diff.wsErrorHighlight</code> is not set, only whitespace errors in
4435 <code>new</code> lines are highlighted. The whitespace errors are colored
Junio C Hamano14e66832018-06-18 18:32:19[diff] [blame]4436 with <code>color.diff.whitespace</code>.
Junio C Hamano8c5d5942015-06-11 19:37:48[diff] [blame]4437</p>
4438</dd>
4439<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4440--full-index
4441</dt>
4442<dd>
4443<p>
4444 Instead of the first handful of characters, show the full
4445 pre- and post-image blob object names on the "index"
4446 line when generating patch format output.
4447</p>
4448</dd>
4449<dt class="hdlist1">
4450--binary
4451</dt>
4452<dd>
4453<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4454 In addition to <code>--full-index</code>, output a binary diff that
Junio C Hamanoee43d182020-11-11 22:10:41[diff] [blame]4455 can be applied with <code>git-apply</code>.
4456 Implies <code>--patch</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4457</p>
4458</dd>
4459<dt class="hdlist1">
4460--abbrev[=&lt;n&gt;]
4461</dt>
4462<dd>
4463<p>
4464 Instead of showing the full 40-byte hexadecimal object
4465 name in diff-raw format output and diff-tree header
Junio C Hamanoee43d182020-11-11 22:10:41[diff] [blame]4466 lines, show the shortest prefix that is at least <em>&lt;n&gt;</em>
4467 hexdigits long that uniquely refers the object.
Junio C Hamanocf8aeaf2020-08-31 23:16:35[diff] [blame]4468 In diff-patch output format, <code>--full-index</code> takes higher
4469 precedence, i.e. if <code>--full-index</code> is specified, full blob
4470 names will be shown regardless of <code>--abbrev</code>.
4471 Non default number of digits can be specified with <code>--abbrev=&lt;n&gt;</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4472</p>
4473</dd>
4474<dt class="hdlist1">
4475-B[&lt;n&gt;][/&lt;m&gt;]
4476</dt>
4477<dt class="hdlist1">
4478--break-rewrites[=[&lt;n&gt;][/&lt;m&gt;]]
4479</dt>
4480<dd>
4481<p>
4482 Break complete rewrite changes into pairs of delete and
4483 create. This serves two purposes:
4484</p>
4485<div class="paragraph"><p>It affects the way a change that amounts to a total rewrite of a file
4486not as a series of deletion and insertion mixed together with a very
4487few lines that happen to match textually as the context, but as a
4488single deletion of everything old followed by a single insertion of
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4489everything new, and the number <code>m</code> controls this aspect of the -B
4490option (defaults to 60%). <code>-B/70%</code> specifies that less than 30% of the
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]4491original should remain in the result for Git to consider it a total
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4492rewrite (i.e. otherwise the resulting patch will be a series of
4493deletion and insertion mixed together with context lines).</p></div>
4494<div class="paragraph"><p>When used with -M, a totally-rewritten file is also considered as the
4495source of a rename (usually -M only considers a file that disappeared
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4496as the source of a rename), and the number <code>n</code> controls this aspect of
4497the -B option (defaults to 50%). <code>-B20%</code> specifies that a change with
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4498addition and deletion compared to 20% or more of the file&#8217;s size are
4499eligible for being picked up as a possible source of a rename to
4500another file.</p></div>
4501</dd>
4502<dt class="hdlist1">
4503-M[&lt;n&gt;]
4504</dt>
4505<dt class="hdlist1">
4506--find-renames[=&lt;n&gt;]
4507</dt>
4508<dd>
4509<p>
4510 If generating diffs, detect and report renames for each commit.
4511 For following files across renames while traversing history, see
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4512 <code>--follow</code>.
4513 If <code>n</code> is specified, it is a threshold on the similarity
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4514 index (i.e. amount of addition/deletions compared to the
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4515 file&#8217;s size). For example, <code>-M90%</code> means Git should consider a
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4516 delete/add pair to be a rename if more than 90% of the file
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4517 hasn&#8217;t changed. Without a <code>%</code> sign, the number is to be read as
4518 a fraction, with a decimal point before it. I.e., <code>-M5</code> becomes
4519 0.5, and is thus the same as <code>-M50%</code>. Similarly, <code>-M05</code> is
4520 the same as <code>-M5%</code>. To limit detection to exact renames, use
4521 <code>-M100%</code>. The default similarity index is 50%.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4522</p>
4523</dd>
4524<dt class="hdlist1">
4525-C[&lt;n&gt;]
4526</dt>
4527<dt class="hdlist1">
4528--find-copies[=&lt;n&gt;]
4529</dt>
4530<dd>
4531<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4532 Detect copies as well as renames. See also <code>--find-copies-harder</code>.
4533 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:22[diff] [blame]4534</p>
4535</dd>
4536<dt class="hdlist1">
4537--find-copies-harder
4538</dt>
4539<dd>
4540<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4541 For performance reasons, by default, <code>-C</code> option finds copies only
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4542 if the original file of the copy was modified in the same
4543 changeset. This flag makes the command
4544 inspect unmodified files as candidates for the source of
4545 copy. This is a very expensive operation for large
4546 projects, so use it with caution. Giving more than one
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4547 <code>-C</code> option has the same effect.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4548</p>
4549</dd>
4550<dt class="hdlist1">
Junio C Hamanob02377c2011-04-28 22:26:02[diff] [blame]4551-D
4552</dt>
4553<dt class="hdlist1">
4554--irreversible-delete
4555</dt>
4556<dd>
4557<p>
4558 Omit the preimage for deletes, i.e. print only the header but not
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4559 the diff between the preimage and <code>/dev/null</code>. The resulting patch
4560 is not meant to be applied with <code>patch</code> or <code>git apply</code>; this is
Junio C Hamanob02377c2011-04-28 22:26:02[diff] [blame]4561 solely for people who want to just concentrate on reviewing the
Junio C Hamanod16fd1b2017-08-04 16:41:51[diff] [blame]4562 text after the change. In addition, the output obviously lacks
Junio C Hamanob02377c2011-04-28 22:26:02[diff] [blame]4563 enough information to apply such a patch in reverse, even manually,
4564 hence the name of the option.
4565</p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4566<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:02[diff] [blame]4567of a delete/create pair.</p></div>
4568</dd>
4569<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4570-l&lt;num&gt;
4571</dt>
4572<dd>
4573<p>
Junio C Hamano20cf4932021-07-28 21:02:52[diff] [blame]4574 The <code>-M</code> and <code>-C</code> options involve some preliminary steps that
4575 can detect subsets of renames/copies cheaply, followed by an
4576 exhaustive fallback portion that compares all remaining
4577 unpaired destinations to all relevant sources. (For renames,
4578 only remaining unpaired sources are relevant; for copies, all
4579 original sources are relevant.) For N sources and
4580 destinations, this exhaustive check is O(N^2). This option
4581 prevents the exhaustive portion of rename/copy detection from
4582 running if the number of source/destination files involved
4583 exceeds the specified number. Defaults to diff.renameLimit.
4584 Note that a value of 0 is treated as unlimited.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4585</p>
4586</dd>
4587<dt class="hdlist1">
4588--diff-filter=[(A|C|D|M|R|T|U|X|B)&#8230;[*]]
4589</dt>
4590<dd>
4591<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4592 Select only files that are Added (<code>A</code>), Copied (<code>C</code>),
4593 Deleted (<code>D</code>), Modified (<code>M</code>), Renamed (<code>R</code>), have their
4594 type (i.e. regular file, symlink, submodule, &#8230;) changed (<code>T</code>),
4595 are Unmerged (<code>U</code>), are
4596 Unknown (<code>X</code>), or have had their pairing Broken (<code>B</code>).
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4597 Any combination of the filter characters (including none) can be used.
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4598 When <code>*</code> (All-or-none) is added to the combination, all
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4599 paths are selected if there is any file that matches
4600 other criteria in the comparison; if there is no file
4601 that matches other criteria, nothing is selected.
4602</p>
Junio C Hamanoeed15af2016-07-25 22:49:42[diff] [blame]4603<div class="paragraph"><p>Also, these upper-case letters can be downcased to exclude. E.g.
4604<code>--diff-filter=ad</code> excludes added and deleted paths.</p></div>
Junio C Hamanof1fc6ca2022-02-17 01:32:33[diff] [blame]4605<div class="paragraph"><p>Note that not all diffs can feature all types. For instance, copied and
4606renamed entries cannot appear if detection for those types is disabled.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4607</dd>
4608<dt class="hdlist1">
4609-S&lt;string&gt;
4610</dt>
4611<dd>
4612<p>
Junio C Hamanof1f5a7b2013-06-11 22:23:52[diff] [blame]4613 Look for differences that change the number of occurrences of
4614 the specified string (i.e. addition/deletion) in a file.
4615 Intended for the scripter&#8217;s use.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4616</p>
Junio C Hamanof1f5a7b2013-06-11 22:23:52[diff] [blame]4617<div class="paragraph"><p>It is useful when you&#8217;re looking for an exact block of code (like a
4618struct), and want to know the history of that block since it first
4619came into being: use the feature iteratively to feed the interesting
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4620block in the preimage back into <code>-S</code>, and keep going until you get the
Junio C Hamanof1f5a7b2013-06-11 22:23:52[diff] [blame]4621very first version of the block.</p></div>
Junio C Hamanoace33e42019-01-18 23:16:05[diff] [blame]4622<div class="paragraph"><p>Binary files are searched as well.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4623</dd>
4624<dt class="hdlist1">
4625-G&lt;regex&gt;
4626</dt>
4627<dd>
4628<p>
Junio C Hamanof1f5a7b2013-06-11 22:23:52[diff] [blame]4629 Look for differences whose patch text contains added/removed
4630 lines that match &lt;regex&gt;.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4631</p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4632<div class="paragraph"><p>To illustrate the difference between <code>-S&lt;regex&gt; --pickaxe-regex</code> and
4633<code>-G&lt;regex&gt;</code>, consider a commit with the following diff in the same
Junio C Hamanof1f5a7b2013-06-11 22:23:52[diff] [blame]4634file:</p></div>
4635<div class="listingblock">
4636<div class="content">
Junio C Hamanob7e497f2020-02-12 21:41:37[diff] [blame]4637<pre><code>+ return frotz(nitfol, two-&gt;ptr, 1, 0);
Junio C Hamanof1f5a7b2013-06-11 22:23:52[diff] [blame]4638...
Junio C Hamanob7e497f2020-02-12 21:41:37[diff] [blame]4639- hit = frotz(nitfol, mf2.ptr, 1, 0);</code></pre>
Junio C Hamanof1f5a7b2013-06-11 22:23:52[diff] [blame]4640</div></div>
Junio C Hamanob7e497f2020-02-12 21:41:37[diff] [blame]4641<div class="paragraph"><p>While <code>git log -G"frotz\(nitfol"</code> will show this commit, <code>git log
4642-S"frotz\(nitfol" --pickaxe-regex</code> will not (because the number of
Junio C Hamanof1f5a7b2013-06-11 22:23:52[diff] [blame]4643occurrences of that string did not change).</p></div>
Junio C Hamanoace33e42019-01-18 23:16:05[diff] [blame]4644<div class="paragraph"><p>Unless <code>--text</code> is supplied patches of binary files without a textconv
4645filter will be ignored.</p></div>
Junio C Hamanof1f5a7b2013-06-11 22:23:52[diff] [blame]4646<div class="paragraph"><p>See the <em>pickaxe</em> entry in <a href="gitdiffcore.html">gitdiffcore(7)</a> for more
4647information.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4648</dd>
4649<dt class="hdlist1">
Junio C Hamano7b9cce92018-01-23 22:34:27[diff] [blame]4650--find-object=&lt;object-id&gt;
4651</dt>
4652<dd>
4653<p>
4654 Look for differences that change the number of occurrences of
4655 the specified object. Similar to <code>-S</code>, just the argument is different
4656 in that it doesn&#8217;t search for a specific string but for a specific
4657 object id.
4658</p>
4659<div class="paragraph"><p>The object can be a blob or a submodule commit. It implies the <code>-t</code> option in
4660<code>git-log</code> to also find trees.</p></div>
4661</dd>
4662<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4663--pickaxe-all
4664</dt>
4665<dd>
4666<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4667 When <code>-S</code> or <code>-G</code> finds a change, show all the changes in that
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4668 changeset, not just the files that contain the change
4669 in &lt;string&gt;.
4670</p>
4671</dd>
4672<dt class="hdlist1">
4673--pickaxe-regex
4674</dt>
4675<dd>
4676<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4677 Treat the &lt;string&gt; given to <code>-S</code> as an extended POSIX regular
Junio C Hamanof1f5a7b2013-06-11 22:23:52[diff] [blame]4678 expression to match.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4679</p>
4680</dd>
4681<dt class="hdlist1">
4682-O&lt;orderfile&gt;
4683</dt>
4684<dd>
4685<p>
Junio C Hamanobcd98f42017-01-24 00:12:16[diff] [blame]4686 Control the order in which files appear in the output.
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4687 This overrides the <code>diff.orderFile</code> configuration variable
4688 (see <a href="git-config.html">git-config(1)</a>). To cancel <code>diff.orderFile</code>,
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]4689 use <code>-O/dev/null</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4690</p>
Junio C Hamanobcd98f42017-01-24 00:12:16[diff] [blame]4691<div class="paragraph"><p>The output order is determined by the order of glob patterns in
4692&lt;orderfile&gt;.
4693All files with pathnames that match the first pattern are output
4694first, all files with pathnames that match the second pattern (but not
4695the first) are output next, and so on.
4696All files with pathnames that do not match any pattern are output
4697last, as if there was an implicit match-all pattern at the end of the
4698file.
4699If multiple pathnames have the same rank (they match the same pattern
4700but no earlier patterns), their output order relative to each other is
4701the normal order.</p></div>
4702<div class="paragraph"><p>&lt;orderfile&gt; is parsed as follows:</p></div>
4703<div class="openblock">
4704<div class="content">
4705<div class="ulist"><ul>
4706<li>
4707<p>
4708Blank lines are ignored, so they can be used as separators for
4709 readability.
4710</p>
4711</li>
4712<li>
4713<p>
4714Lines starting with a hash ("<code>#</code>") are ignored, so they can be used
4715 for comments. Add a backslash ("<code>\</code>") to the beginning of the
4716 pattern if it starts with a hash.
4717</p>
4718</li>
4719<li>
4720<p>
4721Each other line contains a single pattern.
4722</p>
4723</li>
4724</ul></div>
4725</div></div>
4726<div class="paragraph"><p>Patterns have the same syntax and semantics as patterns used for
Junio C Hamano96153bf2018-04-25 08:25:34[diff] [blame]4727fnmatch(3) without the FNM_PATHNAME flag, except a pathname also
Junio C Hamanobcd98f42017-01-24 00:12:16[diff] [blame]4728matches a pattern if removing any number of the final pathname
4729components matches the pattern. For example, the pattern "<code>foo*bar</code>"
4730matches "<code>fooasdfbar</code>" and "<code>foo/bar/baz/asdf</code>" but not "<code>foobarx</code>".</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4731</dd>
4732<dt class="hdlist1">
Junio C Hamanoa372d5b2021-02-26 01:34:37[diff] [blame]4733--skip-to=&lt;file&gt;
4734</dt>
4735<dt class="hdlist1">
4736--rotate-to=&lt;file&gt;
4737</dt>
4738<dd>
4739<p>
4740 Discard the files before the named &lt;file&gt; from the output
4741 (i.e. <em>skip to</em>), or move them to the end of the output
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]4742 (i.e. <em>rotate to</em>). These options were invented primarily for the use
Junio C Hamanoa372d5b2021-02-26 01:34:37[diff] [blame]4743 of the <code>git difftool</code> command, and may not be very useful
4744 otherwise.
4745</p>
4746</dd>
4747<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4748-R
4749</dt>
4750<dd>
4751<p>
4752 Swap two inputs; that is, show differences from index or
4753 on-disk file to tree contents.
4754</p>
4755</dd>
4756<dt class="hdlist1">
4757--relative[=&lt;path&gt;]
4758</dt>
Junio C Hamano3ef9e672020-06-02 21:51:31[diff] [blame]4759<dt class="hdlist1">
4760--no-relative
4761</dt>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4762<dd>
4763<p>
4764 When run from a subdirectory of the project, it can be
4765 told to exclude changes outside the directory and show
4766 pathnames relative to it with this option. When you are
4767 not in a subdirectory (e.g. in a bare repository), you
4768 can name which subdirectory to make the output relative
4769 to by giving a &lt;path&gt; as an argument.
Junio C Hamano3ef9e672020-06-02 21:51:31[diff] [blame]4770 <code>--no-relative</code> can be used to countermand both <code>diff.relative</code> config
4771 option and previous <code>--relative</code>.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4772</p>
4773</dd>
4774<dt class="hdlist1">
4775-a
4776</dt>
4777<dt class="hdlist1">
4778--text
4779</dt>
4780<dd>
4781<p>
4782 Treat all files as text.
4783</p>
4784</dd>
4785<dt class="hdlist1">
Junio C Hamano4886c772017-11-27 03:33:28[diff] [blame]4786--ignore-cr-at-eol
4787</dt>
4788<dd>
4789<p>
Junio C Hamano96153bf2018-04-25 08:25:34[diff] [blame]4790 Ignore carriage-return at the end of line when doing a comparison.
Junio C Hamano4886c772017-11-27 03:33:28[diff] [blame]4791</p>
4792</dd>
4793<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4794--ignore-space-at-eol
4795</dt>
4796<dd>
4797<p>
4798 Ignore changes in whitespace at EOL.
4799</p>
4800</dd>
4801<dt class="hdlist1">
4802-b
4803</dt>
4804<dt class="hdlist1">
4805--ignore-space-change
4806</dt>
4807<dd>
4808<p>
4809 Ignore changes in amount of whitespace. This ignores whitespace
4810 at line end, and considers all other sequences of one or
4811 more whitespace characters to be equivalent.
4812</p>
4813</dd>
4814<dt class="hdlist1">
4815-w
4816</dt>
4817<dt class="hdlist1">
4818--ignore-all-space
4819</dt>
4820<dd>
4821<p>
4822 Ignore whitespace when comparing lines. This ignores
4823 differences even if one line has whitespace where the other
4824 line has none.
4825</p>
4826</dd>
4827<dt class="hdlist1">
Junio C Hamanoa1952302013-07-01 21:31:18[diff] [blame]4828--ignore-blank-lines
4829</dt>
4830<dd>
4831<p>
4832 Ignore changes whose lines are all blank.
4833</p>
4834</dd>
4835<dt class="hdlist1">
Junio C Hamanodf3d3cd2020-11-02 22:05:05[diff] [blame]4836-I&lt;regex&gt;
4837</dt>
4838<dt class="hdlist1">
4839--ignore-matching-lines=&lt;regex&gt;
4840</dt>
4841<dd>
4842<p>
4843 Ignore changes whose all lines match &lt;regex&gt;. This option may
4844 be specified more than once.
4845</p>
4846</dd>
4847<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4848--inter-hunk-context=&lt;lines&gt;
4849</dt>
4850<dd>
4851<p>
4852 Show the context between diff hunks, up to the specified number
4853 of lines, thereby fusing hunks that are close to each other.
Junio C Hamanobcd98f42017-01-24 00:12:16[diff] [blame]4854 Defaults to <code>diff.interHunkContext</code> or 0 if the config option
4855 is unset.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4856</p>
4857</dd>
4858<dt class="hdlist1">
Junio C Hamano11821ed2011-10-19 18:42:09[diff] [blame]4859-W
4860</dt>
4861<dt class="hdlist1">
4862--function-context
4863</dt>
4864<dd>
4865<p>
Junio C Hamanob7676d52020-11-18 22:15:08[diff] [blame]4866 Show whole function as context lines for each change.
4867 The function names are determined in the same way as
4868 <code>git diff</code> works out patch hunk headers (see <em>Defining a
4869 custom hunk-header</em> in <a href="gitattributes.html">gitattributes(5)</a>).
Junio C Hamano11821ed2011-10-19 18:42:09[diff] [blame]4870</p>
4871</dd>
4872<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4873--ext-diff
4874</dt>
4875<dd>
4876<p>
4877 Allow an external diff helper to be executed. If you set an
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4878 external diff driver with <a href="gitattributes.html">gitattributes(5)</a>, you need
4879 to use this option with <a href="git-log.html">git-log(1)</a> and friends.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4880</p>
4881</dd>
4882<dt class="hdlist1">
4883--no-ext-diff
4884</dt>
4885<dd>
4886<p>
4887 Disallow external diff drivers.
4888</p>
4889</dd>
4890<dt class="hdlist1">
Junio C Hamanoc652aed2011-07-07 01:14:31[diff] [blame]4891--textconv
4892</dt>
4893<dt class="hdlist1">
4894--no-textconv
4895</dt>
4896<dd>
4897<p>
4898 Allow (or disallow) external text conversion filters to be run
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4899 when comparing binary files. See <a href="gitattributes.html">gitattributes(5)</a> for
Junio C Hamanoc652aed2011-07-07 01:14:31[diff] [blame]4900 details. Because textconv filters are typically a one-way
4901 conversion, the resulting diff is suitable for human
4902 consumption, but cannot be applied. For this reason, textconv
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4903 filters are enabled by default only for <a href="git-diff.html">git-diff(1)</a> and
4904 <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:31[diff] [blame]4905 diff plumbing commands.
4906</p>
4907</dd>
4908<dt class="hdlist1">
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4909--ignore-submodules[=&lt;when&gt;]
4910</dt>
4911<dd>
4912<p>
4913 Ignore changes to submodules in the diff generation. &lt;when&gt; can be
Junio C Hamanoc7102962013-05-29 23:57:17[diff] [blame]4914 either "none", "untracked", "dirty" or "all", which is the default.
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4915 Using "none" will consider the submodule modified when it either contains
4916 untracked or modified files or its HEAD differs from the commit recorded
4917 in the superproject and can be used to override any settings of the
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4918 <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:22[diff] [blame]4919 "untracked" is used submodules are not considered dirty when they only
4920 contain untracked content (but they are still scanned for modified
4921 content). Using "dirty" ignores all changes to the work tree of submodules,
4922 only changes to the commits stored in the superproject are shown (this was
4923 the behavior until 1.7.0). Using "all" hides all changes to submodules.
4924</p>
4925</dd>
4926<dt class="hdlist1">
4927--src-prefix=&lt;prefix&gt;
4928</dt>
4929<dd>
4930<p>
4931 Show the given source prefix instead of "a/".
4932</p>
4933</dd>
4934<dt class="hdlist1">
4935--dst-prefix=&lt;prefix&gt;
4936</dt>
4937<dd>
4938<p>
4939 Show the given destination prefix instead of "b/".
4940</p>
4941</dd>
4942<dt class="hdlist1">
4943--no-prefix
4944</dt>
4945<dd>
4946<p>
4947 Do not show any source or destination prefix.
4948</p>
4949</dd>
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]4950<dt class="hdlist1">
Junio C Hamano6d774cf2023-03-21 21:38:04[diff] [blame]4951--default-prefix
4952</dt>
4953<dd>
4954<p>
4955 Use the default source and destination prefixes ("a/" and "b/").
4956 This is usually the default already, but may be used to override
4957 config such as <code>diff.noprefix</code>.
4958</p>
4959</dd>
4960<dt class="hdlist1">
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]4961--line-prefix=&lt;prefix&gt;
4962</dt>
4963<dd>
4964<p>
4965 Prepend an additional prefix to every line of output.
4966</p>
4967</dd>
Junio C Hamanof7017f12016-10-27 23:31:34[diff] [blame]4968<dt class="hdlist1">
4969--ita-invisible-in-index
4970</dt>
4971<dd>
4972<p>
4973 By default entries added by "git add -N" appear as an existing
4974 empty file in "git diff" and a new file in "git diff --cached".
4975 This option makes the entry appear as a new file in "git diff"
4976 and non-existent in "git diff --cached". This option could be
4977 reverted with <code>--ita-visible-in-index</code>. Both options are
4978 experimental and could be removed in future.
4979</p>
4980</dd>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4981</dl></div>
4982<div class="paragraph"><p>For more detailed explanation on these common options, see also
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4983<a href="gitdiffcore.html">gitdiffcore(7)</a>.</p></div>
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]4984</div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]4985</div>
4986<div class="sect1">
Junio C Hamanoa75aada2023-01-22 01:54:30[diff] [blame]4987<h2 id="generate_patch_text_with_p">Generating patch text with -p</h2>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]4988<div class="sectionbody">
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]4989<div class="paragraph"><p>Running
4990<a href="git-diff.html">git-diff(1)</a>,
4991<a href="git-log.html">git-log(1)</a>,
4992<a href="git-show.html">git-show(1)</a>,
4993<a href="git-diff-index.html">git-diff-index(1)</a>,
4994<a href="git-diff-tree.html">git-diff-tree(1)</a>, or
4995<a href="git-diff-files.html">git-diff-files(1)</a>
4996with the <code>-p</code> option produces patch text.
4997You can customize the creation of patch text via the
Junio C Hamano558abd22020-09-03 20:22:34[diff] [blame]4998<code>GIT_EXTERNAL_DIFF</code> and the <code>GIT_DIFF_OPTS</code> environment variables
Junio C Hamanobe601db2021-05-07 04:20:28[diff] [blame]4999(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:59[diff] [blame]5000<div class="paragraph"><p>What the -p option produces is slightly different from the traditional
Junio C Hamano7f9fa862010-10-19 23:51:14[diff] [blame]5001diff format:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5002<div class="olist arabic"><ol class="arabic">
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5003<li>
5004<p>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5005It is preceded by a "git diff" header that looks like this:
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5006</p>
5007<div class="literalblock">
5008<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5009<pre><code>diff --git a/file1 b/file2</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5010</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5011<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:49[diff] [blame]5012involved. Especially, even for a creation or a deletion,
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5013<code>/dev/null</code> is <em>not</em> used in place of the <code>a/</code> or <code>b/</code> filenames.</p></div>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5014<div class="paragraph"><p>When a rename/copy is involved, <code>file1</code> and <code>file2</code> show the
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5015name of the source file of the rename/copy and the name of
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5016the file that the rename/copy produces, respectively.</p></div>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5017</li>
5018<li>
5019<p>
5020It is followed by one or more extended header lines:
5021</p>
5022<div class="literalblock">
5023<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5024<pre><code>old mode &lt;mode&gt;
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5025new mode &lt;mode&gt;
5026deleted file mode &lt;mode&gt;
5027new file mode &lt;mode&gt;
5028copy from &lt;path&gt;
5029copy to &lt;path&gt;
5030rename from &lt;path&gt;
5031rename to &lt;path&gt;
5032similarity index &lt;number&gt;
5033dissimilarity index &lt;number&gt;
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5034index &lt;hash&gt;..&lt;hash&gt; &lt;mode&gt;</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5035</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5036<div class="paragraph"><p>File modes are printed as 6-digit octal numbers including the file type
Junio C Hamano7f9fa862010-10-19 23:51:14[diff] [blame]5037and file permission bits.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5038<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:59[diff] [blame]5039<div class="paragraph"><p>The similarity index is the percentage of unchanged lines, and
Junio C Hamano7f9fa862010-10-19 23:51:14[diff] [blame]5040the dissimilarity index is the percentage of changed lines. It
5041is a rounded down integer, followed by a percent sign. The
5042similarity index value of 100% is thus reserved for two equal
5043files, while 100% dissimilarity means that no line from the old
5044file made it into the new one.</p></div>
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]5045<div class="paragraph"><p>The index line includes the blob object names before and after the change.
Junio C Hamano7f9fa862010-10-19 23:51:14[diff] [blame]5046The &lt;mode&gt; is included if the file mode does not change; otherwise,
5047separate lines indicate the old and the new mode.</p></div>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5048</li>
5049<li>
5050<p>
Junio C Hamano0f6f3bf2017-03-13 07:01:53[diff] [blame]5051Pathnames with "unusual" characters are quoted as explained for
5052 the configuration variable <code>core.quotePath</code> (see
5053 <a href="git-config.html">git-config(1)</a>).
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5054</p>
5055</li>
Junio C Hamano7f9fa862010-10-19 23:51:14[diff] [blame]5056<li>
5057<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5058All the <code>file1</code> files in the output refer to files before the
5059 commit, and all the <code>file2</code> files refer to files after the commit.
Junio C Hamano7f9fa862010-10-19 23:51:14[diff] [blame]5060 It is incorrect to apply each change to each file sequentially. For
5061 example, this patch will swap a and b:
5062</p>
5063<div class="literalblock">
5064<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5065<pre><code>diff --git a/a b/b
Junio C Hamano7f9fa862010-10-19 23:51:14[diff] [blame]5066rename from a
5067rename to b
5068diff --git a/b b/a
5069rename from b
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5070rename to a</code></pre>
Junio C Hamano7f9fa862010-10-19 23:51:14[diff] [blame]5071</div></div>
5072</li>
Junio C Hamanobe601db2021-05-07 04:20:28[diff] [blame]5073<li>
5074<p>
5075Hunk headers mention the name of the function to which the hunk
5076 applies. See "Defining a custom hunk-header" in
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5077 <a href="gitattributes.html">gitattributes(5)</a> for details of how to tailor this to
Junio C Hamanobe601db2021-05-07 04:20:28[diff] [blame]5078 specific languages.
5079</p>
5080</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5081</ol></div>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5082</div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]5083</div>
5084<div class="sect1">
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]5085<h2 id="_combined_diff_format">Combined diff format</h2>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5086<div class="sectionbody">
Junio C Hamano1dbca522015-05-22 20:48:55[diff] [blame]5087<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:43[diff] [blame]5088produce a <em>combined diff</em> when showing a merge. This is the default
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5089format when showing merges with <a href="git-diff.html">git-diff(1)</a> or
Junio C Hamano8c860d62021-02-06 01:37:47[diff] [blame]5090<a href="git-show.html">git-show(1)</a>. Note also that you can give suitable
5091<code>--diff-merges</code> option to any of these commands to force generation of
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5092diffs in a specific format.</p></div>
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]5093<div class="paragraph"><p>A "combined diff" format looks like this:</p></div>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5094<div class="listingblock">
5095<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5096<pre><code>diff --combined describe.c
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5097index fabadb8,cc95eb0..4866510
5098--- a/describe.c
5099+++ b/describe.c
5100@@@ -98,20 -98,12 +98,20 @@@
5101 return (a_date &gt; b_date) ? -1 : (a_date == b_date) ? 0 : 1;
5102 }
5103
5104- static void describe(char *arg)
5105 -static void describe(struct commit *cmit, int last_one)
5106++static void describe(char *arg, int last_one)
5107 {
5108 + unsigned char sha1[20];
5109 + struct commit *cmit;
5110 struct commit_list *list;
5111 static int initialized = 0;
5112 struct commit_name *n;
5113
5114 + if (get_sha1(arg, sha1) &lt; 0)
5115 + usage(describe_usage);
5116 + cmit = lookup_commit_reference(sha1);
5117 + if (!cmit)
5118 + usage(describe_usage);
5119 +
5120 if (!initialized) {
5121 initialized = 1;
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5122 for_each_ref(get_name);</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5123</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5124<div class="olist arabic"><ol class="arabic">
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5125<li>
5126<p>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5127It is preceded by a "git diff" header, that looks like
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]5128 this (when the <code>-c</code> option is used):
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5129</p>
5130<div class="literalblock">
5131<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5132<pre><code>diff --combined file</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5133</div></div>
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]5134<div class="paragraph"><p>or like this (when the <code>--cc</code> option is used):</p></div>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5135<div class="literalblock">
5136<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5137<pre><code>diff --cc file</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5138</div></div>
5139</li>
5140<li>
5141<p>
5142It is followed by one or more extended header lines
5143 (this example shows a merge with two parents):
5144</p>
5145<div class="literalblock">
5146<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5147<pre><code>index &lt;hash&gt;,&lt;hash&gt;..&lt;hash&gt;
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5148mode &lt;mode&gt;,&lt;mode&gt;..&lt;mode&gt;
5149new file mode &lt;mode&gt;
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5150deleted file mode &lt;mode&gt;,&lt;mode&gt;</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5151</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5152<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:49[diff] [blame]5153the &lt;mode&gt; is different from the rest. Extended headers with
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5154information about detected content movement (renames and
5155copying detection) are designed to work with the diff of two
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5156&lt;tree-ish&gt; and are not used by combined diff format.</p></div>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5157</li>
5158<li>
5159<p>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5160It is followed by a two-line from-file/to-file header:
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5161</p>
5162<div class="literalblock">
5163<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5164<pre><code>--- a/file
5165+++ b/file</code></pre>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5166</div></div>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5167<div class="paragraph"><p>Similar to the two-line header for the traditional <em>unified</em> diff
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5168format, <code>/dev/null</code> is used to signal created or deleted
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5169files.</p></div>
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]5170<div class="paragraph"><p>However, if the --combined-all-paths option is provided, instead of a
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5171two-line from-file/to-file, you get an N+1 line from-file/to-file header,
5172where N is the number of parents in the merge commit:</p></div>
Junio C Hamano11f15372019-03-07 03:17:00[diff] [blame]5173<div class="literalblock">
5174<div class="content">
5175<pre><code>--- a/file
5176--- a/file
5177--- a/file
5178+++ b/file</code></pre>
5179</div></div>
5180<div class="paragraph"><p>This extended format can be useful if rename or copy detection is
5181active, to allow you to see the original name of the file in different
5182parents.</p></div>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5183</li>
5184<li>
5185<p>
5186Chunk header format is modified to prevent people from
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5187 accidentally feeding it to <code>patch -p1</code>. Combined diff format
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5188 was created for review of merge commit changes, and was not
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]5189 meant to be applied. The change is similar to the change in the
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5190 extended <em>index</em> header:
5191</p>
5192<div class="literalblock">
5193<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5194<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:49[diff] [blame]5195</div></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5196<div class="paragraph"><p>There are (number of parents + 1) <code>@</code> characters in the chunk
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5197header for combined diff format.</p></div>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5198</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5199</ol></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5200<div class="paragraph"><p>Unlike the traditional <em>unified</em> diff format, which shows two
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5201files 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
5202added to B), or <code>" "</code> (space&#8201;&#8212;&#8201;unchanged) prefix, this format
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5203compares two or more files file1, file2,&#8230; with one file X, and
5204shows how X differs from each of fileN. One column for each of
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5205fileN is prepended to the output line to note how X&#8217;s line is
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5206different from it.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5207<div class="paragraph"><p>A <code>-</code> character in the column N means that the line appears in
5208fileN but it does not appear in the result. A <code>+</code> character
Junio C Hamano54bf1e22008-12-20 06:30:11[diff] [blame]5209in the column N means that the line appears in the result,
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5210and fileN does not have that line (in other words, the line was
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5211added, from the point of view of that parent).</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5212<div class="paragraph"><p>In the above example output, the function signature was changed
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5213from both files (hence two <code>-</code> removals from both file1 and
5214file2, plus <code>++</code> to mean one line that was added does not appear
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5215in either file1 or file2). Also, eight other lines are the same
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5216from file1 but do not appear in file2 (hence prefixed with <code>+</code>).</p></div>
5217<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:49[diff] [blame]5218merge commit with the merge result (i.e. file1..fileN are the
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5219parents). When shown by <code>git diff-files -c</code>, it compares the
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5220two unresolved merge parents with the working tree file
5221(i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5222"their version").</p></div>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]5223</div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]5224</div>
5225<div class="sect1">
Junio C Hamano58f587a2013-07-22 19:20:59[diff] [blame]5226<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]5227<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5228<div class="dlist"><dl>
5229<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5230<code>git log --no-merges</code>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]5231</dt>
5232<dd>
5233<p>
5234 Show the whole commit history, but skip any merges
5235</p>
5236</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5237<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5238<code>git log v2.6.12.. include/scsi drivers/scsi</code>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]5239</dt>
5240<dd>
5241<p>
5242 Show all commits since version <em>v2.6.12</em> that changed any file
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5243 in the <code>include/scsi</code> or <code>drivers/scsi</code> subdirectories
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]5244</p>
5245</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5246<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5247<code>git log --since="2 weeks ago" -- gitk</code>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]5248</dt>
5249<dd>
5250<p>
5251 Show the changes during the last two weeks to the file <em>gitk</em>.
Junio C Hamanoccb82522018-05-08 07:52:09[diff] [blame]5252 The <code>--</code> is necessary to avoid confusion with the <strong>branch</strong> named
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]5253 <em>gitk</em>
5254</p>
5255</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5256<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5257<code>git log --name-status release..test</code>
Junio C Hamanoba7c8d82006-04-15 06:17:42[diff] [blame]5258</dt>
5259<dd>
5260<p>
5261 Show the commits that are in the "test" branch but not yet
5262 in the "release" branch, along with the list of paths
5263 each commit modifies.
5264</p>
5265</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5266<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5267<code>git log --follow builtin/rev-list.c</code>
Junio C Hamano235d53f2007-07-13 00:25:15[diff] [blame]5268</dt>
5269<dd>
5270<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5271 Shows the commits that changed <code>builtin/rev-list.c</code>, including
Junio C Hamano235d53f2007-07-13 00:25:15[diff] [blame]5272 those commits that occurred before the file was given its
5273 present name.
5274</p>
5275</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5276<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5277<code>git log --branches --not --remotes=origin</code>
Junio C Hamano57827fb2010-01-23 03:02:50[diff] [blame]5278</dt>
5279<dd>
5280<p>
5281 Shows all commits that are in any of local branches but not in
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]5282 any of remote-tracking branches for <em>origin</em> (what you have that
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5283 origin doesn&#8217;t).
Junio C Hamano57827fb2010-01-23 03:02:50[diff] [blame]5284</p>
5285</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5286<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5287<code>git log master --not --remotes=*/master</code>
Junio C Hamano57827fb2010-01-23 03:02:50[diff] [blame]5288</dt>
5289<dd>
5290<p>
5291 Shows all commits that are in local master but not in any remote
5292 repository master branches.
5293</p>
5294</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5295<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5296<code>git log -p -m --first-parent</code>
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]5297</dt>
5298<dd>
5299<p>
5300 Shows the history including change diffs, but only from the
Junio C Hamanob73af6c2013-12-03 22:07:11[diff] [blame]5301 &#8220;main branch&#8221; perspective, skipping commits that come from merged
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]5302 branches, and showing full diffs of changes introduced by the merges.
5303 This makes sense only when following a strict policy of merging all
5304 topic branches when staying on a single integration branch.
5305</p>
5306</dd>
Junio C Hamano693e7092012-09-12 22:56:53[diff] [blame]5307<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5308<code>git log -L '/int main/',/^}/:main.c</code>
Junio C Hamano7e590a12013-06-02 23:46:52[diff] [blame]5309</dt>
5310<dd>
5311<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5312 Shows how the function <code>main()</code> in the file <code>main.c</code> evolved
Junio C Hamano7e590a12013-06-02 23:46:52[diff] [blame]5313 over time.
5314</p>
5315</dd>
5316<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5317<code>git log -3</code>
Junio C Hamano693e7092012-09-12 22:56:53[diff] [blame]5318</dt>
5319<dd>
5320<p>
5321 Limits the number of commits to show to 3.
5322</p>
5323</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5324</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]5325</div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]5326</div>
5327<div class="sect1">
Junio C Hamano58f587a2013-07-22 19:20:59[diff] [blame]5328<h2 id="_discussion">DISCUSSION</h2>
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5329<div class="sectionbody">
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]5330<div class="paragraph"><p>Git is to some extent character encoding agnostic.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5331<div class="ulist"><ul>
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5332<li>
5333<p>
Junio C Hamano54bf1e22008-12-20 06:30:11[diff] [blame]5334The contents of the blob objects are uninterpreted sequences
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5335 of bytes. There is no encoding translation at the core
5336 level.
5337</p>
5338</li>
5339<li>
5340<p>
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]5341Path names are encoded in UTF-8 normalization form C. This
5342 applies to tree objects, the index file, ref names, as well as
5343 path names in command line arguments, environment variables
5344 and config files (<code>.git/config</code> (see <a href="git-config.html">git-config(1)</a>),
5345 <a href="gitignore.html">gitignore(5)</a>, <a href="gitattributes.html">gitattributes(5)</a> and
5346 <a href="gitmodules.html">gitmodules(5)</a>).
5347</p>
5348<div class="paragraph"><p>Note that Git at the core level treats path names simply as
5349sequences of non-NUL bytes, there are no path name encoding
5350conversions (except on Mac and Windows). Therefore, using
5351non-ASCII path names will mostly work even on platforms and file
5352systems that use legacy extended ASCII encodings. However,
5353repositories created on such systems will not work properly on
5354UTF-8-based systems (e.g. Linux, Mac, Windows) and vice versa.
5355Additionally, many Git-based tools simply assume path names to
5356be UTF-8 and will fail to display other encodings correctly.</p></div>
5357</li>
5358<li>
5359<p>
5360Commit log messages are typically encoded in UTF-8, but other
5361 extended ASCII encodings are also supported. This includes
5362 ISO-8859-x, CP125x and many others, but <em>not</em> UTF-16/32,
5363 EBCDIC and CJK multi-byte encodings (GBK, Shift-JIS, Big5,
5364 EUC-x, CP9xx etc.).
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5365</p>
5366</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5367</ul></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5368<div class="paragraph"><p>Although we encourage that the commit log messages are encoded
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]5369in UTF-8, both the core and Git Porcelain are designed not to
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5370force UTF-8 on projects. If all participants of a particular
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]5371project find it more convenient to use legacy encodings, Git
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5372does not forbid it. However, there are a few things to keep in
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5373mind.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5374<div class="olist arabic"><ol class="arabic">
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5375<li>
5376<p>
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5377<em>git commit</em> and <em>git commit-tree</em> issue
Junio C Hamano14b76482008-01-05 10:32:26[diff] [blame]5378 a warning if the commit log message given to it does not look
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5379 like a valid UTF-8 string, unless you explicitly say your
5380 project uses a legacy encoding. The way to say this is to
Junio C Hamanoa372d5b2021-02-26 01:34:37[diff] [blame]5381 have <code>i18n.commitEncoding</code> in <code>.git/config</code> file, like this:
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5382</p>
5383<div class="listingblock">
5384<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5385<pre><code>[i18n]
Junio C Hamanobb34c102017-07-21 22:42:28[diff] [blame]5386 commitEncoding = ISO-8859-1</code></pre>
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5387</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5388<div class="paragraph"><p>Commit objects created with the above setting record the value
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5389of <code>i18n.commitEncoding</code> in their <code>encoding</code> header. This is to
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5390help other people who look at them later. Lack of this header
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5391implies that the commit log message is encoded in UTF-8.</p></div>
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5392</li>
5393<li>
5394<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]5395<em>git log</em>, <em>git show</em>, <em>git blame</em> and friends look at the
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5396 <code>encoding</code> header of a commit object, and try to re-code the
Junio C Hamanoaa17c7c2008-11-03 04:36:58[diff] [blame]5397 log message into UTF-8 unless otherwise specified. You can
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5398 specify the desired output encoding with
Junio C Hamanobb34c102017-07-21 22:42:28[diff] [blame]5399 <code>i18n.logOutputEncoding</code> in <code>.git/config</code> file, like this:
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5400</p>
5401<div class="listingblock">
5402<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5403<pre><code>[i18n]
Junio C Hamanobb34c102017-07-21 22:42:28[diff] [blame]5404 logOutputEncoding = ISO-8859-1</code></pre>
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5405</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5406<div class="paragraph"><p>If you do not have this configuration variable, the value of
Junio C Hamanobb34c102017-07-21 22:42:28[diff] [blame]5407<code>i18n.commitEncoding</code> is used instead.</p></div>
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5408</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5409</ol></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5410<div class="paragraph"><p>Note that we deliberately chose not to re-code the commit log
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5411message when a commit is made to force UTF-8 at the commit
5412object level, because re-coding to UTF-8 is not necessarily a
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5413reversible operation.</p></div>
Junio C Hamano775a0f42006-12-31 01:19:14[diff] [blame]5414</div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]5415</div>
5416<div class="sect1">
Junio C Hamano58f587a2013-07-22 19:20:59[diff] [blame]5417<h2 id="_configuration">CONFIGURATION</h2>
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5418<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5419<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:10[diff] [blame]5420for settings related to diff generation.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5421<div class="dlist"><dl>
5422<dt class="hdlist1">
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5423format.pretty
5424</dt>
5425<dd>
5426<p>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5427 Default for the <code>--format</code> option. (See <em>Pretty Formats</em> above.)
5428 Defaults to <code>medium</code>.
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5429</p>
5430</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5431<dt class="hdlist1">
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5432i18n.logOutputEncoding
5433</dt>
5434<dd>
5435<p>
Junio C Hamanob73af6c2013-12-03 22:07:11[diff] [blame]5436 Encoding to use when displaying logs. (See <em>Discussion</em> above.)
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]5437 Defaults to the value of <code>i18n.commitEncoding</code> if set, and UTF-8
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5438 otherwise.
5439</p>
5440</dd>
Junio C Hamanoba8baee2022-09-14 20:25:23[diff] [blame]5441</dl></div>
5442<div class="paragraph"><p>Everything above this line in this section isn&#8217;t included from the
5443<a href="git-config.html">git-config(1)</a> documentation. The content that follows is the
5444same as what&#8217;s found there:</p></div>
5445<div class="dlist"><dl>
5446<dt class="hdlist1">
5447log.abbrevCommit
5448</dt>
5449<dd>
5450<p>
5451 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
5452 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
5453 override this option with <code>--no-abbrev-commit</code>.
5454</p>
5455</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5456<dt class="hdlist1">
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5457log.date
5458</dt>
5459<dd>
5460<p>
Junio C Hamanoba8baee2022-09-14 20:25:23[diff] [blame]5461 Set the default date-time mode for the <em>log</em> command.
5462 Setting a value for log.date is similar to using <em>git log</em>'s
5463 <code>--date</code> option. See <a href="git-log.html">git-log(1)</a> for details.
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5464</p>
Junio C Hamano23168ef2019-02-07 07:20:47[diff] [blame]5465<div class="paragraph"><p>If the format is set to "auto:foo" and the pager is in use, format
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5466"foo" will be used for the date format. Otherwise, "default" will
Junio C Hamano23168ef2019-02-07 07:20:47[diff] [blame]5467be used.</p></div>
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5468</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5469<dt class="hdlist1">
Junio C Hamanoba8baee2022-09-14 20:25:23[diff] [blame]5470log.decorate
5471</dt>
5472<dd>
5473<p>
5474 Print out the ref names of any commits that are shown by the log
5475 command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
5476 <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
5477 specified, the full ref name (including prefix) will be printed.
5478 If <em>auto</em> is specified, then if the output is going to a terminal,
5479 the ref names are shown as if <em>short</em> were given, otherwise no ref
5480 names are shown. This is the same as the <code>--decorate</code> option
5481 of the <code>git log</code>.
5482</p>
5483</dd>
5484<dt class="hdlist1">
5485log.initialDecorationSet
5486</dt>
5487<dd>
5488<p>
5489 By default, <code>git log</code> only shows decorations for certain known ref
5490 namespaces. If <em>all</em> is specified, then show all refs as
5491 decorations.
5492</p>
5493</dd>
5494<dt class="hdlist1">
5495log.excludeDecoration
5496</dt>
5497<dd>
5498<p>
5499 Exclude the specified patterns from the log decorations. This is
5500 similar to the <code>--decorate-refs-exclude</code> command-line option, but
5501 the config option can be overridden by the <code>--decorate-refs</code>
5502 option.
5503</p>
5504</dd>
5505<dt class="hdlist1">
5506log.diffMerges
5507</dt>
5508<dd>
5509<p>
Junio C Hamano53cd02b2022-10-10 21:42:31[diff] [blame]5510 Set diff format to be used when <code>--diff-merges=on</code> is
5511 specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
5512 details. Defaults to <code>separate</code>.
Junio C Hamanoba8baee2022-09-14 20:25:23[diff] [blame]5513</p>
5514</dd>
5515<dt class="hdlist1">
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]5516log.follow
5517</dt>
5518<dd>
5519<p>
Junio C Hamanob0a1e832015-10-15 23:08:31[diff] [blame]5520 If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
5521 a single &lt;path&gt; is given. This has the same limitations as <code>--follow</code>,
5522 i.e. it cannot be used to follow multiple files and does not work well
5523 on non-linear history.
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]5524</p>
5525</dd>
5526<dt class="hdlist1">
Junio C Hamanoba8baee2022-09-14 20:25:23[diff] [blame]5527log.graphColors
5528</dt>
5529<dd>
5530<p>
5531 A list of colors, separated by commas, that can be used to draw
5532 history lines in <code>git log --graph</code>.
5533</p>
5534</dd>
5535<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]5536log.showRoot
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5537</dt>
5538<dd>
5539<p>
Junio C Hamanoba8baee2022-09-14 20:25:23[diff] [blame]5540 If true, the initial commit will be shown as a big creation event.
5541 This is equivalent to a diff against an empty tree.
5542 Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
5543 normally hide the root commit will now show it. True by default.
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5544</p>
5545</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5546<dt class="hdlist1">
Junio C Hamano48931e22016-07-11 20:08:47[diff] [blame]5547log.showSignature
5548</dt>
5549<dd>
5550<p>
Junio C Hamanoba8baee2022-09-14 20:25:23[diff] [blame]5551 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
5552 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.
Junio C Hamano48931e22016-07-11 20:08:47[diff] [blame]5553</p>
5554</dd>
5555<dt class="hdlist1">
Junio C Hamanoba8baee2022-09-14 20:25:23[diff] [blame]5556log.mailmap
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5557</dt>
5558<dd>
5559<p>
Junio C Hamanoba8baee2022-09-14 20:25:23[diff] [blame]5560 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
5561 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
5562 assume <code>--no-use-mailmap</code>. True by default.
5563</p>
5564</dd>
5565<dt class="hdlist1">
5566notes.mergeStrategy
5567</dt>
5568<dd>
5569<p>
5570 Which merge strategy to choose by default when resolving notes
5571 conflicts. Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
Junio C Hamano33be8212023-10-23 21:45:54[diff] [blame]5572 <code>cat_sort_uniq</code>. Defaults to <code>manual</code>. See the "NOTES MERGE STRATEGIES"
Junio C Hamanoba8baee2022-09-14 20:25:23[diff] [blame]5573 section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
5574</p>
5575<div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
5576<a href="git-notes.html">git-notes(1)</a>.</p></div>
5577</dd>
5578<dt class="hdlist1">
5579notes.&lt;name&gt;.mergeStrategy
5580</dt>
5581<dd>
5582<p>
5583 Which merge strategy to choose when doing a notes merge into
5584 refs/notes/&lt;name&gt;. This overrides the more general
5585 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
5586 <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5587</p>
5588</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5589<dt class="hdlist1">
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5590notes.displayRef
5591</dt>
5592<dd>
5593<p>
Junio C Hamanoba8baee2022-09-14 20:25:23[diff] [blame]5594 Which ref (or refs, if a glob or specified more than once), in
5595 addition to the default set by <code>core.notesRef</code> or
5596 <code>GIT_NOTES_REF</code>, to read notes from when showing commit
5597 messages with the <em>git log</em> family of commands.
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5598</p>
Junio C Hamanoba8baee2022-09-14 20:25:23[diff] [blame]5599<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
5600environment variable, which must be a colon separated list of refs or
5601globs.</p></div>
5602<div class="paragraph"><p>A warning will be issued for refs that do not exist,
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5603but a glob that does not match any refs is silently ignored.</p></div>
Junio C Hamanoba8baee2022-09-14 20:25:23[diff] [blame]5604<div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
5605log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
5606those commands.</p></div>
5607<div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
5608GIT_NOTES_REF) is also implicitly added to the list of refs to be
5609displayed.</p></div>
5610</dd>
5611<dt class="hdlist1">
5612notes.rewrite.&lt;command&gt;
5613</dt>
5614<dd>
5615<p>
5616 When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
5617 <code>rebase</code>), if this variable is <code>false</code>, git will not copy
5618 notes from the original to the rewritten commit. Defaults to
5619 <code>true</code>. See also "<code>notes.rewriteRef</code>" below.
5620</p>
5621<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
5622environment variable, which must be a colon separated list of refs or
5623globs.</p></div>
5624</dd>
5625<dt class="hdlist1">
5626notes.rewriteMode
5627</dt>
5628<dd>
5629<p>
5630 When copying notes during a rewrite (see the
5631 "notes.rewrite.&lt;command&gt;" option), determines what to do if
5632 the target commit already has a note. Must be one of
5633 <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
5634 Defaults to <code>concatenate</code>.
5635</p>
5636<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
5637environment variable.</p></div>
5638</dd>
5639<dt class="hdlist1">
5640notes.rewriteRef
5641</dt>
5642<dd>
5643<p>
5644 When copying notes during a rewrite, specifies the (fully
5645 qualified) ref whose notes should be copied. May be a glob,
5646 in which case notes in all matching refs will be copied. You
5647 may also specify this configuration several times.
5648</p>
5649<div class="paragraph"><p>Does not have a default value; you must configure this variable to
5650enable note rewriting. Set it to <code>refs/notes/commits</code> to enable
5651rewriting for the default commit notes.</p></div>
5652<div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
5653See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p></div>
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]5654</dd>
5655</dl></div>
5656</div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]5657</div>
5658<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]5659<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]5660<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5661<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]5662</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]5663</div>
Junio C Hamano9629d4f2012-12-19 00:28:27[diff] [blame]5664</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]5665<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]5666<div id="footer">
5667<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:53[diff] [blame]5668Last updated
Junio C Hamano9c919c72023-12-10 01:43:11[diff] [blame]5669 2023-10-23 14:43:46 PDT
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]5670</div>
5671</div>
5672</body>
5673</html>