OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-blame.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-blame(1)">\r
5 <articleinfo>\r
6     <title>git-blame(1)</title>\r
7         <indexterm>\r
8                 <primary>git-blame(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-blame - Show what revision and author last modified each line of a file</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>git blame</emphasis> [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-p] [-w] [--incremental] [-L n,m]\r
19             [-S &lt;revs-file&gt;] [-M] [-C] [-C] [--since=&lt;date&gt;]\r
20             [&lt;rev&gt; | --contents &lt;file&gt;] [--] &lt;file&gt;</literallayout>\r
21 </blockquote>\r
22 </simplesect>\r
23 <simplesect id="_description">\r
24 <title>DESCRIPTION</title>\r
25 <simpara>Annotates each line in the given file with information from the revision which\r
26 last modified the line. Optionally, start annotating from the given revision.</simpara>\r
27 <simpara>Also it can limit the range of lines annotated.</simpara>\r
28 <simpara>This report doesn&#8217;t tell you anything about lines which have been deleted or\r
29 replaced; you need to use a tool such as <emphasis>git-diff</emphasis> or the "pickaxe"\r
30 interface briefly mentioned in the following paragraph.</simpara>\r
31 <simpara>Apart from supporting file annotation, git also supports searching the\r
32 development history for when a code snippet occurred in a change. This makes it\r
33 possible to track when a code snippet was added to a file, moved or copied\r
34 between files, and eventually deleted or replaced. It works by searching for\r
35 a text string in the diff. A small example:</simpara>\r
36 <literallayout>$ git log --pretty=oneline -S'blame_usage'\r
37 5040f17eba15504bad66b14a645bddd9b015ebb7 blame -S &lt;ancestry-file&gt;\r
38 ea4c7f9bf69e781dd0cd88d2bccb2bf5cc15c9a7 git-blame: Make the output</literallayout>\r
39 </simplesect>\r
40 <simplesect id="_options">\r
41 <title>OPTIONS</title>\r
42 <variablelist>\r
43 <varlistentry>\r
44 <term>\r
45 -b\r
46 </term>\r
47 <listitem>\r
48 <simpara>\r
49         Show blank SHA-1 for boundary commits.  This can also\r
50         be controlled via the <literal>blame.blankboundary</literal> config option.\r
51 </simpara>\r
52 </listitem>\r
53 </varlistentry>\r
54 <varlistentry>\r
55 <term>\r
56 --root\r
57 </term>\r
58 <listitem>\r
59 <simpara>\r
60         Do not treat root commits as boundaries.  This can also be\r
61         controlled via the <literal>blame.showroot</literal> config option.\r
62 </simpara>\r
63 </listitem>\r
64 </varlistentry>\r
65 <varlistentry>\r
66 <term>\r
67 --show-stats\r
68 </term>\r
69 <listitem>\r
70 <simpara>\r
71         Include additional statistics at the end of blame output.\r
72 </simpara>\r
73 </listitem>\r
74 </varlistentry>\r
75 <varlistentry>\r
76 <term>\r
77 -L &lt;start&gt;,&lt;end&gt;\r
78 </term>\r
79 <listitem>\r
80 <simpara>\r
81         Annotate only the given line range.  &lt;start&gt; and &lt;end&gt; can take\r
82         one of these forms:\r
83 </simpara>\r
84 <itemizedlist>\r
85 <listitem>\r
86 <simpara>\r
87 number\r
88 </simpara>\r
89 <simpara>If &lt;start&gt; or &lt;end&gt; is a number, it specifies an\r
90 absolute line number (lines count from 1).</simpara>\r
91 </listitem>\r
92 <listitem>\r
93 <simpara>\r
94 /regex/\r
95 </simpara>\r
96 <simpara>This form will use the first line matching the given\r
97 POSIX regex.  If &lt;end&gt; is a regex, it will search\r
98 starting at the line given by &lt;start&gt;.</simpara>\r
99 </listitem>\r
100 <listitem>\r
101 <simpara>\r
102 +offset or -offset\r
103 </simpara>\r
104 <simpara>This is only valid for &lt;end&gt; and will specify a number\r
105 of lines before or after the line given by &lt;start&gt;.</simpara>\r
106 </listitem>\r
107 </itemizedlist>\r
108 </listitem>\r
109 </varlistentry>\r
110 <varlistentry>\r
111 <term>\r
112 -l\r
113 </term>\r
114 <listitem>\r
115 <simpara>\r
116         Show long rev (Default: off).\r
117 </simpara>\r
118 </listitem>\r
119 </varlistentry>\r
120 <varlistentry>\r
121 <term>\r
122 -t\r
123 </term>\r
124 <listitem>\r
125 <simpara>\r
126         Show raw timestamp (Default: off).\r
127 </simpara>\r
128 </listitem>\r
129 </varlistentry>\r
130 <varlistentry>\r
131 <term>\r
132 -S &lt;revs-file&gt;\r
133 </term>\r
134 <listitem>\r
135 <simpara>\r
136         Use revs from revs-file instead of calling <xref linkend="git-rev-list(1)"/>.\r
137 </simpara>\r
138 </listitem>\r
139 </varlistentry>\r
140 <varlistentry>\r
141 <term>\r
142 -p\r
143 </term>\r
144 <term>\r
145 --porcelain\r
146 </term>\r
147 <listitem>\r
148 <simpara>\r
149         Show in a format designed for machine consumption.\r
150 </simpara>\r
151 </listitem>\r
152 </varlistentry>\r
153 <varlistentry>\r
154 <term>\r
155 --incremental\r
156 </term>\r
157 <listitem>\r
158 <simpara>\r
159         Show the result incrementally in a format designed for\r
160         machine consumption.\r
161 </simpara>\r
162 </listitem>\r
163 </varlistentry>\r
164 <varlistentry>\r
165 <term>\r
166 --encoding=&lt;encoding&gt;\r
167 </term>\r
168 <listitem>\r
169 <simpara>\r
170         Specifies the encoding used to output author names\r
171         and commit summaries. Setting it to <literal>none</literal> makes blame\r
172         output unconverted data. For more information see the\r
173         discussion about encoding in the <xref linkend="git-log(1)"/>\r
174         manual page.\r
175 </simpara>\r
176 </listitem>\r
177 </varlistentry>\r
178 <varlistentry>\r
179 <term>\r
180 --contents &lt;file&gt;\r
181 </term>\r
182 <listitem>\r
183 <simpara>\r
184         When &lt;rev&gt; is not specified, the command annotates the\r
185         changes starting backwards from the working tree copy.\r
186         This flag makes the command pretend as if the working\r
187         tree copy has the contents of the named file (specify\r
188         <literal>-</literal> to make the command read from the standard input).\r
189 </simpara>\r
190 </listitem>\r
191 </varlistentry>\r
192 <varlistentry>\r
193 <term>\r
194 -M|&lt;num&gt;|\r
195 </term>\r
196 <listitem>\r
197 <simpara>\r
198         Detect moving lines in the file as well.  When a commit\r
199         moves a block of lines in a file (e.g. the original file\r
200         has A and then B, and the commit changes it to B and\r
201         then A), traditional <emphasis>blame</emphasis> algorithm typically blames\r
202         the lines that were moved up (i.e. B) to the parent and\r
203         assigns blame to the lines that were moved down (i.e. A)\r
204         to the child commit.  With this option, both groups of lines\r
205         are blamed on the parent.\r
206 </simpara>\r
207 <simpara>&lt;num&gt; is optional but it is the lower bound on the number of\r
208 alphanumeric characters that git must detect as moving\r
209 within a file for it to associate those lines with the parent\r
210 commit.</simpara>\r
211 </listitem>\r
212 </varlistentry>\r
213 <varlistentry>\r
214 <term>\r
215 -C|&lt;num&gt;|\r
216 </term>\r
217 <listitem>\r
218 <simpara>\r
219         In addition to <literal>-M</literal>, detect lines copied from other\r
220         files that were modified in the same commit.  This is\r
221         useful when you reorganize your program and move code\r
222         around across files.  When this option is given twice,\r
223         the command looks for copies from all other files in the\r
224         parent for the commit that creates the file in addition.\r
225 </simpara>\r
226 <simpara>&lt;num&gt; is optional but it is the lower bound on the number of\r
227 alphanumeric characters that git must detect as moving\r
228 between files for it to associate those lines with the parent\r
229 commit.</simpara>\r
230 </listitem>\r
231 </varlistentry>\r
232 <varlistentry>\r
233 <term>\r
234 -h\r
235 </term>\r
236 <term>\r
237 --help\r
238 </term>\r
239 <listitem>\r
240 <simpara>\r
241         Show help message.\r
242 </simpara>\r
243 </listitem>\r
244 </varlistentry>\r
245 <varlistentry>\r
246 <term>\r
247 -c\r
248 </term>\r
249 <listitem>\r
250 <simpara>\r
251         Use the same output mode as <xref linkend="git-annotate(1)"/> (Default: off).\r
252 </simpara>\r
253 </listitem>\r
254 </varlistentry>\r
255 <varlistentry>\r
256 <term>\r
257 --score-debug\r
258 </term>\r
259 <listitem>\r
260 <simpara>\r
261         Include debugging information related to the movement of\r
262         lines between files (see <literal>-C</literal>) and lines moved within a\r
263         file (see <literal>-M</literal>).  The first number listed is the score.\r
264         This is the number of alphanumeric characters detected\r
265         to be moved between or within files.  This must be above\r
266         a certain threshold for <emphasis>git-blame</emphasis> to consider those lines\r
267         of code to have been moved.\r
268 </simpara>\r
269 </listitem>\r
270 </varlistentry>\r
271 <varlistentry>\r
272 <term>\r
273 -f\r
274 </term>\r
275 <term>\r
276 --show-name\r
277 </term>\r
278 <listitem>\r
279 <simpara>\r
280         Show filename in the original commit.  By default\r
281         filename is shown if there is any line that came from a\r
282         file with different name, due to rename detection.\r
283 </simpara>\r
284 </listitem>\r
285 </varlistentry>\r
286 <varlistentry>\r
287 <term>\r
288 -n\r
289 </term>\r
290 <term>\r
291 --show-number\r
292 </term>\r
293 <listitem>\r
294 <simpara>\r
295         Show line number in the original commit (Default: off).\r
296 </simpara>\r
297 </listitem>\r
298 </varlistentry>\r
299 <varlistentry>\r
300 <term>\r
301 -s\r
302 </term>\r
303 <listitem>\r
304 <simpara>\r
305         Suppress author name and timestamp from the output.\r
306 </simpara>\r
307 </listitem>\r
308 </varlistentry>\r
309 <varlistentry>\r
310 <term>\r
311 -w\r
312 </term>\r
313 <listitem>\r
314 <simpara>\r
315         Ignore whitespace when comparing parent&#8217;s version and\r
316         child&#8217;s to find where the lines came from.\r
317 </simpara>\r
318 </listitem>\r
319 </varlistentry>\r
320 </variablelist>\r
321 </simplesect>\r
322 <simplesect id="_the_porcelain_format">\r
323 <title>THE PORCELAIN FORMAT</title>\r
324 <simpara>In this format, each line is output after a header; the\r
325 header at the minimum has the first line which has:</simpara>\r
326 <itemizedlist>\r
327 <listitem>\r
328 <simpara>\r
329 40-byte SHA-1 of the commit the line is attributed to;\r
330 </simpara>\r
331 </listitem>\r
332 <listitem>\r
333 <simpara>\r
334 the line number of the line in the original file;\r
335 </simpara>\r
336 </listitem>\r
337 <listitem>\r
338 <simpara>\r
339 the line number of the line in the final file;\r
340 </simpara>\r
341 </listitem>\r
342 <listitem>\r
343 <simpara>\r
344 on a line that starts a group of line from a different\r
345   commit than the previous one, the number of lines in this\r
346   group.  On subsequent lines this field is absent.\r
347 </simpara>\r
348 </listitem>\r
349 </itemizedlist>\r
350 <simpara>This header line is followed by the following information\r
351 at least once for each commit:</simpara>\r
352 <itemizedlist>\r
353 <listitem>\r
354 <simpara>\r
355 author name ("author"), email ("author-mail"), time\r
356   ("author-time"), and timezone ("author-tz"); similarly\r
357   for committer.\r
358 </simpara>\r
359 </listitem>\r
360 <listitem>\r
361 <simpara>\r
362 filename in the commit the line is attributed to.\r
363 </simpara>\r
364 </listitem>\r
365 <listitem>\r
366 <simpara>\r
367 the first line of the commit log message ("summary").\r
368 </simpara>\r
369 </listitem>\r
370 </itemizedlist>\r
371 <simpara>The contents of the actual line is output after the above\r
372 header, prefixed by a TAB. This is to allow adding more\r
373 header elements later.</simpara>\r
374 </simplesect>\r
375 <simplesect id="_specifying_ranges">\r
376 <title>SPECIFYING RANGES</title>\r
377 <simpara>Unlike <emphasis>git-blame</emphasis> and <emphasis>git-annotate</emphasis> in older git, the extent\r
378 of annotation can be limited to both line ranges and revision\r
379 ranges.  When you are interested in finding the origin for\r
380 ll. 40-60 for file <literal>foo</literal>, you can use <literal>-L</literal> option like these\r
381 (they mean the same thing&#8201;&#8212;&#8201;both ask for 21 lines starting at\r
382 line 40):</simpara>\r
383 <literallayout class="monospaced">git blame -L 40,60 foo\r
384 git blame -L 40,+21 foo</literallayout>\r
385 <simpara>Also you can use regular expression to specify the line range.</simpara>\r
386 <literallayout class="monospaced">git blame -L '/^sub hello {/,/^}$/' foo</literallayout>\r
387 <simpara>would limit the annotation to the body of <literal>hello</literal> subroutine.</simpara>\r
388 <simpara>When you are not interested in changes older than the version\r
389 v2.6.18, or changes older than 3 weeks, you can use revision\r
390 range specifiers  similar to <emphasis>git-rev-list</emphasis>:</simpara>\r
391 <literallayout class="monospaced">git blame v2.6.18.. -- foo\r
392 git blame --since=3.weeks -- foo</literallayout>\r
393 <simpara>When revision range specifiers are used to limit the annotation,\r
394 lines that have not changed since the range boundary (either the\r
395 commit v2.6.18 or the most recent commit that is more than 3\r
396 weeks old in the above example) are blamed for that range\r
397 boundary commit.</simpara>\r
398 <simpara>A particularly useful way is to see if an added file have lines\r
399 created by copy-and-paste from existing files.  Sometimes this\r
400 indicates that the developer was being sloppy and did not\r
401 refactor the code properly.  You can first find the commit that\r
402 introduced the file with:</simpara>\r
403 <literallayout class="monospaced">git log --diff-filter=A --pretty=short -- foo</literallayout>\r
404 <simpara>and then annotate the change between the commit and its\r
405 parents, using <literal>commit&#94;!</literal> notation:</simpara>\r
406 <literallayout class="monospaced">git blame -C -C -f $commit^! -- foo</literallayout>\r
407 </simplesect>\r
408 <simplesect id="_incremental_output">\r
409 <title>INCREMENTAL OUTPUT</title>\r
410 <simpara>When called with <literal>--incremental</literal> option, the command outputs the\r
411 result as it is built.  The output generally will talk about\r
412 lines touched by more recent commits first (i.e. the lines will\r
413 be annotated out of order) and is meant to be used by\r
414 interactive viewers.</simpara>\r
415 <simpara>The output format is similar to the Porcelain format, but it\r
416 does not contain the actual lines from the file that is being\r
417 annotated.</simpara>\r
418 <orderedlist numeration="arabic">\r
419 <listitem>\r
420 <simpara>\r
421 Each blame entry always starts with a line of:\r
422 </simpara>\r
423 <literallayout class="monospaced">&lt;40-byte hex sha1&gt; &lt;sourceline&gt; &lt;resultline&gt; &lt;num_lines&gt;</literallayout>\r
424 <simpara>Line numbers count from 1.</simpara>\r
425 </listitem>\r
426 <listitem>\r
427 <simpara>\r
428 The first time that commit shows up in the stream, it has various\r
429   other information about it printed out with a one-word tag at the\r
430   beginning of each line about that "extended commit info" (author,\r
431   email, committer, dates, summary etc).\r
432 </simpara>\r
433 </listitem>\r
434 <listitem>\r
435 <simpara>\r
436 Unlike Porcelain format, the filename information is always\r
437   given and terminates the entry:\r
438 </simpara>\r
439 <literallayout class="monospaced">"filename" &lt;whitespace-quoted-filename-goes-here&gt;</literallayout>\r
440 <simpara>and thus it&#8217;s really quite easy to parse for some line- and word-oriented\r
441 parser (which should be quite natural for most scripting languages).</simpara>\r
442 <note><simpara>For people who do parsing: to make it more robust, just ignore any\r
443 lines in between the first and last one ("&lt;sha1&gt;" and "filename" lines)\r
444 where you don&#8217;t recognize the tag-words (or care about that particular\r
445 one) at the beginning of the "extended information" lines. That way, if\r
446 there is ever added information (like the commit encoding or extended\r
447 commit commentary), a blame viewer won&#8217;t ever care.</simpara></note>\r
448 </listitem>\r
449 </orderedlist>\r
450 </simplesect>\r
451 <simplesect id="_see_also">\r
452 <title>SEE ALSO</title>\r
453 <simpara><xref linkend="git-annotate(1)"/></simpara>\r
454 </simplesect>\r
455 <simplesect id="_author">\r
456 <title>AUTHOR</title>\r
457 <simpara>Written by Junio C Hamano &lt;<ulink url="mailto:gitster@pobox.com">gitster@pobox.com</ulink>&gt;</simpara>\r
458 </simplesect>\r
459 <simplesect id="_git">\r
460 <title>GIT</title>\r
461 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
462 </simplesect>\r
463 </article>\r