git-show.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6 <meta name="generator" content="AsciiDoc 8.4.5" />
   7 <title>git-show(1)</title>
   8 <style type="text/css">
   9 /* Debug borders */
  10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  11 /*
  12   border: 1px solid red;
  13 */
  14 }
  15
  16 body {
  17   margin: 1em 5% 1em 5%;
  18 }
  19
  20 a {
  21   color: blue;
  22   text-decoration: underline;
  23 }
  24 a:visited {
  25   color: fuchsia;
  26 }
  27
  28 em {
  29   font-style: italic;
  30   color: navy;
  31 }
  32
  33 strong {
  34   font-weight: bold;
  35   color: #083194;
  36 }
  37
  38 tt {
  39   color: navy;
  40 }
  41
  42 h1, h2, h3, h4, h5, h6 {
  43   color: #527bbd;
  44   font-family: sans-serif;
  45   margin-top: 1.2em;
  46   margin-bottom: 0.5em;
  47   line-height: 1.3;
  48 }
  49
  50 h1, h2, h3 {
  51   border-bottom: 2px solid silver;
  52 }
  53 h2 {
  54   padding-top: 0.5em;
  55 }
  56 h3 {
  57   float: left;
  58 }
  59 h3 + * {
  60   clear: left;
  61 }
  62
  63 div.sectionbody {
  64   font-family: serif;
  65   margin-left: 0;
  66 }
  67
  68 hr {
  69   border: 1px solid silver;
  70 }
  71
  72 p {
  73   margin-top: 0.5em;
  74   margin-bottom: 0.5em;
  75 }
  76
  77 ul, ol, li > p {
  78   margin-top: 0;
  79 }
  80
  81 pre {
  82   padding: 0;
  83   margin: 0;
  84 }
  85
  86 span#author {
  87   color: #527bbd;
  88   font-family: sans-serif;
  89   font-weight: bold;
  90   font-size: 1.1em;
  91 }
  92 span#email {
  93 }
  94 span#revnumber, span#revdate, span#revremark {
  95   font-family: sans-serif;
  96 }
  97
  98 div#footer {
  99   font-family: sans-serif;
 100   font-size: small;
 101   border-top: 2px solid silver;
 102   padding-top: 0.5em;
 103   margin-top: 4.0em;
 104 }
 105 div#footer-text {
 106   float: left;
 107   padding-bottom: 0.5em;
 108 }
 109 div#footer-badges {
 110   float: right;
 111   padding-bottom: 0.5em;
 112 }
 113
 114 div#preamble {
 115   margin-top: 1.5em;
 116   margin-bottom: 1.5em;
 117 }
 118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 120 div.admonitionblock {
 121   margin-top: 1.5em;
 122   margin-bottom: 1.5em;
 123 }
 124 div.admonitionblock {
 125   margin-top: 2.5em;
 126   margin-bottom: 2.5em;
 127 }
 128
 129 div.content { /* Block element content. */
 130   padding: 0;
 131 }
 132
 133 /* Block element titles. */
 134 div.title, caption.title {
 135   color: #527bbd;
 136   font-family: sans-serif;
 137   font-weight: bold;
 138   text-align: left;
 139   margin-top: 1.0em;
 140   margin-bottom: 0.5em;
 141 }
 142 div.title + * {
 143   margin-top: 0;
 144 }
 145
 146 td div.title:first-child {
 147   margin-top: 0.0em;
 148 }
 149 div.content div.title:first-child {
 150   margin-top: 0.0em;
 151 }
 152 div.content + div.title {
 153   margin-top: 0.0em;
 154 }
 155
 156 div.sidebarblock > div.content {
 157   background: #ffffee;
 158   border: 1px solid silver;
 159   padding: 0.5em;
 160 }
 161
 162 div.listingblock > div.content {
 163   border: 1px solid silver;
 164   background: #f4f4f4;
 165   padding: 0.5em;
 166 }
 167
 168 div.quoteblock {
 169   padding-left: 2.0em;
 170   margin-right: 10%;
 171 }
 172 div.quoteblock > div.attribution {
 173   padding-top: 0.5em;
 174   text-align: right;
 175 }
 176
 177 div.verseblock {
 178   padding-left: 2.0em;
 179   margin-right: 10%;
 180 }
 181 div.verseblock > div.content {
 182   white-space: pre;
 183 }
 184 div.verseblock > div.attribution {
 185   padding-top: 0.75em;
 186   text-align: left;
 187 }
 188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 189 div.verseblock + div.attribution {
 190   text-align: left;
 191 }
 192
 193 div.admonitionblock .icon {
 194   vertical-align: top;
 195   font-size: 1.1em;
 196   font-weight: bold;
 197   text-decoration: underline;
 198   color: #527bbd;
 199   padding-right: 0.5em;
 200 }
 201 div.admonitionblock td.content {
 202   padding-left: 0.5em;
 203   border-left: 2px solid silver;
 204 }
 205
 206 div.exampleblock > div.content {
 207   border-left: 2px solid silver;
 208   padding: 0.5em;
 209 }
 210
 211 div.imageblock div.content { padding-left: 0; }
 212 span.image img { border-style: none; }
 213 a.image:visited { color: white; }
 214
 215 dl {
 216   margin-top: 0.8em;
 217   margin-bottom: 0.8em;
 218 }
 219 dt {
 220   margin-top: 0.5em;
 221   margin-bottom: 0;
 222   font-style: normal;
 223   color: navy;
 224 }
 225 dd > *:first-child {
 226   margin-top: 0.1em;
 227 }
 228
 229 ul, ol {
 230     list-style-position: outside;
 231 }
 232 ol.arabic {
 233   list-style-type: decimal;
 234 }
 235 ol.loweralpha {
 236   list-style-type: lower-alpha;
 237 }
 238 ol.upperalpha {
 239   list-style-type: upper-alpha;
 240 }
 241 ol.lowerroman {
 242   list-style-type: lower-roman;
 243 }
 244 ol.upperroman {
 245   list-style-type: upper-roman;
 246 }
 247
 248 div.compact ul, div.compact ol,
 249 div.compact p, div.compact p,
 250 div.compact div, div.compact div {
 251   margin-top: 0.1em;
 252   margin-bottom: 0.1em;
 253 }
 254
 255 div.tableblock > table {
 256   border: 3px solid #527bbd;
 257 }
 258 thead {
 259   font-family: sans-serif;
 260   font-weight: bold;
 261 }
 262 tfoot {
 263   font-weight: bold;
 264 }
 265 td > div.verse {
 266   white-space: pre;
 267 }
 268 p.table {
 269   margin-top: 0;
 270 }
 271 /* Because the table frame attribute is overriden by CSS in most browsers. */
 272 div.tableblock > table[frame="void"] {
 273   border-style: none;
 274 }
 275 div.tableblock > table[frame="hsides"] {
 276   border-left-style: none;
 277   border-right-style: none;
 278 }
 279 div.tableblock > table[frame="vsides"] {
 280   border-top-style: none;
 281   border-bottom-style: none;
 282 }
 283
 284
 285 div.hdlist {
 286   margin-top: 0.8em;
 287   margin-bottom: 0.8em;
 288 }
 289 div.hdlist tr {
 290   padding-bottom: 15px;
 291 }
 292 dt.hdlist1.strong, td.hdlist1.strong {
 293   font-weight: bold;
 294 }
 295 td.hdlist1 {
 296   vertical-align: top;
 297   font-style: normal;
 298   padding-right: 0.8em;
 299   color: navy;
 300 }
 301 td.hdlist2 {
 302   vertical-align: top;
 303 }
 304 div.hdlist.compact tr {
 305   margin: 0;
 306   padding-bottom: 0;
 307 }
 308
 309 .comment {
 310   background: yellow;
 311 }
 312
 313 @media print {
 314   div#footer-badges { display: none; }
 315 }
 316
 317 div#toctitle {
 318   color: #527bbd;
 319   font-family: sans-serif;
 320   font-size: 1.1em;
 321   font-weight: bold;
 322   margin-top: 1.0em;
 323   margin-bottom: 0.1em;
 324 }
 325
 326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 327   margin-top: 0;
 328   margin-bottom: 0;
 329 }
 330 div.toclevel2 {
 331   margin-left: 2em;
 332   font-size: 0.9em;
 333 }
 334 div.toclevel3 {
 335   margin-left: 4em;
 336   font-size: 0.9em;
 337 }
 338 div.toclevel4 {
 339   margin-left: 6em;
 340   font-size: 0.9em;
 341 }
 342 /* Overrides for manpage documents */
 343 h1 {
 344   padding-top: 0.5em;
 345   padding-bottom: 0.5em;
 346   border-top: 2px solid silver;
 347   border-bottom: 2px solid silver;
 348 }
 349 h2 {
 350   border-style: none;
 351 }
 352 div.sectionbody {
 353   margin-left: 5%;
 354 }
 355
 356 @media print {
 357   div#toc { display: none; }
 358 }
 359
 360 /* Workarounds for IE6's broken and incomplete CSS2. */
 361
 362 div.sidebar-content {
 363   background: #ffffee;
 364   border: 1px solid silver;
 365   padding: 0.5em;
 366 }
 367 div.sidebar-title, div.image-title {
 368   color: #527bbd;
 369   font-family: sans-serif;
 370   font-weight: bold;
 371   margin-top: 0.0em;
 372   margin-bottom: 0.5em;
 373 }
 374
 375 div.listingblock div.content {
 376   border: 1px solid silver;
 377   background: #f4f4f4;
 378   padding: 0.5em;
 379 }
 380
 381 div.quoteblock-attribution {
 382   padding-top: 0.5em;
 383   text-align: right;
 384 }
 385
 386 div.verseblock-content {
 387   white-space: pre;
 388 }
 389 div.verseblock-attribution {
 390   padding-top: 0.75em;
 391   text-align: left;
 392 }
 393
 394 div.exampleblock-content {
 395   border-left: 2px solid silver;
 396   padding-left: 0.5em;
 397 }
 398
 399 /* IE6 sets dynamically generated links as visited. */
 400 div#toc a:visited { color: blue; }
 401 </style>
 402 </head>
 403 <body>
 404 <div id="header">
 405 <h1>
 406 git-show(1) Manual Page
 407 </h1>
 408 <h2>NAME</h2>
 409 <div class="sectionbody">
 410 <p>git-show -
 411    Show various types of objects
 412 </p>
 413 </div>
 414 </div>
 415 <h2 id="_synopsis">SYNOPSIS</h2>
 416 <div class="sectionbody">
 417 <div class="paragraph"><p><em>git show</em> [options] &lt;object&gt;&#8230;</p></div>
 418 </div>
 419 <h2 id="_description">DESCRIPTION</h2>
 420 <div class="sectionbody">
 421 <div class="paragraph"><p>Shows one or more objects (blobs, trees, tags and commits).</p></div>
 422 <div class="paragraph"><p>For commits it shows the log message and textual diff. It also
 423 presents the merge commit in a special format as produced by
 424 <em>git diff-tree --cc</em>.</p></div>
 425 <div class="paragraph"><p>For tags, it shows the tag message and the referenced objects.</p></div>
 426 <div class="paragraph"><p>For trees, it shows the names (equivalent to <em>git ls-tree</em>
 427 with --name-only).</p></div>
 428 <div class="paragraph"><p>For plain blobs, it shows the plain contents.</p></div>
 429 <div class="paragraph"><p>The command takes options applicable to the <em>git diff-tree</em> command to
 430 control how the changes the commit introduces are shown.</p></div>
 431 <div class="paragraph"><p>This manual page describes only the most frequently used options.</p></div>
 432 </div>
 433 <h2 id="_options">OPTIONS</h2>
 434 <div class="sectionbody">
 435 <div class="dlist"><dl>
 436 <dt class="hdlist1">
 437 &lt;object&gt;&#8230;
 438 </dt>
 439 <dd>
 440 <p>
 441         The names of objects to show.
 442         For a more complete list of ways to spell object names, see
 443         "SPECIFYING REVISIONS" section in <a href="gitrevisions.html">gitrevisions(7)</a>.
 444 </p>
 445 </dd>
 446 <dt class="hdlist1">
 447 --pretty[=&lt;format&gt;]
 448 </dt>
 449 <dt class="hdlist1">
 450 --format=&lt;format&gt;
 451 </dt>
 452 <dd>
 453 <p>
 454         Pretty-print the contents of the commit logs in a given format,
 455         where <em>&lt;format&gt;</em> can be one of <em>oneline</em>, <em>short</em>, <em>medium</em>,
 456         <em>full</em>, <em>fuller</em>, <em>email</em>, <em>raw</em> and <em>format:&lt;string&gt;</em>.  See
 457         the "PRETTY FORMATS" section for some additional details for each
 458         format.  When omitted, the format defaults to <em>medium</em>.
 459 </p>
 460 <div class="paragraph"><p>Note: you can specify the default pretty format in the repository
 461 configuration (see <a href="git-config.html">git-config(1)</a>).</p></div>
 462 </dd>
 463 <dt class="hdlist1">
 464 --abbrev-commit
 465 </dt>
 466 <dd>
 467 <p>
 468         Instead of showing the full 40-byte hexadecimal commit object
 469         name, show only a partial prefix.  Non default number of
 470         digits can be specified with "--abbrev=&lt;n&gt;" (which also modifies
 471         diff output, if it is displayed).
 472 </p>
 473 <div class="paragraph"><p>This should make "--pretty=oneline" a whole lot more readable for
 474 people using 80-column terminals.</p></div>
 475 </dd>
 476 <dt class="hdlist1">
 477 --no-abbrev-commit
 478 </dt>
 479 <dd>
 480 <p>
 481         Show the full 40-byte hexadecimal commit object name. This negates
 482         <tt>--abbrev-commit</tt> and those options which imply it such as
 483         "--oneline". It also overrides the <em>log.abbrevCommit</em> variable.
 484 </p>
 485 </dd>
 486 <dt class="hdlist1">
 487 --oneline
 488 </dt>
 489 <dd>
 490 <p>
 491         This is a shorthand for "--pretty=oneline --abbrev-commit"
 492         used together.
 493 </p>
 494 </dd>
 495 <dt class="hdlist1">
 496 --encoding[=&lt;encoding&gt;]
 497 </dt>
 498 <dd>
 499 <p>
 500         The commit objects record the encoding used for the log message
 501         in their encoding header; this option can be used to tell the
 502         command to re-code the commit log message in the encoding
 503         preferred by the user.  For non plumbing commands this
 504         defaults to UTF-8.
 505 </p>
 506 </dd>
 507 <dt class="hdlist1">
 508 --notes[=&lt;ref&gt;]
 509 </dt>
 510 <dd>
 511 <p>
 512         Show the notes (see <a href="git-notes.html">git-notes(1)</a>) that annotate the
 513         commit, when showing the commit log message.  This is the default
 514         for <tt>git log</tt>, <tt>git show</tt> and <tt>git whatchanged</tt> commands when
 515         there is no <tt>--pretty</tt>, <tt>--format</tt> nor <tt>--oneline</tt> option given
 516         on the command line.
 517 </p>
 518 <div class="paragraph"><p>By default, the notes shown are from the notes refs listed in the
 519 <em>core.notesRef</em> and <em>notes.displayRef</em> variables (or corresponding
 520 environment overrides). See <a href="git-config.html">git-config(1)</a> for more details.</p></div>
 521 <div class="paragraph"><p>With an optional <em>&lt;ref&gt;</em> argument, show this notes ref instead of the
 522 default notes ref(s). The ref is taken to be in <tt>refs/notes/</tt> if it
 523 is not qualified.</p></div>
 524 <div class="paragraph"><p>Multiple --notes options can be combined to control which notes are
 525 being displayed. Examples: "--notes=foo" will show only notes from
 526 "refs/notes/foo"; "--notes=foo --notes" will show both notes from
 527 "refs/notes/foo" and from the default notes ref(s).</p></div>
 528 </dd>
 529 <dt class="hdlist1">
 530 --no-notes
 531 </dt>
 532 <dd>
 533 <p>
 534         Do not show notes. This negates the above <tt>--notes</tt> option, by
 535         resetting the list of notes refs from which notes are shown.
 536         Options are parsed in the order given on the command line, so e.g.
 537         "--notes --notes=foo --no-notes --notes=bar" will only show notes
 538         from "refs/notes/bar".
 539 </p>
 540 </dd>
 541 <dt class="hdlist1">
 542 --show-notes[=&lt;ref&gt;]
 543 </dt>
 544 <dt class="hdlist1">
 545 --[no-]standard-notes
 546 </dt>
 547 <dd>
 548 <p>
 549         These options are deprecated. Use the above --notes/--no-notes
 550         options instead.
 551 </p>
 552 </dd>
 553 </dl></div>
 554 </div>
 555 <h2 id="_pretty_formats">PRETTY FORMATS</h2>
 556 <div class="sectionbody">
 557 <div class="paragraph"><p>If the commit is a merge, and if the pretty-format
 558 is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is
 559 inserted before the <em>Author:</em> line.  This line begins with
 560 "Merge: " and the sha1s of ancestral commits are printed,
 561 separated by spaces.  Note that the listed commits may not
 562 necessarily be the list of the <strong>direct</strong> parent commits if you
 563 have limited your view of history: for example, if you are
 564 only interested in changes related to a certain directory or
 565 file.</p></div>
 566 <div class="paragraph"><p>There are several built-in formats, and you can define
 567 additional formats by setting a pretty.&lt;name&gt;
 568 config option to either another format name, or a
 569 <em>format:</em> string, as described below (see
 570 <a href="git-config.html">git-config(1)</a>). Here are the details of the
 571 built-in formats:</p></div>
 572 <div class="ulist"><ul>
 573 <li>
 574 <p>
 575 <em>oneline</em>
 576 </p>
 577 <div class="literalblock">
 578 <div class="content">
 579 <pre><tt>&lt;sha1&gt; &lt;title line&gt;</tt></pre>
 580 </div></div>
 581 <div class="paragraph"><p>This is designed to be as compact as possible.</p></div>
 582 </li>
 583 <li>
 584 <p>
 585 <em>short</em>
 586 </p>
 587 <div class="literalblock">
 588 <div class="content">
 589 <pre><tt>commit &lt;sha1&gt;
 590 Author: &lt;author&gt;</tt></pre>
 591 </div></div>
 592 <div class="literalblock">
 593 <div class="content">
 594 <pre><tt>&lt;title line&gt;</tt></pre>
 595 </div></div>
 596 </li>
 597 <li>
 598 <p>
 599 <em>medium</em>
 600 </p>
 601 <div class="literalblock">
 602 <div class="content">
 603 <pre><tt>commit &lt;sha1&gt;
 604 Author: &lt;author&gt;
 605 Date:   &lt;author date&gt;</tt></pre>
 606 </div></div>
 607 <div class="literalblock">
 608 <div class="content">
 609 <pre><tt>&lt;title line&gt;</tt></pre>
 610 </div></div>
 611 <div class="literalblock">
 612 <div class="content">
 613 <pre><tt>&lt;full commit message&gt;</tt></pre>
 614 </div></div>
 615 </li>
 616 <li>
 617 <p>
 618 <em>full</em>
 619 </p>
 620 <div class="literalblock">
 621 <div class="content">
 622 <pre><tt>commit &lt;sha1&gt;
 623 Author: &lt;author&gt;
 624 Commit: &lt;committer&gt;</tt></pre>
 625 </div></div>
 626 <div class="literalblock">
 627 <div class="content">
 628 <pre><tt>&lt;title line&gt;</tt></pre>
 629 </div></div>
 630 <div class="literalblock">
 631 <div class="content">
 632 <pre><tt>&lt;full commit message&gt;</tt></pre>
 633 </div></div>
 634 </li>
 635 <li>
 636 <p>
 637 <em>fuller</em>
 638 </p>
 639 <div class="literalblock">
 640 <div class="content">
 641 <pre><tt>commit &lt;sha1&gt;
 642 Author:     &lt;author&gt;
 643 AuthorDate: &lt;author date&gt;
 644 Commit:     &lt;committer&gt;
 645 CommitDate: &lt;committer date&gt;</tt></pre>
 646 </div></div>
 647 <div class="literalblock">
 648 <div class="content">
 649 <pre><tt>&lt;title line&gt;</tt></pre>
 650 </div></div>
 651 <div class="literalblock">
 652 <div class="content">
 653 <pre><tt>&lt;full commit message&gt;</tt></pre>
 654 </div></div>
 655 </li>
 656 <li>
 657 <p>
 658 <em>email</em>
 659 </p>
 660 <div class="literalblock">
 661 <div class="content">
 662 <pre><tt>From &lt;sha1&gt; &lt;date&gt;
 663 From: &lt;author&gt;
 664 Date: &lt;author date&gt;
 665 Subject: [PATCH] &lt;title line&gt;</tt></pre>
 666 </div></div>
 667 <div class="literalblock">
 668 <div class="content">
 669 <pre><tt>&lt;full commit message&gt;</tt></pre>
 670 </div></div>
 671 </li>
 672 <li>
 673 <p>
 674 <em>raw</em>
 675 </p>
 676 <div class="paragraph"><p>The <em>raw</em> format shows the entire commit exactly as
 677 stored in the commit object.  Notably, the SHA1s are
 678 displayed in full, regardless of whether --abbrev or
 679 --no-abbrev are used, and <em>parents</em> information show the
 680 true parent commits, without taking grafts nor history
 681 simplification into account.</p></div>
 682 </li>
 683 <li>
 684 <p>
 685 <em>format:&lt;string&gt;</em>
 686 </p>
 687 <div class="paragraph"><p>The <em>format:&lt;string&gt;</em> format allows you to specify which information
 688 you want to show. It works a little bit like printf format,
 689 with the notable exception that you get a newline with <em>%n</em>
 690 instead of <em>\n</em>.</p></div>
 691 <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>
 692 would show something like this:</p></div>
 693 <div class="listingblock">
 694 <div class="content">
 695 <pre><tt>The author of fe6e0ee was Junio C Hamano, 23 hours ago
 696 The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;</tt></pre>
 697 </div></div>
 698 <div class="paragraph"><p>The placeholders are:</p></div>
 699 <div class="ulist"><ul>
 700 <li>
 701 <p>
 702 <em>%H</em>: commit hash
 703 </p>
 704 </li>
 705 <li>
 706 <p>
 707 <em>%h</em>: abbreviated commit hash
 708 </p>
 709 </li>
 710 <li>
 711 <p>
 712 <em>%T</em>: tree hash
 713 </p>
 714 </li>
 715 <li>
 716 <p>
 717 <em>%t</em>: abbreviated tree hash
 718 </p>
 719 </li>
 720 <li>
 721 <p>
 722 <em>%P</em>: parent hashes
 723 </p>
 724 </li>
 725 <li>
 726 <p>
 727 <em>%p</em>: abbreviated parent hashes
 728 </p>
 729 </li>
 730 <li>
 731 <p>
 732 <em>%an</em>: author name
 733 </p>
 734 </li>
 735 <li>
 736 <p>
 737 <em>%aN</em>: author name (respecting .mailmap, see <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
 738 </p>
 739 </li>
 740 <li>
 741 <p>
 742 <em>%ae</em>: author email
 743 </p>
 744 </li>
 745 <li>
 746 <p>
 747 <em>%aE</em>: author email (respecting .mailmap, see <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
 748 </p>
 749 </li>
 750 <li>
 751 <p>
 752 <em>%ad</em>: author date (format respects --date= option)
 753 </p>
 754 </li>
 755 <li>
 756 <p>
 757 <em>%aD</em>: author date, RFC2822 style
 758 </p>
 759 </li>
 760 <li>
 761 <p>
 762 <em>%ar</em>: author date, relative
 763 </p>
 764 </li>
 765 <li>
 766 <p>
 767 <em>%at</em>: author date, UNIX timestamp
 768 </p>
 769 </li>
 770 <li>
 771 <p>
 772 <em>%ai</em>: author date, ISO 8601 format
 773 </p>
 774 </li>
 775 <li>
 776 <p>
 777 <em>%cn</em>: committer name
 778 </p>
 779 </li>
 780 <li>
 781 <p>
 782 <em>%cN</em>: committer name (respecting .mailmap, see <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
 783 </p>
 784 </li>
 785 <li>
 786 <p>
 787 <em>%ce</em>: committer email
 788 </p>
 789 </li>
 790 <li>
 791 <p>
 792 <em>%cE</em>: committer email (respecting .mailmap, see <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
 793 </p>
 794 </li>
 795 <li>
 796 <p>
 797 <em>%cd</em>: committer date
 798 </p>
 799 </li>
 800 <li>
 801 <p>
 802 <em>%cD</em>: committer date, RFC2822 style
 803 </p>
 804 </li>
 805 <li>
 806 <p>
 807 <em>%cr</em>: committer date, relative
 808 </p>
 809 </li>
 810 <li>
 811 <p>
 812 <em>%ct</em>: committer date, UNIX timestamp
 813 </p>
 814 </li>
 815 <li>
 816 <p>
 817 <em>%ci</em>: committer date, ISO 8601 format
 818 </p>
 819 </li>
 820 <li>
 821 <p>
 822 <em>%d</em>: ref names, like the --decorate option of <a href="git-log.html">git-log(1)</a>
 823 </p>
 824 </li>
 825 <li>
 826 <p>
 827 <em>%e</em>: encoding
 828 </p>
 829 </li>
 830 <li>
 831 <p>
 832 <em>%s</em>: subject
 833 </p>
 834 </li>
 835 <li>
 836 <p>
 837 <em>%f</em>: sanitized subject line, suitable for a filename
 838 </p>
 839 </li>
 840 <li>
 841 <p>
 842 <em>%b</em>: body
 843 </p>
 844 </li>
 845 <li>
 846 <p>
 847 <em>%B</em>: raw body (unwrapped subject and body)
 848 </p>
 849 </li>
 850 <li>
 851 <p>
 852 <em>%N</em>: commit notes
 853 </p>
 854 </li>
 855 <li>
 856 <p>
 857 <em>%gD</em>: reflog selector, e.g., <tt>refs/stash@{1}</tt>
 858 </p>
 859 </li>
 860 <li>
 861 <p>
 862 <em>%gd</em>: shortened reflog selector, e.g., <tt>stash@{1}</tt>
 863 </p>
 864 </li>
 865 <li>
 866 <p>
 867 <em>%gs</em>: reflog subject
 868 </p>
 869 </li>
 870 <li>
 871 <p>
 872 <em>%Cred</em>: switch color to red
 873 </p>
 874 </li>
 875 <li>
 876 <p>
 877 <em>%Cgreen</em>: switch color to green
 878 </p>
 879 </li>
 880 <li>
 881 <p>
 882 <em>%Cblue</em>: switch color to blue
 883 </p>
 884 </li>
 885 <li>
 886 <p>
 887 <em>%Creset</em>: reset color
 888 </p>
 889 </li>
 890 <li>
 891 <p>
 892 <em>%C(&#8230;)</em>: color specification, as described in color.branch.* config option
 893 </p>
 894 </li>
 895 <li>
 896 <p>
 897 <em>%m</em>: left, right or boundary mark
 898 </p>
 899 </li>
 900 <li>
 901 <p>
 902 <em>%n</em>: newline
 903 </p>
 904 </li>
 905 <li>
 906 <p>
 907 <em>%%</em>: a raw <em>%</em>
 908 </p>
 909 </li>
 910 <li>
 911 <p>
 912 <em>%x00</em>: print a byte from a hex code
 913 </p>
 914 </li>
 915 <li>
 916 <p>
 917 <em>%w([&lt;w&gt;[,&lt;i1&gt;[,&lt;i2&gt;]]])</em>: switch line wrapping, like the -w option of
 918   <a href="git-shortlog.html">git-shortlog(1)</a>.
 919 </p>
 920 </li>
 921 </ul></div>
 922 </li>
 923 </ul></div>
 924 <div class="admonitionblock">
 925 <table><tr>
 926 <td class="icon">
 927 <div class="title">Note</div>
 928 </td>
 929 <td class="content">Some placeholders may depend on other options given to the
 930 revision traversal engine. For example, the <tt>%g*</tt> reflog options will
 931 insert an empty string unless we are traversing reflog entries (e.g., by
 932 <tt>git log -g</tt>). The <tt>%d</tt> placeholder will use the "short" decoration
 933 format if <tt>--decorate</tt> was not already provided on the command line.</td>
 934 </tr></table>
 935 </div>
 936 <div class="paragraph"><p>If you add a <tt>&#43;</tt> (plus sign) after <em>%</em> of a placeholder, a line-feed
 937 is inserted immediately before the expansion if and only if the
 938 placeholder expands to a non-empty string.</p></div>
 939 <div class="paragraph"><p>If you add a <tt>-</tt> (minus sign) after <em>%</em> of a placeholder, line-feeds that
 940 immediately precede the expansion are deleted if and only if the
 941 placeholder expands to an empty string.</p></div>
 942 <div class="paragraph"><p>If you add a ` ` (space) after <em>%</em> of a placeholder, a space
 943 is inserted immediately before the expansion if and only if the
 944 placeholder expands to a non-empty string.</p></div>
 945 <div class="ulist"><ul>
 946 <li>
 947 <p>
 948 <em>tformat:</em>
 949 </p>
 950 <div class="paragraph"><p>The <em>tformat:</em> format works exactly like <em>format:</em>, except that it
 951 provides "terminator" semantics instead of "separator" semantics. In
 952 other words, each commit has the message terminator character (usually a
 953 newline) appended, rather than a separator placed between entries.
 954 This means that the final entry of a single-line format will be properly
 955 terminated with a new line, just as the "oneline" format does.
 956 For example:</p></div>
 957 <div class="listingblock">
 958 <div class="content">
 959 <pre><tt>$ git log -2 --pretty=format:%h 4da45bef \
 960   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 961 4da45be
 962 7134973 -- NO NEWLINE
 963
 964 $ git log -2 --pretty=tformat:%h 4da45bef \
 965   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 966 4da45be
 967 7134973</tt></pre>
 968 </div></div>
 969 <div class="paragraph"><p>In addition, any unrecognized string that has a <tt>%</tt> in it is interpreted
 970 as if it has <tt>tformat:</tt> in front of it.  For example, these two are
 971 equivalent:</p></div>
 972 <div class="listingblock">
 973 <div class="content">
 974 <pre><tt>$ git log -2 --pretty=tformat:%h 4da45bef
 975 $ git log -2 --pretty=%h 4da45bef</tt></pre>
 976 </div></div>
 977 </li>
 978 </ul></div>
 979 </div>
 980 <h2 id="_examples">EXAMPLES</h2>
 981 <div class="sectionbody">
 982 <div class="dlist"><dl>
 983 <dt class="hdlist1">
 984 git show v1.0.0
 985 </dt>
 986 <dd>
 987 <p>
 988         Shows the tag <tt>v1.0.0</tt>, along with the object the tags
 989         points at.
 990 </p>
 991 </dd>
 992 <dt class="hdlist1">
 993 git show v1.0.0^{tree}
 994 </dt>
 995 <dd>
 996 <p>
 997         Shows the tree pointed to by the tag <tt>v1.0.0</tt>.
 998 </p>
 999 </dd>
1000 <dt class="hdlist1">
1001 git show -s --format=%s v1.0.0^{commit}
1002 </dt>
1003 <dd>
1004 <p>
1005         Shows the subject of the commit pointed to by the
1006         tag <tt>v1.0.0</tt>.
1007 </p>
1008 </dd>
1009 <dt class="hdlist1">
1010 git show next~10:Documentation/README
1011 </dt>
1012 <dd>
1013 <p>
1014         Shows the contents of the file <tt>Documentation/README</tt> as
1015         they were current in the 10th last commit of the branch
1016         <tt>next</tt>.
1017 </p>
1018 </dd>
1019 <dt class="hdlist1">
1020 git show master:Makefile master:t/Makefile
1021 </dt>
1022 <dd>
1023 <p>
1024         Concatenates the contents of said Makefiles in the head
1025         of the branch <tt>master</tt>.
1026 </p>
1027 </dd>
1028 </dl></div>
1029 </div>
1030 <h2 id="_discussion">Discussion</h2>
1031 <div class="sectionbody">
1032 <div class="paragraph"><p>At the core level, git is character encoding agnostic.</p></div>
1033 <div class="ulist"><ul>
1034 <li>
1035 <p>
1036 The pathnames recorded in the index and in the tree objects
1037    are treated as uninterpreted sequences of non-NUL bytes.
1038    What readdir(2) returns are what are recorded and compared
1039    with the data git keeps track of, which in turn are expected
1040    to be what lstat(2) and creat(2) accepts.  There is no such
1041    thing as pathname encoding translation.
1042 </p>
1043 </li>
1044 <li>
1045 <p>
1046 The contents of the blob objects are uninterpreted sequences
1047    of bytes.  There is no encoding translation at the core
1048    level.
1049 </p>
1050 </li>
1051 <li>
1052 <p>
1053 The commit log messages are uninterpreted sequences of non-NUL
1054    bytes.
1055 </p>
1056 </li>
1057 </ul></div>
1058 <div class="paragraph"><p>Although we encourage that the commit log messages are encoded
1059 in UTF-8, both the core and git Porcelain are designed not to
1060 force UTF-8 on projects.  If all participants of a particular
1061 project find it more convenient to use legacy encodings, git
1062 does not forbid it.  However, there are a few things to keep in
1063 mind.</p></div>
1064 <div class="olist arabic"><ol class="arabic">
1065 <li>
1066 <p>
1067 <em>git commit</em> and <em>git commit-tree</em> issues
1068   a warning if the commit log message given to it does not look
1069   like a valid UTF-8 string, unless you explicitly say your
1070   project uses a legacy encoding.  The way to say this is to
1071   have i18n.commitencoding in <tt>.git/config</tt> file, like this:
1072 </p>
1073 <div class="listingblock">
1074 <div class="content">
1075 <pre><tt>[i18n]
1076         commitencoding = ISO-8859-1</tt></pre>
1077 </div></div>
1078 <div class="paragraph"><p>Commit objects created with the above setting record the value
1079 of <tt>i18n.commitencoding</tt> in its <tt>encoding</tt> header.  This is to
1080 help other people who look at them later.  Lack of this header
1081 implies that the commit log message is encoded in UTF-8.</p></div>
1082 </li>
1083 <li>
1084 <p>
1085 <em>git log</em>, <em>git show</em>, <em>git blame</em> and friends look at the
1086   <tt>encoding</tt> header of a commit object, and try to re-code the
1087   log message into UTF-8 unless otherwise specified.  You can
1088   specify the desired output encoding with
1089   <tt>i18n.logoutputencoding</tt> in <tt>.git/config</tt> file, like this:
1090 </p>
1091 <div class="listingblock">
1092 <div class="content">
1093 <pre><tt>[i18n]
1094         logoutputencoding = ISO-8859-1</tt></pre>
1095 </div></div>
1096 <div class="paragraph"><p>If you do not have this configuration variable, the value of
1097 <tt>i18n.commitencoding</tt> is used instead.</p></div>
1098 </li>
1099 </ol></div>
1100 <div class="paragraph"><p>Note that we deliberately chose not to re-code the commit log
1101 message when a commit is made to force UTF-8 at the commit
1102 object level, because re-coding to UTF-8 is not necessarily a
1103 reversible operation.</p></div>
1104 </div>
1105 <h2 id="_git">GIT</h2>
1106 <div class="sectionbody">
1107 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1108 </div>
1109 <div id="footer">
1110 <div id="footer-text">
1111 Last updated 2011-03-15 23:30:14 UTC
1112 </div>
1113 </div>
1114 </body>
1115 </html>