Google Git
Sign in
chromium / external / gitster / git-htmldocs / c3fda57fff8451d3c28afc16c6ace06cfd087981 / . / git-annotate.html
blob: cfc96828f3a6193bc69ce777357b4b74a7aabb28 [file] [log] [blame]
Junio C Hamanob33fb4f2006-04-18 21:30:51[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 Hamanof87ade62008-09-07 06:05:51[diff] [blame]6<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamanob33fb4f2006-04-18 21:30:51[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 Hamanof87ade62008-09-07 06:05:51[diff] [blame]19a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamanob33fb4f2006-04-18 21:30:51[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 Hamanof87ade62008-09-07 06:05:51[diff] [blame]47h1, h2, h3 {
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]51 padding-top: 0.5em;
52}
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]53h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamanob33fb4f2006-04-18 21:30:51[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 Hamanof87ade62008-09-07 06:05:51[diff] [blame]83 font-size: 1.1em;
Junio C Hamanob33fb4f2006-04-18 21:30:51[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 Hamanof87ade62008-09-07 06:05:51[diff] [blame]152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamanob33fb4f2006-04-18 21:30:51[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 Hamanof87ade62008-09-07 06:05:51[diff] [blame]164
165div.attribution {
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]166 text-align: right;
167}
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamanob33fb4f2006-04-18 21:30:51[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 Hamanof87ade62008-09-07 06:05:51[diff] [blame]214div.olist2 ol {
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]219 border: 3px solid #527bbd;
Junio C Hamanob33fb4f2006-04-18 21:30:51[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 Hamanof87ade62008-09-07 06:05:51[diff] [blame]233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamanob33fb4f2006-04-18 21:30:51[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 Hamanof87ade62008-09-07 06:05:51[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 Hamanob33fb4f2006-04-18 21:30:51[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 Hamanof87ade62008-09-07 06:05:51[diff] [blame]303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]306</style>
307<title>git-annotate(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-annotate(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-annotate -
Junio C Hamano7924d5e2009-03-03 08:28:48[diff] [blame]317 Annotate file lines with commit information
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]323<div class="para"><p><em>git annotate</em> [options] file [revision]</p></div>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]324</div>
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]325<h2 id="_description">DESCRIPTION</h2>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]326<div class="sectionbody">
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]327<div class="para"><p>Annotates each line in the given file with information from the commit
Junio C Hamano7924d5e2009-03-03 08:28:48[diff] [blame]328which introduced the line. Optionally annotates from a given revision.</p></div>
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]329<div class="para"><p>The only difference between this command and <a href="git-blame.html">git-blame(1)</a> is that
330they use slightly different output formats, and this command exists only
Junio C Hamano7924d5e2009-03-03 08:28:48[diff] [blame]331for backward compatibility to support existing scripts, and provide a more
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]332familiar command name for people coming from other SCM systems.</p></div>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]333</div>
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]334<h2 id="_options">OPTIONS</h2>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]335<div class="sectionbody">
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]336<div class="vlist"><dl>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]337<dt>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]338-b
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]339</dt>
340<dd>
341<p>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]342 Show blank SHA-1 for boundary commits. This can also
343 be controlled via the <tt>blame.blankboundary</tt> config option.
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]344</p>
345</dd>
346<dt>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]347--root
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]348</dt>
349<dd>
350<p>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]351 Do not treat root commits as boundaries. This can also be
352 controlled via the <tt>blame.showroot</tt> config option.
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]353</p>
354</dd>
355<dt>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]356--show-stats
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]357</dt>
358<dd>
359<p>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]360 Include additional statistics at the end of blame output.
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]361</p>
362</dd>
363<dt>
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]364-L &lt;start&gt;,&lt;end&gt;
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]365</dt>
366<dd>
367<p>
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]368 Annotate only the given line range. &lt;start&gt; and &lt;end&gt; can take
369 one of these forms:
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]370</p>
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]371<div class="ilist"><ul>
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]372<li>
373<p>
374number
375</p>
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]376<div class="para"><p>If &lt;start&gt; or &lt;end&gt; is a number, it specifies an
377absolute line number (lines count from 1).</p></div>
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]378</li>
379<li>
380<p>
381/regex/
382</p>
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]383<div class="para"><p>This form will use the first line matching the given
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]384POSIX regex. If &lt;end&gt; is a regex, it will search
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]385starting at the line given by &lt;start&gt;.</p></div>
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]386</li>
387<li>
388<p>
389+offset or -offset
390</p>
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]391<div class="para"><p>This is only valid for &lt;end&gt; and will specify a number
392of lines before or after the line given by &lt;start&gt;.</p></div>
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]393</li>
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]394</ul></div>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]395</dd>
396<dt>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]397-l
398</dt>
399<dd>
400<p>
401 Show long rev (Default: off).
402</p>
403</dd>
404<dt>
405-t
406</dt>
407<dd>
408<p>
409 Show raw timestamp (Default: off).
410</p>
411</dd>
412<dt>
413-S &lt;revs-file&gt;
414</dt>
415<dd>
416<p>
Junio C Hamanofd83b8e2009-03-22 08:21:41[diff] [blame]417 Use revisions from revs-file instead of calling <a href="git-rev-list.html">git-rev-list(1)</a>.
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]418</p>
419</dd>
420<dt>
Junio C Hamanoa6455f62009-02-20 08:33:08[diff] [blame]421--reverse
422</dt>
423<dd>
424<p>
425 Walk history forward instead of backward. Instead of showing
426 the revision in which a line appeared, this shows the last
427 revision in which a line has existed. This requires a range of
428 revision like START..END where the path to blame exists in
429 START.
430</p>
431</dd>
432<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]433-p
434</dt>
435<dt>
436--porcelain
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]437</dt>
438<dd>
439<p>
440 Show in a format designed for machine consumption.
441</p>
442</dd>
443<dt>
444--incremental
445</dt>
446<dd>
447<p>
448 Show the result incrementally in a format designed for
449 machine consumption.
450</p>
451</dd>
452<dt>
Junio C Hamanoaa17c7c2008-11-03 04:36:58[diff] [blame]453--encoding=&lt;encoding&gt;
454</dt>
455<dd>
456<p>
457 Specifies the encoding used to output author names
458 and commit summaries. Setting it to <tt>none</tt> makes blame
459 output unconverted data. For more information see the
460 discussion about encoding in the <a href="git-log.html">git-log(1)</a>
461 manual page.
462</p>
463</dd>
464<dt>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]465--contents &lt;file&gt;
466</dt>
467<dd>
468<p>
469 When &lt;rev&gt; is not specified, the command annotates the
470 changes starting backwards from the working tree copy.
471 This flag makes the command pretend as if the working
Junio C Hamano49dccaf2008-02-10 10:48:01[diff] [blame]472 tree copy has the contents of the named file (specify
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]473 <tt>-</tt> to make the command read from the standard input).
474</p>
475</dd>
476<dt>
Junio C Hamanoea6a7642009-03-11 23:56:19[diff] [blame]477--date &lt;format&gt;
478</dt>
479<dd>
480<p>
481 The value is one of the following alternatives:
482 {relative,local,default,iso,rfc,short}. If --date is not
483 provided, the value of the blame.date config variable is
484 used. If the blame.date config variable is also not set, the
485 iso format is used. For more information, See the discussion
486 of the --date option at <a href="git-log.html">git-log(1)</a>.
487</p>
488</dd>
489<dt>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]490-M|&lt;num&gt;|
491</dt>
492<dd>
493<p>
Junio C Hamano0e8c0b02010-04-12 15:45:55[diff] [blame]494 Detect moved or copied lines within a file. When a commit
495 moves or copies a block of lines (e.g. the original file
496 has A and then B, and the commit changes it to B and then
497 A), the traditional <em>blame</em> algorithm notices only half of
498 the movement and typically blames the lines that were moved
499 up (i.e. B) to the parent and assigns blame to the lines that
500 were moved down (i.e. A) to the child commit. With this
501 option, both groups of lines are blamed on the parent by
502 running extra passes of inspection.
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]503</p>
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]504<div class="para"><p>&lt;num&gt; is optional but it is the lower bound on the number of
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]505alphanumeric characters that git must detect as moving/copying
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]506within a file for it to associate those lines with the parent
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]507commit. The default value is 20.</p></div>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]508</dd>
509<dt>
510-C|&lt;num&gt;|
511</dt>
512<dd>
513<p>
Junio C Hamano0e8c0b02010-04-12 15:45:55[diff] [blame]514 In addition to <tt>-M</tt>, detect lines moved or copied from other
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]515 files that were modified in the same commit. This is
516 useful when you reorganize your program and move code
517 around across files. When this option is given twice,
Junio C Hamano5ca1dd12010-01-17 02:44:04[diff] [blame]518 the command additionally looks for copies from other
519 files in the commit that creates the file. When this
520 option is given three times, the command additionally
521 looks for copies from other files in any commit.
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]522</p>
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]523<div class="para"><p>&lt;num&gt; is optional but it is the lower bound on the number of
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]524alphanumeric characters that git must detect as moving/copying
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]525between files for it to associate those lines with the parent
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]526commit. And the default value is 40. If there are more than one
527<tt>-C</tt> options given, the &lt;num&gt; argument of the last <tt>-C</tt> will
528take effect.</p></div>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]529</dd>
530<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]531-h
532</dt>
533<dt>
534--help
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]535</dt>
536<dd>
537<p>
538 Show help message.
539</p>
540</dd>
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]541</dl></div>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]542</div>
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]543<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]544<div class="sectionbody">
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]545<div class="para"><p><a href="git-blame.html">git-blame(1)</a></p></div>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]546</div>
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]547<h2 id="_author">AUTHOR</h2>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]548<div class="sectionbody">
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]549<div class="para"><p>Written by Ryan Anderson &lt;ryan@michonline.com&gt;.</p></div>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]550</div>
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]551<h2 id="_git">GIT</h2>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]552<div class="sectionbody">
Junio C Hamanof87ade62008-09-07 06:05:51[diff] [blame]553<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]554</div>
555<div id="footer">
556<div id="footer-text">
Junio C Hamanoac752fa2010-09-19 00:01:00[diff] [blame]557Last updated 2010-09-18 23:56:33 UTC
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]558</div>
559</div>
560</body>
561</html>