Autogenerated HTML docs for v1.7.4.1-294-gaf4c
[git/jnareb-git.git] / git-annotate.html
blobc89394b6e7c6037492174749e864b6840372fa18
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-annotate(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-annotate(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>git-annotate -
411 Annotate file lines with commit information
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="paragraph"><p><em>git annotate</em> [options] file [revision]</p></div>
418 </div>
419 <h2 id="_description">DESCRIPTION</h2>
420 <div class="sectionbody">
421 <div class="paragraph"><p>Annotates each line in the given file with information from the commit
422 which introduced the line. Optionally annotates from a given revision.</p></div>
423 <div class="paragraph"><p>The only difference between this command and <a href="git-blame.html">git-blame(1)</a> is that
424 they use slightly different output formats, and this command exists only
425 for backward compatibility to support existing scripts, and provide a more
426 familiar command name for people coming from other SCM systems.</p></div>
427 </div>
428 <h2 id="_options">OPTIONS</h2>
429 <div class="sectionbody">
430 <div class="dlist"><dl>
431 <dt class="hdlist1">
433 </dt>
434 <dd>
436 Show blank SHA-1 for boundary commits. This can also
437 be controlled via the <tt>blame.blankboundary</tt> config option.
438 </p>
439 </dd>
440 <dt class="hdlist1">
441 --root
442 </dt>
443 <dd>
445 Do not treat root commits as boundaries. This can also be
446 controlled via the <tt>blame.showroot</tt> config option.
447 </p>
448 </dd>
449 <dt class="hdlist1">
450 --show-stats
451 </dt>
452 <dd>
454 Include additional statistics at the end of blame output.
455 </p>
456 </dd>
457 <dt class="hdlist1">
458 -L &lt;start&gt;,&lt;end&gt;
459 </dt>
460 <dd>
462 Annotate only the given line range. &lt;start&gt; and &lt;end&gt; can take
463 one of these forms:
464 </p>
465 <div class="ulist"><ul>
466 <li>
468 number
469 </p>
470 <div class="paragraph"><p>If &lt;start&gt; or &lt;end&gt; is a number, it specifies an
471 absolute line number (lines count from 1).</p></div>
472 </li>
473 <li>
475 /regex/
476 </p>
477 <div class="paragraph"><p>This form will use the first line matching the given
478 POSIX regex. If &lt;end&gt; is a regex, it will search
479 starting at the line given by &lt;start&gt;.</p></div>
480 </li>
481 <li>
483 +offset or -offset
484 </p>
485 <div class="paragraph"><p>This is only valid for &lt;end&gt; and will specify a number
486 of lines before or after the line given by &lt;start&gt;.</p></div>
487 </li>
488 </ul></div>
489 </dd>
490 <dt class="hdlist1">
492 </dt>
493 <dd>
495 Show long rev (Default: off).
496 </p>
497 </dd>
498 <dt class="hdlist1">
500 </dt>
501 <dd>
503 Show raw timestamp (Default: off).
504 </p>
505 </dd>
506 <dt class="hdlist1">
507 -S &lt;revs-file&gt;
508 </dt>
509 <dd>
511 Use revisions from revs-file instead of calling <a href="git-rev-list.html">git-rev-list(1)</a>.
512 </p>
513 </dd>
514 <dt class="hdlist1">
515 --reverse
516 </dt>
517 <dd>
519 Walk history forward instead of backward. Instead of showing
520 the revision in which a line appeared, this shows the last
521 revision in which a line has existed. This requires a range of
522 revision like START..END where the path to blame exists in
523 START.
524 </p>
525 </dd>
526 <dt class="hdlist1">
528 </dt>
529 <dt class="hdlist1">
530 --porcelain
531 </dt>
532 <dd>
534 Show in a format designed for machine consumption.
535 </p>
536 </dd>
537 <dt class="hdlist1">
538 --incremental
539 </dt>
540 <dd>
542 Show the result incrementally in a format designed for
543 machine consumption.
544 </p>
545 </dd>
546 <dt class="hdlist1">
547 --encoding=&lt;encoding&gt;
548 </dt>
549 <dd>
551 Specifies the encoding used to output author names
552 and commit summaries. Setting it to <tt>none</tt> makes blame
553 output unconverted data. For more information see the
554 discussion about encoding in the <a href="git-log.html">git-log(1)</a>
555 manual page.
556 </p>
557 </dd>
558 <dt class="hdlist1">
559 --contents &lt;file&gt;
560 </dt>
561 <dd>
563 When &lt;rev&gt; is not specified, the command annotates the
564 changes starting backwards from the working tree copy.
565 This flag makes the command pretend as if the working
566 tree copy has the contents of the named file (specify
567 <tt>-</tt> to make the command read from the standard input).
568 </p>
569 </dd>
570 <dt class="hdlist1">
571 --date &lt;format&gt;
572 </dt>
573 <dd>
575 The value is one of the following alternatives:
576 {relative,local,default,iso,rfc,short}. If --date is not
577 provided, the value of the blame.date config variable is
578 used. If the blame.date config variable is also not set, the
579 iso format is used. For more information, See the discussion
580 of the --date option at <a href="git-log.html">git-log(1)</a>.
581 </p>
582 </dd>
583 <dt class="hdlist1">
584 -M|&lt;num&gt;|
585 </dt>
586 <dd>
588 Detect moved or copied lines within a file. When a commit
589 moves or copies a block of lines (e.g. the original file
590 has A and then B, and the commit changes it to B and then
591 A), the traditional <em>blame</em> algorithm notices only half of
592 the movement and typically blames the lines that were moved
593 up (i.e. B) to the parent and assigns blame to the lines that
594 were moved down (i.e. A) to the child commit. With this
595 option, both groups of lines are blamed on the parent by
596 running extra passes of inspection.
597 </p>
598 <div class="paragraph"><p>&lt;num&gt; is optional but it is the lower bound on the number of
599 alphanumeric characters that git must detect as moving/copying
600 within a file for it to associate those lines with the parent
601 commit. The default value is 20.</p></div>
602 </dd>
603 <dt class="hdlist1">
604 -C|&lt;num&gt;|
605 </dt>
606 <dd>
608 In addition to <tt>-M</tt>, detect lines moved or copied from other
609 files that were modified in the same commit. This is
610 useful when you reorganize your program and move code
611 around across files. When this option is given twice,
612 the command additionally looks for copies from other
613 files in the commit that creates the file. When this
614 option is given three times, the command additionally
615 looks for copies from other files in any commit.
616 </p>
617 <div class="paragraph"><p>&lt;num&gt; is optional but it is the lower bound on the number of
618 alphanumeric characters that git must detect as moving/copying
619 between files for it to associate those lines with the parent
620 commit. And the default value is 40. If there are more than one
621 <tt>-C</tt> options given, the &lt;num&gt; argument of the last <tt>-C</tt> will
622 take effect.</p></div>
623 </dd>
624 <dt class="hdlist1">
626 </dt>
627 <dt class="hdlist1">
628 --help
629 </dt>
630 <dd>
632 Show help message.
633 </p>
634 </dd>
635 </dl></div>
636 </div>
637 <h2 id="_see_also">SEE ALSO</h2>
638 <div class="sectionbody">
639 <div class="paragraph"><p><a href="git-blame.html">git-blame(1)</a></p></div>
640 </div>
641 <h2 id="_git">GIT</h2>
642 <div class="sectionbody">
643 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
644 </div>
645 <div id="footer">
646 <div id="footer-text">
647 Last updated 2011-03-15 23:30:13 UTC
648 </div>
649 </div>
650 </body>
651 </html>