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