Autogenerated HTML docs for v1.7.7-419-g87009
[git/jnareb-git.git] / git-annotate.html
blob47bf31c5b1b83b068a1c1d47a3ae39b0fe48c73e
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.5.2" />
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.0em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
131 div.content { /* Block element content. */
132 padding: 0;
135 /* Block element titles. */
136 div.title, caption.title {
137 color: #527bbd;
138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
144 div.title + * {
145 margin-top: 0;
148 td div.title:first-child {
149 margin-top: 0.0em;
151 div.content div.title:first-child {
152 margin-top: 0.0em;
154 div.content + div.title {
155 margin-top: 0.0em;
158 div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
164 div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
170 div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
173 margin-right: 10%;
174 border-left: 5px solid #dddddd;
175 color: #777777;
178 div.quoteblock > div.attribution {
179 padding-top: 0.5em;
180 text-align: right;
183 div.verseblock > div.content {
184 white-space: pre;
186 div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div.verseblock + div.attribution {
192 text-align: left;
195 div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
203 div.admonitionblock td.content {
204 padding-left: 0.5em;
205 border-left: 3px solid #dddddd;
208 div.exampleblock > div.content {
209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
213 div.imageblock div.content { padding-left: 0; }
214 span.image img { border-style: none; }
215 a.image:visited { color: white; }
217 dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
221 dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
224 font-style: normal;
225 color: navy;
227 dd > *:first-child {
228 margin-top: 0.1em;
231 ul, ol {
232 list-style-position: outside;
234 ol.arabic {
235 list-style-type: decimal;
237 ol.loweralpha {
238 list-style-type: lower-alpha;
240 ol.upperalpha {
241 list-style-type: upper-alpha;
243 ol.lowerroman {
244 list-style-type: lower-roman;
246 ol.upperroman {
247 list-style-type: upper-roman;
250 div.compact ul, div.compact ol,
251 div.compact p, div.compact p,
252 div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
257 div.tableblock > table {
258 border: 3px solid #527bbd;
260 thead, p.table.header {
261 font-family: sans-serif;
262 font-weight: bold;
264 tfoot {
265 font-weight: bold;
267 td > div.verse {
268 white-space: pre;
270 p.table {
271 margin-top: 0;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div.tableblock > table[frame="void"] {
275 border-style: none;
277 div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
281 div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
287 div.hdlist {
288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
291 div.hdlist tr {
292 padding-bottom: 15px;
294 dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
297 td.hdlist1 {
298 vertical-align: top;
299 font-style: normal;
300 padding-right: 0.8em;
301 color: navy;
303 td.hdlist2 {
304 vertical-align: top;
306 div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
311 .comment {
312 background: yellow;
315 .footnote, .footnoteref {
316 font-size: 0.8em;
319 span.footnote, span.footnoteref {
320 vertical-align: super;
323 #footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
328 #footnotes div.footnote {
329 margin: 0 0 5px 0;
332 #footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
343 @media print {
344 div#footer-badges { display: none; }
347 div#toc {
348 margin-bottom: 2.5em;
351 div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
364 div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
368 div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
372 div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
376 /* Overrides for manpage documents */
377 h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
383 h2 {
384 border-style: none;
386 div.sectionbody {
387 margin-left: 5%;
390 @media print {
391 div#toc { display: none; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
401 div.sidebar-title, div.image-title {
402 color: #527bbd;
403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
409 div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
415 div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
420 div.verseblock-content {
421 white-space: pre;
423 div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
428 div.exampleblock-content {
429 border-left: 3px solid #dddddd;
430 padding-left: 0.5em;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc a:visited { color: blue; }
435 </style>
436 <script type="text/javascript">
437 /*<![CDATA[*/
438 window.onload = function(){asciidoc.footnotes();}
439 var asciidoc = { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
449 * Version: 0.4
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
459 toc: function (toclevels) {
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
469 return text;
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
491 iterate(i);
495 iterate(el);
496 return result;
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
567 /*]]>*/
568 </script>
569 </head>
570 <body>
571 <div id="header">
572 <h1>
573 git-annotate(1) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>git-annotate -
578 Annotate file lines with commit information
579 </p>
580 </div>
581 </div>
582 <div id="content">
583 <h2 id="_synopsis">SYNOPSIS</h2>
584 <div class="sectionbody">
585 <div class="verseblock">
586 <div class="verseblock-content"><em>git annotate</em> [options] file [revision]</div>
587 <div class="verseblock-attribution">
588 </div></div>
589 </div>
590 <h2 id="_description">DESCRIPTION</h2>
591 <div class="sectionbody">
592 <div class="paragraph"><p>Annotates each line in the given file with information from the commit
593 which introduced the line. Optionally annotates from a given revision.</p></div>
594 <div class="paragraph"><p>The only difference between this command and <a href="git-blame.html">git-blame(1)</a> is that
595 they use slightly different output formats, and this command exists only
596 for backward compatibility to support existing scripts, and provide a more
597 familiar command name for people coming from other SCM systems.</p></div>
598 </div>
599 <h2 id="_options">OPTIONS</h2>
600 <div class="sectionbody">
601 <div class="dlist"><dl>
602 <dt class="hdlist1">
604 </dt>
605 <dd>
607 Show blank SHA-1 for boundary commits. This can also
608 be controlled via the <tt>blame.blankboundary</tt> config option.
609 </p>
610 </dd>
611 <dt class="hdlist1">
612 --root
613 </dt>
614 <dd>
616 Do not treat root commits as boundaries. This can also be
617 controlled via the <tt>blame.showroot</tt> config option.
618 </p>
619 </dd>
620 <dt class="hdlist1">
621 --show-stats
622 </dt>
623 <dd>
625 Include additional statistics at the end of blame output.
626 </p>
627 </dd>
628 <dt class="hdlist1">
629 -L &lt;start&gt;,&lt;end&gt;
630 </dt>
631 <dd>
633 Annotate only the given line range. &lt;start&gt; and &lt;end&gt; can take
634 one of these forms:
635 </p>
636 <div class="ulist"><ul>
637 <li>
639 number
640 </p>
641 <div class="paragraph"><p>If &lt;start&gt; or &lt;end&gt; is a number, it specifies an
642 absolute line number (lines count from 1).</p></div>
643 </li>
644 <li>
646 /regex/
647 </p>
648 <div class="paragraph"><p>This form will use the first line matching the given
649 POSIX regex. If &lt;end&gt; is a regex, it will search
650 starting at the line given by &lt;start&gt;.</p></div>
651 </li>
652 <li>
654 +offset or -offset
655 </p>
656 <div class="paragraph"><p>This is only valid for &lt;end&gt; and will specify a number
657 of lines before or after the line given by &lt;start&gt;.</p></div>
658 </li>
659 </ul></div>
660 </dd>
661 <dt class="hdlist1">
663 </dt>
664 <dd>
666 Show long rev (Default: off).
667 </p>
668 </dd>
669 <dt class="hdlist1">
671 </dt>
672 <dd>
674 Show raw timestamp (Default: off).
675 </p>
676 </dd>
677 <dt class="hdlist1">
678 -S &lt;revs-file&gt;
679 </dt>
680 <dd>
682 Use revisions from revs-file instead of calling <a href="git-rev-list.html">git-rev-list(1)</a>.
683 </p>
684 </dd>
685 <dt class="hdlist1">
686 --reverse
687 </dt>
688 <dd>
690 Walk history forward instead of backward. Instead of showing
691 the revision in which a line appeared, this shows the last
692 revision in which a line has existed. This requires a range of
693 revision like START..END where the path to blame exists in
694 START.
695 </p>
696 </dd>
697 <dt class="hdlist1">
699 </dt>
700 <dt class="hdlist1">
701 --porcelain
702 </dt>
703 <dd>
705 Show in a format designed for machine consumption.
706 </p>
707 </dd>
708 <dt class="hdlist1">
709 --line-porcelain
710 </dt>
711 <dd>
713 Show the porcelain format, but output commit information for
714 each line, not just the first time a commit is referenced.
715 Implies --porcelain.
716 </p>
717 </dd>
718 <dt class="hdlist1">
719 --incremental
720 </dt>
721 <dd>
723 Show the result incrementally in a format designed for
724 machine consumption.
725 </p>
726 </dd>
727 <dt class="hdlist1">
728 --encoding=&lt;encoding&gt;
729 </dt>
730 <dd>
732 Specifies the encoding used to output author names
733 and commit summaries. Setting it to <tt>none</tt> makes blame
734 output unconverted data. For more information see the
735 discussion about encoding in the <a href="git-log.html">git-log(1)</a>
736 manual page.
737 </p>
738 </dd>
739 <dt class="hdlist1">
740 --contents &lt;file&gt;
741 </dt>
742 <dd>
744 When &lt;rev&gt; is not specified, the command annotates the
745 changes starting backwards from the working tree copy.
746 This flag makes the command pretend as if the working
747 tree copy has the contents of the named file (specify
748 <tt>-</tt> to make the command read from the standard input).
749 </p>
750 </dd>
751 <dt class="hdlist1">
752 --date &lt;format&gt;
753 </dt>
754 <dd>
756 The value is one of the following alternatives:
757 {relative,local,default,iso,rfc,short}. If --date is not
758 provided, the value of the blame.date config variable is
759 used. If the blame.date config variable is also not set, the
760 iso format is used. For more information, See the discussion
761 of the --date option at <a href="git-log.html">git-log(1)</a>.
762 </p>
763 </dd>
764 <dt class="hdlist1">
765 -M|&lt;num&gt;|
766 </dt>
767 <dd>
769 Detect moved or copied lines within a file. When a commit
770 moves or copies a block of lines (e.g. the original file
771 has A and then B, and the commit changes it to B and then
772 A), the traditional <em>blame</em> algorithm notices only half of
773 the movement and typically blames the lines that were moved
774 up (i.e. B) to the parent and assigns blame to the lines that
775 were moved down (i.e. A) to the child commit. With this
776 option, both groups of lines are blamed on the parent by
777 running extra passes of inspection.
778 </p>
779 <div class="paragraph"><p>&lt;num&gt; is optional but it is the lower bound on the number of
780 alphanumeric characters that git must detect as moving/copying
781 within a file for it to associate those lines with the parent
782 commit. The default value is 20.</p></div>
783 </dd>
784 <dt class="hdlist1">
785 -C|&lt;num&gt;|
786 </dt>
787 <dd>
789 In addition to <tt>-M</tt>, detect lines moved or copied from other
790 files that were modified in the same commit. This is
791 useful when you reorganize your program and move code
792 around across files. When this option is given twice,
793 the command additionally looks for copies from other
794 files in the commit that creates the file. When this
795 option is given three times, the command additionally
796 looks for copies from other files in any commit.
797 </p>
798 <div class="paragraph"><p>&lt;num&gt; is optional but it is the lower bound on the number of
799 alphanumeric characters that git must detect as moving/copying
800 between files for it to associate those lines with the parent
801 commit. And the default value is 40. If there are more than one
802 <tt>-C</tt> options given, the &lt;num&gt; argument of the last <tt>-C</tt> will
803 take effect.</p></div>
804 </dd>
805 <dt class="hdlist1">
807 </dt>
808 <dd>
810 Show help message.
811 </p>
812 </dd>
813 </dl></div>
814 </div>
815 <h2 id="_see_also">SEE ALSO</h2>
816 <div class="sectionbody">
817 <div class="paragraph"><p><a href="git-blame.html">git-blame(1)</a></p></div>
818 </div>
819 <h2 id="_git">GIT</h2>
820 <div class="sectionbody">
821 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
822 </div>
823 </div>
824 <div id="footnotes"><hr /></div>
825 <div id="footer">
826 <div id="footer-text">
827 Last updated 2011-09-21 23:01:14 PDT
828 </div>
829 </div>
830 </body>
831 </html>