Autogenerated HTML docs for v1.7.4-rc2-20-g8c0db6
[git/jnareb-git.git] / git-show.html
blobff5f253d316a7654c5b4ab4bf972be4a9b8a95d4
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 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
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;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
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;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
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;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
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;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
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;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
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;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
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;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
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;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
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;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
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>
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>
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>
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 --oneline
478 </dt>
479 <dd>
481 This is a shorthand for "--pretty=oneline --abbrev-commit"
482 used together.
483 </p>
484 </dd>
485 <dt class="hdlist1">
486 --encoding[=&lt;encoding&gt;]
487 </dt>
488 <dd>
490 The commit objects record the encoding used for the log message
491 in their encoding header; this option can be used to tell the
492 command to re-code the commit log message in the encoding
493 preferred by the user. For non plumbing commands this
494 defaults to UTF-8.
495 </p>
496 </dd>
497 <dt class="hdlist1">
498 --no-notes
499 </dt>
500 <dt class="hdlist1">
501 --show-notes[=&lt;ref&gt;]
502 </dt>
503 <dd>
505 Show the notes (see <a href="git-notes.html">git-notes(1)</a>) that annotate the
506 commit, when showing the commit log message. This is the default
507 for <tt>git log</tt>, <tt>git show</tt> and <tt>git whatchanged</tt> commands when
508 there is no <tt>--pretty</tt>, <tt>--format</tt> nor <tt>--oneline</tt> option is
509 given on the command line.
510 </p>
511 <div class="paragraph"><p>With an optional argument, add this ref to the list of notes. The ref
512 is taken to be in <tt>refs/notes/</tt> if it is not qualified.</p></div>
513 </dd>
514 <dt class="hdlist1">
515 --[no-]standard-notes
516 </dt>
517 <dd>
519 Enable or disable populating the notes ref list from the
520 <em>core.notesRef</em> and <em>notes.displayRef</em> variables (or
521 corresponding environment overrides). Enabled by default.
522 See <a href="git-config.html">git-config(1)</a>.
523 </p>
524 </dd>
525 </dl></div>
526 </div>
527 <h2 id="_pretty_formats">PRETTY FORMATS</h2>
528 <div class="sectionbody">
529 <div class="paragraph"><p>If the commit is a merge, and if the pretty-format
530 is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is
531 inserted before the <em>Author:</em> line. This line begins with
532 "Merge: " and the sha1s of ancestral commits are printed,
533 separated by spaces. Note that the listed commits may not
534 necessarily be the list of the <strong>direct</strong> parent commits if you
535 have limited your view of history: for example, if you are
536 only interested in changes related to a certain directory or
537 file.</p></div>
538 <div class="paragraph"><p>There are several built-in formats, and you can define
539 additional formats by setting a pretty.&lt;name&gt;
540 config option to either another format name, or a
541 <em>format:</em> string, as described below (see
542 <a href="git-config.html">git-config(1)</a>). Here are the details of the
543 built-in formats:</p></div>
544 <div class="ulist"><ul>
545 <li>
547 <em>oneline</em>
548 </p>
549 <div class="literalblock">
550 <div class="content">
551 <pre><tt>&lt;sha1&gt; &lt;title line&gt;</tt></pre>
552 </div></div>
553 <div class="paragraph"><p>This is designed to be as compact as possible.</p></div>
554 </li>
555 <li>
557 <em>short</em>
558 </p>
559 <div class="literalblock">
560 <div class="content">
561 <pre><tt>commit &lt;sha1&gt;
562 Author: &lt;author&gt;</tt></pre>
563 </div></div>
564 <div class="literalblock">
565 <div class="content">
566 <pre><tt>&lt;title line&gt;</tt></pre>
567 </div></div>
568 </li>
569 <li>
571 <em>medium</em>
572 </p>
573 <div class="literalblock">
574 <div class="content">
575 <pre><tt>commit &lt;sha1&gt;
576 Author: &lt;author&gt;
577 Date: &lt;author date&gt;</tt></pre>
578 </div></div>
579 <div class="literalblock">
580 <div class="content">
581 <pre><tt>&lt;title line&gt;</tt></pre>
582 </div></div>
583 <div class="literalblock">
584 <div class="content">
585 <pre><tt>&lt;full commit message&gt;</tt></pre>
586 </div></div>
587 </li>
588 <li>
590 <em>full</em>
591 </p>
592 <div class="literalblock">
593 <div class="content">
594 <pre><tt>commit &lt;sha1&gt;
595 Author: &lt;author&gt;
596 Commit: &lt;committer&gt;</tt></pre>
597 </div></div>
598 <div class="literalblock">
599 <div class="content">
600 <pre><tt>&lt;title line&gt;</tt></pre>
601 </div></div>
602 <div class="literalblock">
603 <div class="content">
604 <pre><tt>&lt;full commit message&gt;</tt></pre>
605 </div></div>
606 </li>
607 <li>
609 <em>fuller</em>
610 </p>
611 <div class="literalblock">
612 <div class="content">
613 <pre><tt>commit &lt;sha1&gt;
614 Author: &lt;author&gt;
615 AuthorDate: &lt;author date&gt;
616 Commit: &lt;committer&gt;
617 CommitDate: &lt;committer date&gt;</tt></pre>
618 </div></div>
619 <div class="literalblock">
620 <div class="content">
621 <pre><tt>&lt;title line&gt;</tt></pre>
622 </div></div>
623 <div class="literalblock">
624 <div class="content">
625 <pre><tt>&lt;full commit message&gt;</tt></pre>
626 </div></div>
627 </li>
628 <li>
630 <em>email</em>
631 </p>
632 <div class="literalblock">
633 <div class="content">
634 <pre><tt>From &lt;sha1&gt; &lt;date&gt;
635 From: &lt;author&gt;
636 Date: &lt;author date&gt;
637 Subject: [PATCH] &lt;title line&gt;</tt></pre>
638 </div></div>
639 <div class="literalblock">
640 <div class="content">
641 <pre><tt>&lt;full commit message&gt;</tt></pre>
642 </div></div>
643 </li>
644 <li>
646 <em>raw</em>
647 </p>
648 <div class="paragraph"><p>The <em>raw</em> format shows the entire commit exactly as
649 stored in the commit object. Notably, the SHA1s are
650 displayed in full, regardless of whether --abbrev or
651 --no-abbrev are used, and <em>parents</em> information show the
652 true parent commits, without taking grafts nor history
653 simplification into account.</p></div>
654 </li>
655 <li>
657 <em>format:&lt;string&gt;</em>
658 </p>
659 <div class="paragraph"><p>The <em>format:&lt;string&gt;</em> format allows you to specify which information
660 you want to show. It works a little bit like printf format,
661 with the notable exception that you get a newline with <em>%n</em>
662 instead of <em>\n</em>.</p></div>
663 <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>
664 would show something like this:</p></div>
665 <div class="listingblock">
666 <div class="content">
667 <pre><tt>The author of fe6e0ee was Junio C Hamano, 23 hours ago
668 The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;</tt></pre>
669 </div></div>
670 <div class="paragraph"><p>The placeholders are:</p></div>
671 <div class="ulist"><ul>
672 <li>
674 <em>%H</em>: commit hash
675 </p>
676 </li>
677 <li>
679 <em>%h</em>: abbreviated commit hash
680 </p>
681 </li>
682 <li>
684 <em>%T</em>: tree hash
685 </p>
686 </li>
687 <li>
689 <em>%t</em>: abbreviated tree hash
690 </p>
691 </li>
692 <li>
694 <em>%P</em>: parent hashes
695 </p>
696 </li>
697 <li>
699 <em>%p</em>: abbreviated parent hashes
700 </p>
701 </li>
702 <li>
704 <em>%an</em>: author name
705 </p>
706 </li>
707 <li>
709 <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>)
710 </p>
711 </li>
712 <li>
714 <em>%ae</em>: author email
715 </p>
716 </li>
717 <li>
719 <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>)
720 </p>
721 </li>
722 <li>
724 <em>%ad</em>: author date (format respects --date= option)
725 </p>
726 </li>
727 <li>
729 <em>%aD</em>: author date, RFC2822 style
730 </p>
731 </li>
732 <li>
734 <em>%ar</em>: author date, relative
735 </p>
736 </li>
737 <li>
739 <em>%at</em>: author date, UNIX timestamp
740 </p>
741 </li>
742 <li>
744 <em>%ai</em>: author date, ISO 8601 format
745 </p>
746 </li>
747 <li>
749 <em>%cn</em>: committer name
750 </p>
751 </li>
752 <li>
754 <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>)
755 </p>
756 </li>
757 <li>
759 <em>%ce</em>: committer email
760 </p>
761 </li>
762 <li>
764 <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>)
765 </p>
766 </li>
767 <li>
769 <em>%cd</em>: committer date
770 </p>
771 </li>
772 <li>
774 <em>%cD</em>: committer date, RFC2822 style
775 </p>
776 </li>
777 <li>
779 <em>%cr</em>: committer date, relative
780 </p>
781 </li>
782 <li>
784 <em>%ct</em>: committer date, UNIX timestamp
785 </p>
786 </li>
787 <li>
789 <em>%ci</em>: committer date, ISO 8601 format
790 </p>
791 </li>
792 <li>
794 <em>%d</em>: ref names, like the --decorate option of <a href="git-log.html">git-log(1)</a>
795 </p>
796 </li>
797 <li>
799 <em>%e</em>: encoding
800 </p>
801 </li>
802 <li>
804 <em>%s</em>: subject
805 </p>
806 </li>
807 <li>
809 <em>%f</em>: sanitized subject line, suitable for a filename
810 </p>
811 </li>
812 <li>
814 <em>%b</em>: body
815 </p>
816 </li>
817 <li>
819 <em>%B</em>: raw body (unwrapped subject and body)
820 </p>
821 </li>
822 <li>
824 <em>%N</em>: commit notes
825 </p>
826 </li>
827 <li>
829 <em>%gD</em>: reflog selector, e.g., <tt>refs/stash@{1}</tt>
830 </p>
831 </li>
832 <li>
834 <em>%gd</em>: shortened reflog selector, e.g., <tt>stash@{1}</tt>
835 </p>
836 </li>
837 <li>
839 <em>%gs</em>: reflog subject
840 </p>
841 </li>
842 <li>
844 <em>%Cred</em>: switch color to red
845 </p>
846 </li>
847 <li>
849 <em>%Cgreen</em>: switch color to green
850 </p>
851 </li>
852 <li>
854 <em>%Cblue</em>: switch color to blue
855 </p>
856 </li>
857 <li>
859 <em>%Creset</em>: reset color
860 </p>
861 </li>
862 <li>
864 <em>%C(&#8230;)</em>: color specification, as described in color.branch.* config option
865 </p>
866 </li>
867 <li>
869 <em>%m</em>: left, right or boundary mark
870 </p>
871 </li>
872 <li>
874 <em>%n</em>: newline
875 </p>
876 </li>
877 <li>
879 <em>%%</em>: a raw <em>%</em>
880 </p>
881 </li>
882 <li>
884 <em>%x00</em>: print a byte from a hex code
885 </p>
886 </li>
887 <li>
889 <em>%w([&lt;w&gt;[,&lt;i1&gt;[,&lt;i2&gt;]]])</em>: switch line wrapping, like the -w option of
890 <a href="git-shortlog.html">git-shortlog(1)</a>.
891 </p>
892 </li>
893 </ul></div>
894 </li>
895 </ul></div>
896 <div class="admonitionblock">
897 <table><tr>
898 <td class="icon">
899 <div class="title">Note</div>
900 </td>
901 <td class="content">Some placeholders may depend on other options given to the
902 revision traversal engine. For example, the <tt>%g*</tt> reflog options will
903 insert an empty string unless we are traversing reflog entries (e.g., by
904 <tt>git log -g</tt>). The <tt>%d</tt> placeholder will use the "short" decoration
905 format if <tt>--decorate</tt> was not already provided on the command line.</td>
906 </tr></table>
907 </div>
908 <div class="paragraph"><p>If you add a <tt>&#43;</tt> (plus sign) after <em>%</em> of a placeholder, a line-feed
909 is inserted immediately before the expansion if and only if the
910 placeholder expands to a non-empty string.</p></div>
911 <div class="paragraph"><p>If you add a <tt>-</tt> (minus sign) after <em>%</em> of a placeholder, line-feeds that
912 immediately precede the expansion are deleted if and only if the
913 placeholder expands to an empty string.</p></div>
914 <div class="paragraph"><p>If you add a ` ` (space) after <em>%</em> of a placeholder, a space
915 is inserted immediately before the expansion if and only if the
916 placeholder expands to a non-empty string.</p></div>
917 <div class="ulist"><ul>
918 <li>
920 <em>tformat:</em>
921 </p>
922 <div class="paragraph"><p>The <em>tformat:</em> format works exactly like <em>format:</em>, except that it
923 provides "terminator" semantics instead of "separator" semantics. In
924 other words, each commit has the message terminator character (usually a
925 newline) appended, rather than a separator placed between entries.
926 This means that the final entry of a single-line format will be properly
927 terminated with a new line, just as the "oneline" format does.
928 For example:</p></div>
929 <div class="listingblock">
930 <div class="content">
931 <pre><tt>$ git log -2 --pretty=format:%h 4da45bef \
932 | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
933 4da45be
934 7134973 -- NO NEWLINE
936 $ git log -2 --pretty=tformat:%h 4da45bef \
937 | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
938 4da45be
939 7134973</tt></pre>
940 </div></div>
941 <div class="paragraph"><p>In addition, any unrecognized string that has a <tt>%</tt> in it is interpreted
942 as if it has <tt>tformat:</tt> in front of it. For example, these two are
943 equivalent:</p></div>
944 <div class="listingblock">
945 <div class="content">
946 <pre><tt>$ git log -2 --pretty=tformat:%h 4da45bef
947 $ git log -2 --pretty=%h 4da45bef</tt></pre>
948 </div></div>
949 </li>
950 </ul></div>
951 </div>
952 <h2 id="_examples">EXAMPLES</h2>
953 <div class="sectionbody">
954 <div class="dlist"><dl>
955 <dt class="hdlist1">
956 git show v1.0.0
957 </dt>
958 <dd>
960 Shows the tag <tt>v1.0.0</tt>, along with the object the tags
961 points at.
962 </p>
963 </dd>
964 <dt class="hdlist1">
965 git show v1.0.0^{tree}
966 </dt>
967 <dd>
969 Shows the tree pointed to by the tag <tt>v1.0.0</tt>.
970 </p>
971 </dd>
972 <dt class="hdlist1">
973 git show -s --format=%s v1.0.0^{commit}
974 </dt>
975 <dd>
977 Shows the subject of the commit pointed to by the
978 tag <tt>v1.0.0</tt>.
979 </p>
980 </dd>
981 <dt class="hdlist1">
982 git show next~10:Documentation/README
983 </dt>
984 <dd>
986 Shows the contents of the file <tt>Documentation/README</tt> as
987 they were current in the 10th last commit of the branch
988 <tt>next</tt>.
989 </p>
990 </dd>
991 <dt class="hdlist1">
992 git show master:Makefile master:t/Makefile
993 </dt>
994 <dd>
996 Concatenates the contents of said Makefiles in the head
997 of the branch <tt>master</tt>.
998 </p>
999 </dd>
1000 </dl></div>
1001 </div>
1002 <h2 id="_discussion">Discussion</h2>
1003 <div class="sectionbody">
1004 <div class="paragraph"><p>At the core level, git is character encoding agnostic.</p></div>
1005 <div class="ulist"><ul>
1006 <li>
1008 The pathnames recorded in the index and in the tree objects
1009 are treated as uninterpreted sequences of non-NUL bytes.
1010 What readdir(2) returns are what are recorded and compared
1011 with the data git keeps track of, which in turn are expected
1012 to be what lstat(2) and creat(2) accepts. There is no such
1013 thing as pathname encoding translation.
1014 </p>
1015 </li>
1016 <li>
1018 The contents of the blob objects are uninterpreted sequences
1019 of bytes. There is no encoding translation at the core
1020 level.
1021 </p>
1022 </li>
1023 <li>
1025 The commit log messages are uninterpreted sequences of non-NUL
1026 bytes.
1027 </p>
1028 </li>
1029 </ul></div>
1030 <div class="paragraph"><p>Although we encourage that the commit log messages are encoded
1031 in UTF-8, both the core and git Porcelain are designed not to
1032 force UTF-8 on projects. If all participants of a particular
1033 project find it more convenient to use legacy encodings, git
1034 does not forbid it. However, there are a few things to keep in
1035 mind.</p></div>
1036 <div class="olist arabic"><ol class="arabic">
1037 <li>
1039 <em>git commit</em> and <em>git commit-tree</em> issues
1040 a warning if the commit log message given to it does not look
1041 like a valid UTF-8 string, unless you explicitly say your
1042 project uses a legacy encoding. The way to say this is to
1043 have i18n.commitencoding in <tt>.git/config</tt> file, like this:
1044 </p>
1045 <div class="listingblock">
1046 <div class="content">
1047 <pre><tt>[i18n]
1048 commitencoding = ISO-8859-1</tt></pre>
1049 </div></div>
1050 <div class="paragraph"><p>Commit objects created with the above setting record the value
1051 of <tt>i18n.commitencoding</tt> in its <tt>encoding</tt> header. This is to
1052 help other people who look at them later. Lack of this header
1053 implies that the commit log message is encoded in UTF-8.</p></div>
1054 </li>
1055 <li>
1057 <em>git log</em>, <em>git show</em>, <em>git blame</em> and friends look at the
1058 <tt>encoding</tt> header of a commit object, and try to re-code the
1059 log message into UTF-8 unless otherwise specified. You can
1060 specify the desired output encoding with
1061 <tt>i18n.logoutputencoding</tt> in <tt>.git/config</tt> file, like this:
1062 </p>
1063 <div class="listingblock">
1064 <div class="content">
1065 <pre><tt>[i18n]
1066 logoutputencoding = ISO-8859-1</tt></pre>
1067 </div></div>
1068 <div class="paragraph"><p>If you do not have this configuration variable, the value of
1069 <tt>i18n.commitencoding</tt> is used instead.</p></div>
1070 </li>
1071 </ol></div>
1072 <div class="paragraph"><p>Note that we deliberately chose not to re-code the commit log
1073 message when a commit is made to force UTF-8 at the commit
1074 object level, because re-coding to UTF-8 is not necessarily a
1075 reversible operation.</p></div>
1076 </div>
1077 <h2 id="_author">Author</h2>
1078 <div class="sectionbody">
1079 <div class="paragraph"><p>Written by Linus Torvalds &lt;<a href="mailto:torvalds@osdl.org">torvalds@osdl.org</a>&gt; and
1080 Junio C Hamano &lt;<a href="mailto:gitster@pobox.com">gitster@pobox.com</a>&gt;. Significantly enhanced by
1081 Johannes Schindelin &lt;<a href="mailto:Johannes.Schindelin@gmx.de">Johannes.Schindelin@gmx.de</a>&gt;.</p></div>
1082 </div>
1083 <h2 id="_documentation">Documentation</h2>
1084 <div class="sectionbody">
1085 <div class="paragraph"><p>Documentation by David Greaves, Petr Baudis and the git-list &lt;<a href="mailto:git@vger.kernel.org">git@vger.kernel.org</a>&gt;.</p></div>
1086 </div>
1087 <h2 id="_git">GIT</h2>
1088 <div class="sectionbody">
1089 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1090 </div>
1091 <div id="footer">
1092 <div id="footer-text">
1093 Last updated 2010-11-09 19:41:12 UTC
1094 </div>
1095 </div>
1096 </body>
1097 </html>