Google Git
Sign in
chromium / external / gitster / git-htmldocs / 2fbcd210effb63ce172dc7002701b015a4a0f5a2 / . / git-annotate.html
blob: fdb1b2491abb4fb5c4d006fe1a8b0c6ab9852d64 [file] [log] [blame]
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]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 7.0.2" />
7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
19a { color: blue; }
20a:visited { color: fuchsia; }
21
22em {
23 font-style: italic;
24}
25
26strong {
27 font-weight: bold;
28}
29
30tt {
31 color: navy;
32}
33
34h1, h2, h3, h4, h5, h6 {
35 color: #527bbd;
36 font-family: sans-serif;
37 margin-top: 1.2em;
38 margin-bottom: 0.5em;
39 line-height: 1.3;
40}
41
42h1 {
43 border-bottom: 2px solid silver;
44}
45h2 {
46 border-bottom: 2px solid silver;
47 padding-top: 0.5em;
48}
49
50div.sectionbody {
51 font-family: serif;
52 margin-left: 0;
53}
54
55hr {
56 border: 1px solid silver;
57}
58
59p {
60 margin-top: 0.5em;
61 margin-bottom: 0.5em;
62}
63
64pre {
65 padding: 0;
66 margin: 0;
67}
68
69span#author {
70 color: #527bbd;
71 font-family: sans-serif;
72 font-weight: bold;
73 font-size: 1.2em;
74}
75span#email {
76}
77span#revision {
78 font-family: sans-serif;
79}
80
81div#footer {
82 font-family: sans-serif;
83 font-size: small;
84 border-top: 2px solid silver;
85 padding-top: 0.5em;
86 margin-top: 4.0em;
87}
88div#footer-text {
89 float: left;
90 padding-bottom: 0.5em;
91}
92div#footer-badges {
93 float: right;
94 padding-bottom: 0.5em;
95}
96
97div#preamble,
98div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
99div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
100div.admonitionblock {
101 margin-right: 10%;
102 margin-top: 1.5em;
103 margin-bottom: 1.5em;
104}
105div.admonitionblock {
106 margin-top: 2.5em;
107 margin-bottom: 2.5em;
108}
109
110div.content { /* Block element content. */
111 padding: 0;
112}
113
114/* Block element titles. */
115div.title, caption.title {
116 font-family: sans-serif;
117 font-weight: bold;
118 text-align: left;
119 margin-top: 1.0em;
120 margin-bottom: 0.5em;
121}
122div.title + * {
123 margin-top: 0;
124}
125
126td div.title:first-child {
127 margin-top: 0.0em;
128}
129div.content div.title:first-child {
130 margin-top: 0.0em;
131}
132div.content + div.title {
133 margin-top: 0.0em;
134}
135
136div.sidebarblock > div.content {
137 background: #ffffee;
138 border: 1px solid silver;
139 padding: 0.5em;
140}
141
142div.listingblock > div.content {
143 border: 1px solid silver;
144 background: #f4f4f4;
145 padding: 0.5em;
146}
147
148div.quoteblock > div.content {
149 padding-left: 2.0em;
150}
151div.quoteblock .attribution {
152 text-align: right;
153}
154
155div.admonitionblock .icon {
156 vertical-align: top;
157 font-size: 1.1em;
158 font-weight: bold;
159 text-decoration: underline;
160 color: #527bbd;
161 padding-right: 0.5em;
162}
163div.admonitionblock td.content {
164 padding-left: 0.5em;
165 border-left: 2px solid silver;
166}
167
168div.exampleblock > div.content {
169 border-left: 2px solid silver;
170 padding: 0.5em;
171}
172
173div.verseblock div.content {
174 white-space: pre;
175}
176
177div.imageblock div.content { padding-left: 0; }
178div.imageblock img { border: 1px solid silver; }
179span.image img { border-style: none; }
180
181dl {
182 margin-top: 0.8em;
183 margin-bottom: 0.8em;
184}
185dt {
186 margin-top: 0.5em;
187 margin-bottom: 0;
188 font-style: italic;
189}
190dd > *:first-child {
191 margin-top: 0;
192}
193
194ul, ol {
195 list-style-position: outside;
196}
197ol.olist2 {
198 list-style-type: lower-alpha;
199}
200
201div.tableblock > table {
202 border-color: #527bbd;
203 border-width: 3px;
204}
205thead {
206 font-family: sans-serif;
207 font-weight: bold;
208}
209tfoot {
210 font-weight: bold;
211}
212
213div.hlist {
214 margin-top: 0.8em;
215 margin-bottom: 0.8em;
216}
217td.hlist1 {
218 vertical-align: top;
219 font-style: italic;
220 padding-right: 0.8em;
221}
222td.hlist2 {
223 vertical-align: top;
224}
225
226@media print {
227 div#footer-badges { display: none; }
228}
229include::./stylesheets/xhtml11-manpage.css[]
230/* Workarounds for IE6's broken and incomplete CSS2. */
231
232div.sidebar-content {
233 background: #ffffee;
234 border: 1px solid silver;
235 padding: 0.5em;
236}
237div.sidebar-title, div.image-title {
238 font-family: sans-serif;
239 font-weight: bold;
240 margin-top: 0.0em;
241 margin-bottom: 0.5em;
242}
243
244div.listingblock div.content {
245 border: 1px solid silver;
246 background: #f4f4f4;
247 padding: 0.5em;
248}
249
250div.quoteblock-content {
251 padding-left: 2.0em;
252}
253
254div.exampleblock-content {
255 border-left: 2px solid silver;
256 padding-left: 0.5em;
257}
258</style>
259<title>git-annotate(1)</title>
260</head>
261<body>
262<div id="header">
263<h1>
264git-annotate(1) Manual Page
265</h1>
266<h2>NAME</h2>
267<div class="sectionbody">
268<p>git-annotate -
269 Annotate file lines with commit info
270</p>
271</div>
272</div>
273<h2>SYNOPSIS</h2>
274<div class="sectionbody">
275<p>git-annotate [options] file [revision]</p>
276</div>
277<h2>DESCRIPTION</h2>
278<div class="sectionbody">
279<p>Annotates each line in the given file with information from the commit
280which introduced the line. Optionally annotate from a given revision.</p>
281</div>
282<h2>OPTIONS</h2>
283<div class="sectionbody">
284<dl>
285<dt>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]286-b
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]287</dt>
288<dd>
289<p>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]290 Show blank SHA-1 for boundary commits. This can also
291 be controlled via the <tt>blame.blankboundary</tt> config option.
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]292</p>
293</dd>
294<dt>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]295--root
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]296</dt>
297<dd>
298<p>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]299 Do not treat root commits as boundaries. This can also be
300 controlled via the <tt>blame.showroot</tt> config option.
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]301</p>
302</dd>
303<dt>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]304--show-stats
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]305</dt>
306<dd>
307<p>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]308 Include additional statistics at the end of blame output.
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]309</p>
310</dd>
311<dt>
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]312-L &lt;start&gt;,&lt;end&gt;
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]313</dt>
314<dd>
315<p>
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]316 Annotate only the given line range. &lt;start&gt; and &lt;end&gt; can take
317 one of these forms:
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]318</p>
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]319<ul>
320<li>
321<p>
322number
323</p>
324<p>If &lt;start&gt; or &lt;end&gt; is a number, it specifies an
325absolute line number (lines count from 1).</p>
326</li>
327<li>
328<p>
329/regex/
330</p>
331<p>This form will use the first line matching the given
332POSIX regex. If &lt;end&gt; is a regex, it will search
333starting at the line given by &lt;start&gt;.</p>
334</li>
335<li>
336<p>
337+offset or -offset
338</p>
339<p>This is only valid for &lt;end&gt; and will specify a number
340of lines before or after the line given by &lt;start&gt;.</p>
341</li>
342</ul>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]343</dd>
344<dt>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]345-l
346</dt>
347<dd>
348<p>
349 Show long rev (Default: off).
350</p>
351</dd>
352<dt>
353-t
354</dt>
355<dd>
356<p>
357 Show raw timestamp (Default: off).
358</p>
359</dd>
360<dt>
361-S &lt;revs-file&gt;
362</dt>
363<dd>
364<p>
365 Use revs from revs-file instead of calling <a href="git-rev-list.html">git-rev-list(1)</a>.
366</p>
367</dd>
368<dt>
369-p, --porcelain
370</dt>
371<dd>
372<p>
373 Show in a format designed for machine consumption.
374</p>
375</dd>
376<dt>
377--incremental
378</dt>
379<dd>
380<p>
381 Show the result incrementally in a format designed for
382 machine consumption.
383</p>
384</dd>
385<dt>
386--contents &lt;file&gt;
387</dt>
388<dd>
389<p>
390 When &lt;rev&gt; is not specified, the command annotates the
391 changes starting backwards from the working tree copy.
392 This flag makes the command pretend as if the working
Junio C Hamano49dccaf2008-02-10 10:48:01[diff] [blame]393 tree copy has the contents of the named file (specify
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]394 <tt>-</tt> to make the command read from the standard input).
395</p>
396</dd>
397<dt>
398-M|&lt;num&gt;|
399</dt>
400<dd>
401<p>
402 Detect moving lines in the file as well. When a commit
403 moves a block of lines in a file (e.g. the original file
404 has A and then B, and the commit changes it to B and
405 then A), traditional <em>blame</em> algorithm typically blames
406 the lines that were moved up (i.e. B) to the parent and
407 assigns blame to the lines that were moved down (i.e. A)
408 to the child commit. With this option, both groups of lines
409 are blamed on the parent.
410</p>
Junio C Hamanob1d6e882007-08-11 08:30:16[diff] [blame]411<p>&lt;num&gt; is optional but it is the lower bound on the number of
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]412alphanumeric characters that git must detect as moving
413within a file for it to associate those lines with the parent
Junio C Hamanob1d6e882007-08-11 08:30:16[diff] [blame]414commit.</p>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]415</dd>
416<dt>
417-C|&lt;num&gt;|
418</dt>
419<dd>
420<p>
421 In addition to <tt>-M</tt>, detect lines copied from other
422 files that were modified in the same commit. This is
423 useful when you reorganize your program and move code
424 around across files. When this option is given twice,
425 the command looks for copies from all other files in the
426 parent for the commit that creates the file in addition.
427</p>
Junio C Hamanob1d6e882007-08-11 08:30:16[diff] [blame]428<p>&lt;num&gt; is optional but it is the lower bound on the number of
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]429alphanumeric characters that git must detect as moving
430between files for it to associate those lines with the parent
Junio C Hamanob1d6e882007-08-11 08:30:16[diff] [blame]431commit.</p>
Junio C Hamano0e3cb532007-04-17 08:28:11[diff] [blame]432</dd>
433<dt>
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]434-h, --help
435</dt>
436<dd>
437<p>
438 Show help message.
439</p>
440</dd>
441</dl>
442</div>
443<h2>SEE ALSO</h2>
444<div class="sectionbody">
445<p><a href="git-blame.html">git-blame(1)</a></p>
446</div>
447<h2>AUTHOR</h2>
448<div class="sectionbody">
449<p>Written by Ryan Anderson &lt;ryan@michonline.com&gt;.</p>
450</div>
451<h2>GIT</h2>
452<div class="sectionbody">
453<p>Part of the <a href="git.html">git(7)</a> suite</p>
454</div>
455<div id="footer">
456<div id="footer-text">
Junio C Hamano49dccaf2008-02-10 10:48:01[diff] [blame]457Last updated 10-Feb-2008 10:47:41 UTC
Junio C Hamanob33fb4f2006-04-18 21:30:51[diff] [blame]458</div>
459</div>
460</body>
461</html>