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">
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 */
14 font-family: Georgia,serif;
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
22 #author, #revnumber, #revdate, #revremark,
24 font-family: Arial,Helvetica,sans-serif;
28 margin:
1em
5%
1em
5%;
33 text-decoration: underline;
49 h1, h2, h3, h4, h5, h6 {
57 border-bottom:
2px solid silver;
77 border:
1px solid silver;
88 ul
> li { color: #aaa; }
89 ul
> li
> * { color: black; }
91 .monospaced, code, pre {
92 font-family:
"Courier New", Courier, monospace;
99 white-space: pre-wrap;
109 #revnumber, #revdate, #revremark {
114 border-top:
2px solid silver;
120 padding-bottom:
0.5em;
124 padding-bottom:
0.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 {
135 margin-bottom:
1.5em;
137 div.admonitionblock {
139 margin-bottom:
2.0em;
144 div.content { /* Block element content. */
148 /* Block element titles. */
149 div.title, caption.title {
154 margin-bottom:
0.5em;
160 td div.title:first-child {
163 div.content div.title:first-child {
166 div.content + div.title {
170 div.sidebarblock
> div.content {
172 border:
1px solid #dddddd;
173 border-left:
4px solid #f0f0f0;
177 div.listingblock
> div.content {
178 border:
1px solid #dddddd;
179 border-left:
5px solid #f0f0f0;
184 div.quoteblock, div.verseblock {
188 border-left:
5px solid #f0f0f0;
192 div.quoteblock
> div.attribution {
197 div.verseblock
> pre.content {
198 font-family: inherit;
201 div.verseblock
> div.attribution {
205 /* DEPRECATED: Pre version
8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
210 div.admonitionblock .icon {
214 text-decoration: underline;
216 padding-right:
0.5em;
218 div.admonitionblock td.content {
220 border-left:
3px solid #dddddd;
223 div.exampleblock
> div.content {
224 border-left:
3px solid #dddddd;
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; }
234 margin-bottom:
0.8em;
247 list-style-position: outside;
250 list-style-type: decimal;
253 list-style-type: lower-alpha;
256 list-style-type: upper-alpha;
259 list-style-type: lower-roman;
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 {
269 margin-bottom:
0.1em;
281 margin-bottom:
0.8em;
284 padding-bottom:
15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
292 padding-right:
0.8em;
298 div.hdlist.compact tr {
307 .footnote, .footnoteref {
311 span.footnote, span.footnoteref {
312 vertical-align: super;
316 margin:
20px
0 20px
0;
320 #footnotes div.footnote {
326 border-top:
1px solid silver;
335 padding-right:
0.5em;
336 padding-bottom:
0.3em;
344 #footer-badges { display: none; }
348 margin-bottom:
2.5em;
356 margin-bottom:
0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
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; }
427 margin-bottom:
1.5em;
429 div.tableblock
> table {
430 border:
3px solid #
527bbd;
432 thead, p.table.header {
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock
> table[
frame=
"void"] {
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;
460 margin-bottom:
1.5em;
462 thead, p.tableblock.header {
473 border-color: #
527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
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 {
498 th.tableblock.halign-center, td.tableblock.halign-center {
501 th.tableblock.halign-right, td.tableblock.halign-right {
505 th.tableblock.valign-top, td.tableblock.valign-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;
523 padding-bottom:
0.5em;
524 border-top:
2px solid silver;
525 border-bottom:
2px solid silver;
530 body.manpage div.sectionbody {
535 body.manpage div#toc { display: none; }
540 <script type=
"text/javascript">
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
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 */
562 toc: function (toclevels) {
564 function getText(el) {
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType ==
3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
569 else if (i.firstChild != null)
575 function TocEntry(el, text, toclevel) {
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
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);
602 var toc = document.getElementById(
"toc");
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
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");
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.
651 var noteholder = document.getElementById(
"footnotes");
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");
670 for (i=
0; i
<spans.length; i++) {
671 if (spans[i].className ==
"footnote") {
673 var note = spans[i].getAttribute(
"data-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];
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;
692 noteholder.parentNode.removeChild(noteholder);
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.
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n +
"</a>]";
708 install: function(toclevels) {
711 function reinstall() {
712 asciidoc.footnotes();
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
723 timerId = setInterval(reinstall,
500);
724 if (document.addEventListener)
725 document.addEventListener(
"DOMContentLoaded", reinstallAndRemoveTimer, false);
727 window.onload = reinstallAndRemoveTimer;
735 <body class=
"manpage">
738 git-annotate(
1) Manual Page
741 <div class=
"sectionbody">
743 Annotate file lines with commit information
749 <h2 id=
"_synopsis">SYNOPSIS
</h2>
750 <div class=
"sectionbody">
751 <div class=
"verseblock">
752 <pre class=
"content"><em>git annotate
</em> [
<options
>] [
<rev-opts
>] [
<rev
>] [--]
<file
></pre>
753 <div class=
"attribution">
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>
769 <h2 id=
"_options">OPTIONS
</h2>
770 <div class=
"sectionbody">
771 <div class=
"dlist"><dl>
777 Show blank SHA-
1 for boundary commits. This can also
778 be controlled via the
<code>blame.blankBoundary
</code> config option.
786 Do not treat root commits as boundaries. This can also be
787 controlled via the
<code>blame.showRoot
</code> config option.
795 Include additional statistics at the end of blame output.
799 -L
<start
>,
<end
>
806 Annotate only the line range given by
<em><start
>,
<end
></em>,
807 or by the function name regex
<em><funcname
></em>.
808 May be specified multiple times. Overlapping ranges are allowed.
810 <div class=
"paragraph"><p><em><start
></em> and
<em><end
></em> are optional.
<code>-L
<start
></code> or
<code>-L
<start
>,
</code> spans from
811 <em><start
></em> to end of file.
<code>-L ,
<end
></code> spans from start of file to
<em><end
></em>.
</p></div>
812 <div class=
"paragraph"><p><em><start
></em> and
<em><end
></em> can take one of these forms:
</p></div>
813 <div class=
"ulist"><ul>
818 <div class=
"paragraph"><p>If
<em><start
></em> or
<em><end
></em> is a number, it specifies an
819 absolute line number (lines count from
1).
</p></div>
825 <div class=
"paragraph"><p>This form will use the first line matching the given
826 POSIX regex. If
<em><start
></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><start
></em> is
<code>^/regex/
</code>, it will search from the start of file.
829 If
<em><end
></em> is a regex, it will search
830 starting at the line given by
<em><start
></em>.
</p></div>
836 <div class=
"paragraph"><p>This is only valid for
<em><end
></em> and will specify a number
837 of lines before or after the line given by
<em><start
></em>.
</p></div>
840 <div class=
"paragraph"><p>If
<code>:
<funcname
></code> is given in place of
<em><start
></em> and
<em><end
></em>, it is a
841 regular expression that denotes the range from the first funcname line
842 that matches
<em><funcname
></em>, up to the next funcname line.
<code>:
<funcname
></code>
843 searches from the end of the previous
<code>-L
</code> range, if any, otherwise
844 from the start of file.
<code>^:
<funcname
></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>
854 Show long rev (Default: off).
862 Show raw timestamp (Default: off).
870 Use revisions from revs-file instead of calling
<a href=
"git-rev-list.html">git-rev-list(
1)
</a>.
874 --reverse
<rev
>..
<rev
>
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.
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.
905 Show in a format designed for machine consumption.
913 Show the porcelain format, but output commit information for
914 each line, not just the first time a commit is referenced.
923 Show the result incrementally in a format designed for
928 --encoding=
<encoding
>
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>
940 --contents
<file
>
944 Pretend the file being annotated has a commit with the
945 contents from the named file and a parent of
<rev
>,
946 defaulting to HEAD when no
<rev
> is specified. You may
947 specify
<em>-
</em> to make the command read from the standard
948 input for the file contents.
952 --date
<format
>
956 Specifies the format used to output dates. If --date is not
957 provided, the value of the blame.date config variable is
958 used. If the blame.date config variable is also not set, the
959 iso format is used. For supported values, see the discussion
960 of the --date option at
<a href=
"git-log.html">git-log(
1)
</a>.
968 Progress status is reported on the standard error stream
969 by default when it is attached to a terminal. This flag
970 enables progress reporting even if not attached to a
971 terminal. Can
’t use
<code>--progress
</code> together with
<code>--porcelain
</code>
972 or
<code>--incremental
</code>.
980 Detect moved or copied lines within a file. When a commit
981 moves or copies a block of lines (e.g. the original file
982 has A and then B, and the commit changes it to B and then
983 A), the traditional
<em>blame
</em> algorithm notices only half of
984 the movement and typically blames the lines that were moved
985 up (i.e. B) to the parent and assigns blame to the lines that
986 were moved down (i.e. A) to the child commit. With this
987 option, both groups of lines are blamed on the parent by
988 running extra passes of inspection.
990 <div class=
"paragraph"><p><num
> is optional but it is the lower bound on the number of
991 alphanumeric characters that Git must detect as moving/copying
992 within a file for it to associate those lines with the parent
993 commit. The default value is
20.
</p></div>
1000 In addition to
<code>-M
</code>, detect lines moved or copied from other
1001 files that were modified in the same commit. This is
1002 useful when you reorganize your program and move code
1003 around across files. When this option is given twice,
1004 the command additionally looks for copies from other
1005 files in the commit that creates the file. When this
1006 option is given three times, the command additionally
1007 looks for copies from other files in any commit.
1009 <div class=
"paragraph"><p><num
> is optional but it is the lower bound on the number of
1010 alphanumeric characters that Git must detect as moving/copying
1011 between files for it to associate those lines with the parent
1012 commit. And the default value is
40. If there are more than one
1013 <code>-C
</code> options given, the
<num
> argument of the last
<code>-C
</code> will
1014 take effect.
</p></div>
1016 <dt class=
"hdlist1">
1017 --ignore-rev
<rev
>
1021 Ignore changes made by the revision when assigning blame, as if the
1022 change never happened. Lines that were changed or added by an ignored
1023 commit will be blamed on the previous commit that changed that line or
1024 nearby lines. This option may be specified multiple times to ignore
1025 more than one revision. If the
<code>blame.markIgnoredLines
</code> config option
1026 is set, then lines that were changed by an ignored commit and attributed to
1027 another commit will be marked with a
<code>?
</code> in the blame output. If the
1028 <code>blame.markUnblamableLines
</code> config option is set, then those lines touched
1029 by an ignored commit that we could not attribute to another revision are
1030 marked with a
<em>*
</em>.
1033 <dt class=
"hdlist1">
1034 --ignore-revs-file
<file
>
1038 Ignore revisions listed in
<code>file
</code>, which must be in the same format as an
1039 <code>fsck.skipList
</code>. This option may be repeated, and these files will be
1040 processed after any files specified with the
<code>blame.ignoreRevsFile
</code> config
1041 option. An empty file name,
<code>""</code>, will clear the list of revs from
1042 previously processed files.
1045 <dt class=
"hdlist1">
1050 Color line annotations in the default format differently if they come from
1051 the same commit as the preceding line. This makes it easier to distinguish
1052 code blocks introduced by different commits. The color defaults to cyan and
1053 can be adjusted using the
<code>color.blame.repeatedLines
</code> config option.
1056 <dt class=
"hdlist1">
1061 Color line annotations depending on the age of the line in the default format.
1062 The
<code>color.blame.highlightRecent
</code> config option controls what color is used for
1066 <dt class=
"hdlist1">
1078 <h2 id=
"_see_also">SEE ALSO
</h2>
1079 <div class=
"sectionbody">
1080 <div class=
"paragraph"><p><a href=
"git-blame.html">git-blame(
1)
</a></p></div>
1084 <h2 id=
"_git">GIT
</h2>
1085 <div class=
"sectionbody">
1086 <div class=
"paragraph"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
1090 <div id=
"footnotes"><hr /></div>
1092 <div id=
"footer-text">
1094 2022-
10-
28 11:
53:
56 PDT