git-annotate.html

   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.2.5" />
   7 <style type="text/css">
   8 /* Debug borders */
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10 /*
  11   border: 1px solid red;
  12 */
  13 }
  14
  15 body {
  16   margin: 1em 5% 1em 5%;
  17 }
  18
  19 a {
  20   color: blue;
  21   text-decoration: underline;
  22 }
  23 a:visited {
  24   color: fuchsia;
  25 }
  26
  27 em {
  28   font-style: italic;
  29 }
  30
  31 strong {
  32   font-weight: bold;
  33 }
  34
  35 tt {
  36   color: navy;
  37 }
  38
  39 h1, 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
  47 h1, h2, h3 {
  48   border-bottom: 2px solid silver;
  49 }
  50 h2 {
  51   padding-top: 0.5em;
  52 }
  53 h3 {
  54   float: left;
  55 }
  56 h3 + * {
  57   clear: left;
  58 }
  59
  60 div.sectionbody {
  61   font-family: serif;
  62   margin-left: 0;
  63 }
  64
  65 hr {
  66   border: 1px solid silver;
  67 }
  68
  69 p {
  70   margin-top: 0.5em;
  71   margin-bottom: 0.5em;
  72 }
  73
  74 pre {
  75   padding: 0;
  76   margin: 0;
  77 }
  78
  79 span#author {
  80   color: #527bbd;
  81   font-family: sans-serif;
  82   font-weight: bold;
  83   font-size: 1.1em;
  84 }
  85 span#email {
  86 }
  87 span#revision {
  88   font-family: sans-serif;
  89 }
  90
  91 div#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 }
  98 div#footer-text {
  99   float: left;
 100   padding-bottom: 0.5em;
 101 }
 102 div#footer-badges {
 103   float: right;
 104   padding-bottom: 0.5em;
 105 }
 106
 107 div#preamble,
 108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 110 div.admonitionblock {
 111   margin-right: 10%;
 112   margin-top: 1.5em;
 113   margin-bottom: 1.5em;
 114 }
 115 div.admonitionblock {
 116   margin-top: 2.5em;
 117   margin-bottom: 2.5em;
 118 }
 119
 120 div.content { /* Block element content. */
 121   padding: 0;
 122 }
 123
 124 /* Block element titles. */
 125 div.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 }
 132 div.title + * {
 133   margin-top: 0;
 134 }
 135
 136 td div.title:first-child {
 137   margin-top: 0.0em;
 138 }
 139 div.content div.title:first-child {
 140   margin-top: 0.0em;
 141 }
 142 div.content + div.title {
 143   margin-top: 0.0em;
 144 }
 145
 146 div.sidebarblock > div.content {
 147   background: #ffffee;
 148   border: 1px solid silver;
 149   padding: 0.5em;
 150 }
 151
 152 div.listingblock {
 153   margin-right: 0%;
 154 }
 155 div.listingblock > div.content {
 156   border: 1px solid silver;
 157   background: #f4f4f4;
 158   padding: 0.5em;
 159 }
 160
 161 div.quoteblock > div.content {
 162   padding-left: 2.0em;
 163 }
 164
 165 div.attribution {
 166   text-align: right;
 167 }
 168 div.verseblock + div.attribution {
 169   text-align: left;
 170 }
 171
 172 div.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 }
 180 div.admonitionblock td.content {
 181   padding-left: 0.5em;
 182   border-left: 2px solid silver;
 183 }
 184
 185 div.exampleblock > div.content {
 186   border-left: 2px solid silver;
 187   padding: 0.5em;
 188 }
 189
 190 div.verseblock div.content {
 191   white-space: pre;
 192 }
 193
 194 div.imageblock div.content { padding-left: 0; }
 195 div.imageblock img { border: 1px solid silver; }
 196 span.image img { border-style: none; }
 197
 198 dl {
 199   margin-top: 0.8em;
 200   margin-bottom: 0.8em;
 201 }
 202 dt {
 203   margin-top: 0.5em;
 204   margin-bottom: 0;
 205   font-style: italic;
 206 }
 207 dd > *:first-child {
 208   margin-top: 0;
 209 }
 210
 211 ul, ol {
 212     list-style-position: outside;
 213 }
 214 div.olist2 ol {
 215   list-style-type: lower-alpha;
 216 }
 217
 218 div.tableblock > table {
 219   border: 3px solid #527bbd;
 220 }
 221 thead {
 222   font-family: sans-serif;
 223   font-weight: bold;
 224 }
 225 tfoot {
 226   font-weight: bold;
 227 }
 228
 229 div.hlist {
 230   margin-top: 0.8em;
 231   margin-bottom: 0.8em;
 232 }
 233 div.hlist td {
 234   padding-bottom: 5px;
 235 }
 236 td.hlist1 {
 237   vertical-align: top;
 238   font-style: italic;
 239   padding-right: 0.8em;
 240 }
 241 td.hlist2 {
 242   vertical-align: top;
 243 }
 244
 245 @media print {
 246   div#footer-badges { display: none; }
 247 }
 248
 249 div#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
 258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 259   margin-top: 0;
 260   margin-bottom: 0;
 261 }
 262 div.toclevel2 {
 263   margin-left: 2em;
 264   font-size: 0.9em;
 265 }
 266 div.toclevel3 {
 267   margin-left: 4em;
 268   font-size: 0.9em;
 269 }
 270 div.toclevel4 {
 271   margin-left: 6em;
 272   font-size: 0.9em;
 273 }
 274 include1::./stylesheets/xhtml11-manpage.css[]
 275 /* Workarounds for IE6's broken and incomplete CSS2. */
 276
 277 div.sidebar-content {
 278   background: #ffffee;
 279   border: 1px solid silver;
 280   padding: 0.5em;
 281 }
 282 div.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
 289 div.listingblock div.content {
 290   border: 1px solid silver;
 291   background: #f4f4f4;
 292   padding: 0.5em;
 293 }
 294
 295 div.quoteblock-content {
 296   padding-left: 2.0em;
 297 }
 298
 299 div.exampleblock-content {
 300   border-left: 2px solid silver;
 301   padding-left: 0.5em;
 302 }
 303
 304 /* IE6 sets dynamically generated links as visited. */
 305 div#toc a:visited { color: blue; }
 306 </style>
 307 <title>git-annotate(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-annotate(1) Manual Page
 313 </h1>
 314 <h2>NAME</h2>
 315 <div class="sectionbody">
 316 <p>git-annotate -
 317    Annotate file lines with commit information
 318 </p>
 319 </div>
 320 </div>
 321 <h2>SYNOPSIS</h2>
 322 <div class="sectionbody">
 323 <div class="para"><p><em>git annotate</em> [options] file [revision]</p></div>
 324 </div>
 325 <h2 id="_description">DESCRIPTION</h2>
 326 <div class="sectionbody">
 327 <div class="para"><p>Annotates each line in the given file with information from the commit
 328 which introduced the line. Optionally annotates from a given revision.</p></div>
 329 <div class="para"><p>The only difference between this command and <a href="git-blame.html">git-blame(1)</a> is that
 330 they use slightly different output formats, and this command exists only
 331 for backward compatibility to support existing scripts, and provide a more
 332 familiar command name for people coming from other SCM systems.</p></div>
 333 </div>
 334 <h2 id="_options">OPTIONS</h2>
 335 <div class="sectionbody">
 336 <div class="vlist"><dl>
 337 <dt>
 338 -b
 339 </dt>
 340 <dd>
 341 <p>
 342         Show blank SHA-1 for boundary commits.  This can also
 343         be controlled via the <tt>blame.blankboundary</tt> config option.
 344 </p>
 345 </dd>
 346 <dt>
 347 --root
 348 </dt>
 349 <dd>
 350 <p>
 351         Do not treat root commits as boundaries.  This can also be
 352         controlled via the <tt>blame.showroot</tt> config option.
 353 </p>
 354 </dd>
 355 <dt>
 356 --show-stats
 357 </dt>
 358 <dd>
 359 <p>
 360         Include additional statistics at the end of blame output.
 361 </p>
 362 </dd>
 363 <dt>
 364 -L &lt;start&gt;,&lt;end&gt;
 365 </dt>
 366 <dd>
 367 <p>
 368         Annotate only the given line range.  &lt;start&gt; and &lt;end&gt; can take
 369         one of these forms:
 370 </p>
 371 <div class="ilist"><ul>
 372 <li>
 373 <p>
 374 number
 375 </p>
 376 <div class="para"><p>If &lt;start&gt; or &lt;end&gt; is a number, it specifies an
 377 absolute line number (lines count from 1).</p></div>
 378 </li>
 379 <li>
 380 <p>
 381 /regex/
 382 </p>
 383 <div class="para"><p>This form will use the first line matching the given
 384 POSIX regex.  If &lt;end&gt; is a regex, it will search
 385 starting at the line given by &lt;start&gt;.</p></div>
 386 </li>
 387 <li>
 388 <p>
 389 +offset or -offset
 390 </p>
 391 <div class="para"><p>This is only valid for &lt;end&gt; and will specify a number
 392 of lines before or after the line given by &lt;start&gt;.</p></div>
 393 </li>
 394 </ul></div>
 395 </dd>
 396 <dt>
 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>
 417         Use revisions from revs-file instead of calling <a href="git-rev-list.html">git-rev-list(1)</a>.
 418 </p>
 419 </dd>
 420 <dt>
 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>
 433 -p
 434 </dt>
 435 <dt>
 436 --porcelain
 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>
 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>
 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
 472         tree copy has the contents of the named file (specify
 473         <tt>-</tt> to make the command read from the standard input).
 474 </p>
 475 </dd>
 476 <dt>
 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>
 490 -M|&lt;num&gt;|
 491 </dt>
 492 <dd>
 493 <p>
 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.
 503 </p>
 504 <div class="para"><p>&lt;num&gt; is optional but it is the lower bound on the number of
 505 alphanumeric characters that git must detect as moving/copying
 506 within a file for it to associate those lines with the parent
 507 commit. The default value is 20.</p></div>
 508 </dd>
 509 <dt>
 510 -C|&lt;num&gt;|
 511 </dt>
 512 <dd>
 513 <p>
 514         In addition to <tt>-M</tt>, detect lines moved or copied from other
 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,
 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.
 522 </p>
 523 <div class="para"><p>&lt;num&gt; is optional but it is the lower bound on the number of
 524 alphanumeric characters that git must detect as moving/copying
 525 between files for it to associate those lines with the parent
 526 commit. 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
 528 take effect.</p></div>
 529 </dd>
 530 <dt>
 531 -h
 532 </dt>
 533 <dt>
 534 --help
 535 </dt>
 536 <dd>
 537 <p>
 538         Show help message.
 539 </p>
 540 </dd>
 541 </dl></div>
 542 </div>
 543 <h2 id="_see_also">SEE ALSO</h2>
 544 <div class="sectionbody">
 545 <div class="para"><p><a href="git-blame.html">git-blame(1)</a></p></div>
 546 </div>
 547 <h2 id="_author">AUTHOR</h2>
 548 <div class="sectionbody">
 549 <div class="para"><p>Written by Ryan Anderson &lt;ryan@michonline.com&gt;.</p></div>
 550 </div>
 551 <h2 id="_git">GIT</h2>
 552 <div class="sectionbody">
 553 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 554 </div>
 555 <div id="footer">
 556 <div id="footer-text">
 557 Last updated 2010-09-18 23:56:33 UTC
 558 </div>
 559 </div>
 560 </body>
 561 </html>