Autogenerated HTML docs for v2.45.1-204-gd8ab1
[git-htmldocs.git] / git-annotate.html
blobd38dbe2a2a99959998464ce925b4221453a0700f
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5 <head>
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
7 <meta name="generator" content="AsciiDoc 10.2.0" />
8 <title>git-annotate(1)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
17 /* Title font. */
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
21 #toctitle,
22 #author, #revnumber, #revdate, #revremark,
23 #footer {
24 font-family: Arial,Helvetica,sans-serif;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
49 h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
148 /* Block element titles. */
149 div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
184 div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
210 div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
228 div.imageblock div.content { padding-left: 0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
324 #footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
521 body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 git-annotate(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-annotate -
743 Annotate file lines with commit information
744 </p>
745 </div>
746 </div>
747 <div id="content">
748 <div class="sect1">
749 <h2 id="_synopsis">SYNOPSIS</h2>
750 <div class="sectionbody">
751 <div class="verseblock">
752 <pre class="content"><em>git annotate</em> [&lt;options&gt;] [&lt;rev-opts&gt;] [&lt;rev&gt;] [--] &lt;file&gt;</pre>
753 <div class="attribution">
754 </div></div>
755 </div>
756 </div>
757 <div class="sect1">
758 <h2 id="_description">DESCRIPTION</h2>
759 <div class="sectionbody">
760 <div class="paragraph"><p>Annotates each line in the given file with information from the commit
761 which introduced the line. Optionally annotates from a given revision.</p></div>
762 <div class="paragraph"><p>The only difference between this command and <a href="git-blame.html">git-blame(1)</a> is that
763 they use slightly different output formats, and this command exists only
764 for backward compatibility to support existing scripts, and provide a more
765 familiar command name for people coming from other SCM systems.</p></div>
766 </div>
767 </div>
768 <div class="sect1">
769 <h2 id="_options">OPTIONS</h2>
770 <div class="sectionbody">
771 <div class="dlist"><dl>
772 <dt class="hdlist1">
774 </dt>
775 <dd>
777 Show blank SHA-1 for boundary commits. This can also
778 be controlled via the <code>blame.blankBoundary</code> config option.
779 </p>
780 </dd>
781 <dt class="hdlist1">
782 --root
783 </dt>
784 <dd>
786 Do not treat root commits as boundaries. This can also be
787 controlled via the <code>blame.showRoot</code> config option.
788 </p>
789 </dd>
790 <dt class="hdlist1">
791 --show-stats
792 </dt>
793 <dd>
795 Include additional statistics at the end of blame output.
796 </p>
797 </dd>
798 <dt class="hdlist1">
799 -L &lt;start&gt;,&lt;end&gt;
800 </dt>
801 <dt class="hdlist1">
802 -L :&lt;funcname&gt;
803 </dt>
804 <dd>
806 Annotate only the line range given by <em>&lt;start&gt;,&lt;end&gt;</em>,
807 or by the function name regex <em>&lt;funcname&gt;</em>.
808 May be specified multiple times. Overlapping ranges are allowed.
809 </p>
810 <div class="paragraph"><p><em>&lt;start&gt;</em> and <em>&lt;end&gt;</em> are optional. <code>-L &lt;start&gt;</code> or <code>-L &lt;start&gt;,</code> spans from
811 <em>&lt;start&gt;</em> to end of file. <code>-L ,&lt;end&gt;</code> spans from start of file to <em>&lt;end&gt;</em>.</p></div>
812 <div class="paragraph"><p><em>&lt;start&gt;</em> and <em>&lt;end&gt;</em> can take one of these forms:</p></div>
813 <div class="ulist"><ul>
814 <li>
816 number
817 </p>
818 <div class="paragraph"><p>If <em>&lt;start&gt;</em> or <em>&lt;end&gt;</em> is a number, it specifies an
819 absolute line number (lines count from 1).</p></div>
820 </li>
821 <li>
823 <code>/regex/</code>
824 </p>
825 <div class="paragraph"><p>This form will use the first line matching the given
826 POSIX regex. If <em>&lt;start&gt;</em> is a regex, it will search from the end of
827 the previous <code>-L</code> range, if any, otherwise from the start of file.
828 If <em>&lt;start&gt;</em> is <code>^/regex/</code>, it will search from the start of file.
829 If <em>&lt;end&gt;</em> is a regex, it will search
830 starting at the line given by <em>&lt;start&gt;</em>.</p></div>
831 </li>
832 <li>
834 +offset or -offset
835 </p>
836 <div class="paragraph"><p>This is only valid for <em>&lt;end&gt;</em> and will specify a number
837 of lines before or after the line given by <em>&lt;start&gt;</em>.</p></div>
838 </li>
839 </ul></div>
840 <div class="paragraph"><p>If <code>:&lt;funcname&gt;</code> is given in place of <em>&lt;start&gt;</em> and <em>&lt;end&gt;</em>, it is a
841 regular expression that denotes the range from the first funcname line
842 that matches <em>&lt;funcname&gt;</em>, up to the next funcname line. <code>:&lt;funcname&gt;</code>
843 searches from the end of the previous <code>-L</code> range, if any, otherwise
844 from the start of file. <code>^:&lt;funcname&gt;</code> searches from the start of
845 file. The function names are determined in the same way as <code>git diff</code>
846 works out patch hunk headers (see <em>Defining a custom hunk-header</em>
847 in <a href="gitattributes.html">gitattributes(5)</a>).</p></div>
848 </dd>
849 <dt class="hdlist1">
851 </dt>
852 <dd>
854 Show long rev (Default: off).
855 </p>
856 </dd>
857 <dt class="hdlist1">
859 </dt>
860 <dd>
862 Show raw timestamp (Default: off).
863 </p>
864 </dd>
865 <dt class="hdlist1">
866 -S &lt;revs-file&gt;
867 </dt>
868 <dd>
870 Use revisions from revs-file instead of calling <a href="git-rev-list.html">git-rev-list(1)</a>.
871 </p>
872 </dd>
873 <dt class="hdlist1">
874 --reverse &lt;rev&gt;..&lt;rev&gt;
875 </dt>
876 <dd>
878 Walk history forward instead of backward. Instead of showing
879 the revision in which a line appeared, this shows the last
880 revision in which a line has existed. This requires a range of
881 revision like START..END where the path to blame exists in
882 START. <code>git blame --reverse START</code> is taken as <code>git blame
883 --reverse START..HEAD</code> for convenience.
884 </p>
885 </dd>
886 <dt class="hdlist1">
887 --first-parent
888 </dt>
889 <dd>
891 Follow only the first parent commit upon seeing a merge
892 commit. This option can be used to determine when a line
893 was introduced to a particular integration branch, rather
894 than when it was introduced to the history overall.
895 </p>
896 </dd>
897 <dt class="hdlist1">
899 </dt>
900 <dt class="hdlist1">
901 --porcelain
902 </dt>
903 <dd>
905 Show in a format designed for machine consumption.
906 </p>
907 </dd>
908 <dt class="hdlist1">
909 --line-porcelain
910 </dt>
911 <dd>
913 Show the porcelain format, but output commit information for
914 each line, not just the first time a commit is referenced.
915 Implies --porcelain.
916 </p>
917 </dd>
918 <dt class="hdlist1">
919 --incremental
920 </dt>
921 <dd>
923 Show the result incrementally in a format designed for
924 machine consumption.
925 </p>
926 </dd>
927 <dt class="hdlist1">
928 --encoding=&lt;encoding&gt;
929 </dt>
930 <dd>
932 Specifies the encoding used to output author names
933 and commit summaries. Setting it to <code>none</code> makes blame
934 output unconverted data. For more information see the
935 discussion about encoding in the <a href="git-log.html">git-log(1)</a>
936 manual page.
937 </p>
938 </dd>
939 <dt class="hdlist1">
940 --contents &lt;file&gt;
941 </dt>
942 <dd>
944 Annotate using the contents from the named file, starting from &lt;rev&gt;
945 if it is specified, and HEAD otherwise. You may specify <em>-</em> to make
946 the command read from the standard input for the file contents.
947 </p>
948 </dd>
949 <dt class="hdlist1">
950 --date &lt;format&gt;
951 </dt>
952 <dd>
954 Specifies the format used to output dates. If --date is not
955 provided, the value of the blame.date config variable is
956 used. If the blame.date config variable is also not set, the
957 iso format is used. For supported values, see the discussion
958 of the --date option at <a href="git-log.html">git-log(1)</a>.
959 </p>
960 </dd>
961 <dt class="hdlist1">
962 --[no-]progress
963 </dt>
964 <dd>
966 Progress status is reported on the standard error stream
967 by default when it is attached to a terminal. This flag
968 enables progress reporting even if not attached to a
969 terminal. Can&#8217;t use <code>--progress</code> together with <code>--porcelain</code>
970 or <code>--incremental</code>.
971 </p>
972 </dd>
973 <dt class="hdlist1">
974 -M[&lt;num&gt;]
975 </dt>
976 <dd>
978 Detect moved or copied lines within a file. When a commit
979 moves or copies a block of lines (e.g. the original file
980 has A and then B, and the commit changes it to B and then
981 A), the traditional <em>blame</em> algorithm notices only half of
982 the movement and typically blames the lines that were moved
983 up (i.e. B) to the parent and assigns blame to the lines that
984 were moved down (i.e. A) to the child commit. With this
985 option, both groups of lines are blamed on the parent by
986 running extra passes of inspection.
987 </p>
988 <div class="paragraph"><p>&lt;num&gt; is optional but it is the lower bound on the number of
989 alphanumeric characters that Git must detect as moving/copying
990 within a file for it to associate those lines with the parent
991 commit. The default value is 20.</p></div>
992 </dd>
993 <dt class="hdlist1">
994 -C[&lt;num&gt;]
995 </dt>
996 <dd>
998 In addition to <code>-M</code>, detect lines moved or copied from other
999 files that were modified in the same commit. This is
1000 useful when you reorganize your program and move code
1001 around across files. When this option is given twice,
1002 the command additionally looks for copies from other
1003 files in the commit that creates the file. When this
1004 option is given three times, the command additionally
1005 looks for copies from other files in any commit.
1006 </p>
1007 <div class="paragraph"><p>&lt;num&gt; is optional but it is the lower bound on the number of
1008 alphanumeric characters that Git must detect as moving/copying
1009 between files for it to associate those lines with the parent
1010 commit. And the default value is 40. If there are more than one
1011 <code>-C</code> options given, the &lt;num&gt; argument of the last <code>-C</code> will
1012 take effect.</p></div>
1013 </dd>
1014 <dt class="hdlist1">
1015 --ignore-rev &lt;rev&gt;
1016 </dt>
1017 <dd>
1019 Ignore changes made by the revision when assigning blame, as if the
1020 change never happened. Lines that were changed or added by an ignored
1021 commit will be blamed on the previous commit that changed that line or
1022 nearby lines. This option may be specified multiple times to ignore
1023 more than one revision. If the <code>blame.markIgnoredLines</code> config option
1024 is set, then lines that were changed by an ignored commit and attributed to
1025 another commit will be marked with a <code>?</code> in the blame output. If the
1026 <code>blame.markUnblamableLines</code> config option is set, then those lines touched
1027 by an ignored commit that we could not attribute to another revision are
1028 marked with a <em>*</em>.
1029 </p>
1030 </dd>
1031 <dt class="hdlist1">
1032 --ignore-revs-file &lt;file&gt;
1033 </dt>
1034 <dd>
1036 Ignore revisions listed in <code>file</code>, which must be in the same format as an
1037 <code>fsck.skipList</code>. This option may be repeated, and these files will be
1038 processed after any files specified with the <code>blame.ignoreRevsFile</code> config
1039 option. An empty file name, <code>""</code>, will clear the list of revs from
1040 previously processed files.
1041 </p>
1042 </dd>
1043 <dt class="hdlist1">
1044 --color-lines
1045 </dt>
1046 <dd>
1048 Color line annotations in the default format differently if they come from
1049 the same commit as the preceding line. This makes it easier to distinguish
1050 code blocks introduced by different commits. The color defaults to cyan and
1051 can be adjusted using the <code>color.blame.repeatedLines</code> config option.
1052 </p>
1053 </dd>
1054 <dt class="hdlist1">
1055 --color-by-age
1056 </dt>
1057 <dd>
1059 Color line annotations depending on the age of the line in the default format.
1060 The <code>color.blame.highlightRecent</code> config option controls what color is used for
1061 each range of age.
1062 </p>
1063 </dd>
1064 <dt class="hdlist1">
1066 </dt>
1067 <dd>
1069 Show help message.
1070 </p>
1071 </dd>
1072 </dl></div>
1073 </div>
1074 </div>
1075 <div class="sect1">
1076 <h2 id="_see_also">SEE ALSO</h2>
1077 <div class="sectionbody">
1078 <div class="paragraph"><p><a href="git-blame.html">git-blame(1)</a></p></div>
1079 </div>
1080 </div>
1081 <div class="sect1">
1082 <h2 id="_git">GIT</h2>
1083 <div class="sectionbody">
1084 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1085 </div>
1086 </div>
1087 </div>
1088 <div id="footnotes"><hr /></div>
1089 <div id="footer">
1090 <div id="footer-text">
1091 Last updated
1092 2022-10-28 11:53:56 PDT
1093 </div>
1094 </div>
1095 </body>
1096 </html>