Autogenerated manpages for v2.38.0-15-gbbe21
[git-manpages.git] / man1 / git-blame.1
blobc5326d879bb2766fcf4492090fc499d73e2078c6
1 '\" t
2 .\"     Title: git-blame
3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\"      Date: 10/07/2022
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.38.0.15.gbbe21b64a0
8 .\"  Language: English
9 .\"
10 .TH "GIT\-BLAME" "1" "10/07/2022" "Git 2\&.38\&.0\&.15\&.gbbe21b6" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-blame \- Show what revision and author last modified each line of a file
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit blame\fR [\-c] [\-b] [\-l] [\-\-root] [\-t] [\-f] [\-n] [\-s] [\-e] [\-p] [\-w] [\-\-incremental]
36             [\-L <range>] [\-S <revs\-file>] [\-M] [\-C] [\-C] [\-C] [\-\-since=<date>]
37             [\-\-ignore\-rev <rev>] [\-\-ignore\-revs\-file <file>]
38             [\-\-color\-lines] [\-\-color\-by\-age] [\-\-progress] [\-\-abbrev=<n>]
39             [<rev> | \-\-contents <file> | \-\-reverse <rev>\&.\&.<rev>] [\-\-] <file>
40 .fi
41 .sp
42 .SH "DESCRIPTION"
43 .sp
44 Annotates each line in the given file with information from the revision which last modified the line\&. Optionally, start annotating from the given revision\&.
45 .sp
46 When specified one or more times, \fB\-L\fR restricts annotation to the requested lines\&.
47 .sp
48 The origin of lines is automatically followed across whole\-file renames (currently there is no option to turn the rename\-following off)\&. To follow lines moved from one file to another, or to follow lines that were copied and pasted from another file, etc\&., see the \fB\-C\fR and \fB\-M\fR options\&.
49 .sp
50 The report does not tell you anything about lines which have been deleted or replaced; you need to use a tool such as \fIgit diff\fR or the "pickaxe" interface briefly mentioned in the following paragraph\&.
51 .sp
52 Apart from supporting file annotation, Git also supports searching the development history for when a code snippet occurred in a change\&. This makes it possible to track when a code snippet was added to a file, moved or copied between files, and eventually deleted or replaced\&. It works by searching for a text string in the diff\&. A small example of the pickaxe interface that searches for \fBblame_usage\fR:
53 .sp
54 .if n \{\
55 .RS 4
56 .\}
57 .nf
58 $ git log \-\-pretty=oneline \-S\(aqblame_usage\(aq
59 5040f17eba15504bad66b14a645bddd9b015ebb7 blame \-S <ancestry\-file>
60 ea4c7f9bf69e781dd0cd88d2bccb2bf5cc15c9a7 git\-blame: Make the output
61 .fi
62 .if n \{\
63 .RE
64 .\}
65 .sp
66 .SH "OPTIONS"
67 .PP
68 \-b
69 .RS 4
70 Show blank SHA\-1 for boundary commits\&. This can also be controlled via the
71 \fBblame\&.blankBoundary\fR
72 config option\&.
73 .RE
74 .PP
75 \-\-root
76 .RS 4
77 Do not treat root commits as boundaries\&. This can also be controlled via the
78 \fBblame\&.showRoot\fR
79 config option\&.
80 .RE
81 .PP
82 \-\-show\-stats
83 .RS 4
84 Include additional statistics at the end of blame output\&.
85 .RE
86 .PP
87 \-L <start>,<end>, \-L :<funcname>
88 .RS 4
89 Annotate only the line range given by
90 \fI<start>,<end>\fR, or by the function name regex
91 \fI<funcname>\fR\&. May be specified multiple times\&. Overlapping ranges are allowed\&.
92 .sp
93 \fI<start>\fR
94 and
95 \fI<end>\fR
96 are optional\&.
97 \fB\-L <start>\fR
99 \fB\-L <start>,\fR
100 spans from
101 \fI<start>\fR
102 to end of file\&.
103 \fB\-L ,<end>\fR
104 spans from start of file to
105 \fI<end>\fR\&.
107 \fI<start>\fR
109 \fI<end>\fR
110 can take one of these forms:
112 .RS 4
113 .ie n \{\
114 \h'-04'\(bu\h'+03'\c
116 .el \{\
117 .sp -1
118 .IP \(bu 2.3
120 number
123 \fI<start>\fR
125 \fI<end>\fR
126 is a number, it specifies an absolute line number (lines count from 1)\&.
129 .RS 4
130 .ie n \{\
131 \h'-04'\(bu\h'+03'\c
133 .el \{\
134 .sp -1
135 .IP \(bu 2.3
137 \fB/regex/\fR
139 This form will use the first line matching the given POSIX regex\&. If
140 \fI<start>\fR
141 is a regex, it will search from the end of the previous
142 \fB\-L\fR
143 range, if any, otherwise from the start of file\&. If
144 \fI<start>\fR
146 \fB^/regex/\fR, it will search from the start of file\&. If
147 \fI<end>\fR
148 is a regex, it will search starting at the line given by
149 \fI<start>\fR\&.
152 .RS 4
153 .ie n \{\
154 \h'-04'\(bu\h'+03'\c
156 .el \{\
157 .sp -1
158 .IP \(bu 2.3
160 +offset or \-offset
162 This is only valid for
163 \fI<end>\fR
164 and will specify a number of lines before or after the line given by
165 \fI<start>\fR\&.
169 \fB:<funcname>\fR
170 is given in place of
171 \fI<start>\fR
173 \fI<end>\fR, it is a regular expression that denotes the range from the first funcname line that matches
174 \fI<funcname>\fR, up to the next funcname line\&.
175 \fB:<funcname>\fR
176 searches from the end of the previous
177 \fB\-L\fR
178 range, if any, otherwise from the start of file\&.
179 \fB^:<funcname>\fR
180 searches from the start of file\&. The function names are determined in the same way as
181 \fBgit diff\fR
182 works out patch hunk headers (see
183 \fIDefining a custom hunk\-header\fR
185 \fBgitattributes\fR(5))\&.
189 .RS 4
190 Show long rev (Default: off)\&.
194 .RS 4
195 Show raw timestamp (Default: off)\&.
198 \-S <revs\-file>
199 .RS 4
200 Use revisions from revs\-file instead of calling
201 \fBgit-rev-list\fR(1)\&.
204 \-\-reverse <rev>\&.\&.<rev>
205 .RS 4
206 Walk history forward instead of backward\&. Instead of showing the revision in which a line appeared, this shows the last revision in which a line has existed\&. This requires a range of revision like START\&.\&.END where the path to blame exists in START\&.
207 \fBgit blame \-\-reverse START\fR
208 is taken as
209 \fBgit blame \-\-reverse START\&.\&.HEAD\fR
210 for convenience\&.
213 \-\-first\-parent
214 .RS 4
215 Follow only the first parent commit upon seeing a merge commit\&. This option can be used to determine when a line was introduced to a particular integration branch, rather than when it was introduced to the history overall\&.
218 \-p, \-\-porcelain
219 .RS 4
220 Show in a format designed for machine consumption\&.
223 \-\-line\-porcelain
224 .RS 4
225 Show the porcelain format, but output commit information for each line, not just the first time a commit is referenced\&. Implies \-\-porcelain\&.
228 \-\-incremental
229 .RS 4
230 Show the result incrementally in a format designed for machine consumption\&.
233 \-\-encoding=<encoding>
234 .RS 4
235 Specifies the encoding used to output author names and commit summaries\&. Setting it to
236 \fBnone\fR
237 makes blame output unconverted data\&. For more information see the discussion about encoding in the
238 \fBgit-log\fR(1)
239 manual page\&.
242 \-\-contents <file>
243 .RS 4
244 When <rev> is not specified, the command annotates the changes starting backwards from the working tree copy\&. This flag makes the command pretend as if the working tree copy has the contents of the named file (specify
245 \fB\-\fR
246 to make the command read from the standard input)\&.
249 \-\-date <format>
250 .RS 4
251 Specifies the format used to output dates\&. If \-\-date is not provided, the value of the blame\&.date config variable is used\&. If the blame\&.date config variable is also not set, the iso format is used\&. For supported values, see the discussion of the \-\-date option at
252 \fBgit-log\fR(1)\&.
255 \-\-[no\-]progress
256 .RS 4
257 Progress status is reported on the standard error stream by default when it is attached to a terminal\&. This flag enables progress reporting even if not attached to a terminal\&. Can\(cqt use
258 \fB\-\-progress\fR
259 together with
260 \fB\-\-porcelain\fR
262 \fB\-\-incremental\fR\&.
265 \-M[<num>]
266 .RS 4
267 Detect moved or copied lines within a file\&. When a commit moves or copies a block of lines (e\&.g\&. the original file has A and then B, and the commit changes it to B and then A), the traditional
268 \fIblame\fR
269 algorithm notices only half of the movement and typically blames the lines that were moved up (i\&.e\&. B) to the parent and assigns blame to the lines that were moved down (i\&.e\&. A) to the child commit\&. With this option, both groups of lines are blamed on the parent by running extra passes of inspection\&.
271 <num> is optional but it is the lower bound on the number of alphanumeric characters that Git must detect as moving/copying within a file for it to associate those lines with the parent commit\&. The default value is 20\&.
274 \-C[<num>]
275 .RS 4
276 In addition to
277 \fB\-M\fR, detect lines moved or copied from other files that were modified in the same commit\&. This is useful when you reorganize your program and move code around across files\&. When this option is given twice, the command additionally looks for copies from other files in the commit that creates the file\&. When this option is given three times, the command additionally looks for copies from other files in any commit\&.
279 <num> is optional but it is the lower bound on the number of alphanumeric characters that Git must detect as moving/copying between files for it to associate those lines with the parent commit\&. And the default value is 40\&. If there are more than one
280 \fB\-C\fR
281 options given, the <num> argument of the last
282 \fB\-C\fR
283 will take effect\&.
286 \-\-ignore\-rev <rev>
287 .RS 4
288 Ignore changes made by the revision when assigning blame, as if the change never happened\&. Lines that were changed or added by an ignored commit will be blamed on the previous commit that changed that line or nearby lines\&. This option may be specified multiple times to ignore more than one revision\&. If the
289 \fBblame\&.markIgnoredLines\fR
290 config option is set, then lines that were changed by an ignored commit and attributed to another commit will be marked with a
291 \fB?\fR
292 in the blame output\&. If the
293 \fBblame\&.markUnblamableLines\fR
294 config option is set, then those lines touched by an ignored commit that we could not attribute to another revision are marked with a
295 \fI*\fR\&.
298 \-\-ignore\-revs\-file <file>
299 .RS 4
300 Ignore revisions listed in
301 \fBfile\fR, which must be in the same format as an
302 \fBfsck\&.skipList\fR\&. This option may be repeated, and these files will be processed after any files specified with the
303 \fBblame\&.ignoreRevsFile\fR
304 config option\&. An empty file name,
305 \fB""\fR, will clear the list of revs from previously processed files\&.
308 \-\-color\-lines
309 .RS 4
310 Color line annotations in the default format differently if they come from the same commit as the preceding line\&. This makes it easier to distinguish code blocks introduced by different commits\&. The color defaults to cyan and can be adjusted using the
311 \fBcolor\&.blame\&.repeatedLines\fR
312 config option\&.
315 \-\-color\-by\-age
316 .RS 4
317 Color line annotations depending on the age of the line in the default format\&. The
318 \fBcolor\&.blame\&.highlightRecent\fR
319 config option controls what color is used for each range of age\&.
323 .RS 4
324 Show help message\&.
328 .RS 4
329 Use the same output mode as
330 \fBgit-annotate\fR(1)
331 (Default: off)\&.
334 \-\-score\-debug
335 .RS 4
336 Include debugging information related to the movement of lines between files (see
337 \fB\-C\fR) and lines moved within a file (see
338 \fB\-M\fR)\&. The first number listed is the score\&. This is the number of alphanumeric characters detected as having been moved between or within files\&. This must be above a certain threshold for
339 \fIgit blame\fR
340 to consider those lines of code to have been moved\&.
343 \-f, \-\-show\-name
344 .RS 4
345 Show the filename in the original commit\&. By default the filename is shown if there is any line that came from a file with a different name, due to rename detection\&.
348 \-n, \-\-show\-number
349 .RS 4
350 Show the line number in the original commit (Default: off)\&.
354 .RS 4
355 Suppress the author name and timestamp from the output\&.
358 \-e, \-\-show\-email
359 .RS 4
360 Show the author email instead of author name (Default: off)\&. This can also be controlled via the
361 \fBblame\&.showEmail\fR
362 config option\&.
366 .RS 4
367 Ignore whitespace when comparing the parent\(cqs version and the child\(cqs to find where the lines came from\&.
370 \-\-abbrev=<n>
371 .RS 4
372 Instead of using the default 7+1 hexadecimal digits as the abbreviated object name, use <m>+1 digits, where <m> is at least <n> but ensures the commit object names are unique\&. Note that 1 column is used for a caret to mark the boundary commit\&.
374 .SH "THE DEFAULT FORMAT"
376 When neither \fB\-\-porcelain\fR nor \fB\-\-incremental\fR option is specified, \fBgit blame\fR will output annotation for each line with:
378 .RS 4
379 .ie n \{\
380 \h'-04'\(bu\h'+03'\c
382 .el \{\
383 .sp -1
384 .IP \(bu 2.3
386 abbreviated object name for the commit the line came from;
389 .RS 4
390 .ie n \{\
391 \h'-04'\(bu\h'+03'\c
393 .el \{\
394 .sp -1
395 .IP \(bu 2.3
397 author ident (by default author name and date, unless
398 \fB\-s\fR
400 \fB\-e\fR
401 is specified); and
404 .RS 4
405 .ie n \{\
406 \h'-04'\(bu\h'+03'\c
408 .el \{\
409 .sp -1
410 .IP \(bu 2.3
412 line number
415 before the line contents\&.
416 .SH "THE PORCELAIN FORMAT"
418 In this format, each line is output after a header; the header at the minimum has the first line which has:
420 .RS 4
421 .ie n \{\
422 \h'-04'\(bu\h'+03'\c
424 .el \{\
425 .sp -1
426 .IP \(bu 2.3
428 40\-byte SHA\-1 of the commit the line is attributed to;
431 .RS 4
432 .ie n \{\
433 \h'-04'\(bu\h'+03'\c
435 .el \{\
436 .sp -1
437 .IP \(bu 2.3
439 the line number of the line in the original file;
442 .RS 4
443 .ie n \{\
444 \h'-04'\(bu\h'+03'\c
446 .el \{\
447 .sp -1
448 .IP \(bu 2.3
450 the line number of the line in the final file;
453 .RS 4
454 .ie n \{\
455 \h'-04'\(bu\h'+03'\c
457 .el \{\
458 .sp -1
459 .IP \(bu 2.3
461 on a line that starts a group of lines from a different commit than the previous one, the number of lines in this group\&. On subsequent lines this field is absent\&.
464 This header line is followed by the following information at least once for each commit:
466 .RS 4
467 .ie n \{\
468 \h'-04'\(bu\h'+03'\c
470 .el \{\
471 .sp -1
472 .IP \(bu 2.3
474 the author name ("author"), email ("author\-mail"), time ("author\-time"), and time zone ("author\-tz"); similarly for committer\&.
477 .RS 4
478 .ie n \{\
479 \h'-04'\(bu\h'+03'\c
481 .el \{\
482 .sp -1
483 .IP \(bu 2.3
485 the filename in the commit that the line is attributed to\&.
488 .RS 4
489 .ie n \{\
490 \h'-04'\(bu\h'+03'\c
492 .el \{\
493 .sp -1
494 .IP \(bu 2.3
496 the first line of the commit log message ("summary")\&.
499 The contents of the actual line is output after the above header, prefixed by a TAB\&. This is to allow adding more header elements later\&.
501 The porcelain format generally suppresses commit information that has already been seen\&. For example, two lines that are blamed to the same commit will both be shown, but the details for that commit will be shown only once\&. This is more efficient, but may require more state be kept by the reader\&. The \fB\-\-line\-porcelain\fR option can be used to output full commit information for each line, allowing simpler (but less efficient) usage like:
503 .if n \{\
504 .RS 4
507 # count the number of lines attributed to each author
508 git blame \-\-line\-porcelain file |
509 sed \-n \(aqs/^author //p\(aq |
510 sort | uniq \-c | sort \-rn
512 .if n \{\
515 .SH "SPECIFYING RANGES"
517 Unlike \fIgit blame\fR and \fIgit annotate\fR in older versions of git, the extent of the annotation can be limited to both line ranges and revision ranges\&. The \fB\-L\fR option, which limits annotation to a range of lines, may be specified multiple times\&.
519 When you are interested in finding the origin for lines 40\-60 for file \fBfoo\fR, you can use the \fB\-L\fR option like so (they mean the same thing \(em both ask for 21 lines starting at line 40):
521 .if n \{\
522 .RS 4
525 git blame \-L 40,60 foo
526 git blame \-L 40,+21 foo
528 .if n \{\
532 Also you can use a regular expression to specify the line range:
534 .if n \{\
535 .RS 4
538 git blame \-L \(aq/^sub hello {/,/^}$/\(aq foo
540 .if n \{\
544 which limits the annotation to the body of the \fBhello\fR subroutine\&.
546 When you are not interested in changes older than version v2\&.6\&.18, or changes older than 3 weeks, you can use revision range specifiers similar to \fIgit rev\-list\fR:
548 .if n \{\
549 .RS 4
552 git blame v2\&.6\&.18\&.\&. \-\- foo
553 git blame \-\-since=3\&.weeks \-\- foo
555 .if n \{\
559 When revision range specifiers are used to limit the annotation, lines that have not changed since the range boundary (either the commit v2\&.6\&.18 or the most recent commit that is more than 3 weeks old in the above example) are blamed for that range boundary commit\&.
561 A particularly useful way is to see if an added file has lines created by copy\-and\-paste from existing files\&. Sometimes this indicates that the developer was being sloppy and did not refactor the code properly\&. You can first find the commit that introduced the file with:
563 .if n \{\
564 .RS 4
567 git log \-\-diff\-filter=A \-\-pretty=short \-\- foo
569 .if n \{\
573 and then annotate the change between the commit and its parents, using \fBcommit^!\fR notation:
575 .if n \{\
576 .RS 4
579 git blame \-C \-C \-f $commit^! \-\- foo
581 .if n \{\
584 .SH "INCREMENTAL OUTPUT"
586 When called with \fB\-\-incremental\fR option, the command outputs the result as it is built\&. The output generally will talk about lines touched by more recent commits first (i\&.e\&. the lines will be annotated out of order) and is meant to be used by interactive viewers\&.
588 The output format is similar to the Porcelain format, but it does not contain the actual lines from the file that is being annotated\&.
590 .RS 4
591 .ie n \{\
592 \h'-04' 1.\h'+01'\c
594 .el \{\
595 .sp -1
596 .IP "  1." 4.2
598 Each blame entry always starts with a line of:
600 .if n \{\
601 .RS 4
604 <40\-byte hex sha1> <sourceline> <resultline> <num_lines>
606 .if n \{\
610 Line numbers count from 1\&.
613 .RS 4
614 .ie n \{\
615 \h'-04' 2.\h'+01'\c
617 .el \{\
618 .sp -1
619 .IP "  2." 4.2
621 The first time that a commit shows up in the stream, it has various other information about it printed out with a one\-word tag at the beginning of each line describing the extra commit information (author, email, committer, dates, summary, etc\&.)\&.
624 .RS 4
625 .ie n \{\
626 \h'-04' 3.\h'+01'\c
628 .el \{\
629 .sp -1
630 .IP "  3." 4.2
632 Unlike the Porcelain format, the filename information is always given and terminates the entry:
634 .if n \{\
635 .RS 4
638 "filename" <whitespace\-quoted\-filename\-goes\-here>
640 .if n \{\
644 and thus it is really quite easy to parse for some line\- and word\-oriented parser (which should be quite natural for most scripting languages)\&.
645 .if n \{\
648 .RS 4
649 .it 1 an-trap
650 .nr an-no-space-flag 1
651 .nr an-break-flag 1
653 .ps +1
654 \fBNote\fR
655 .ps -1
657 For people who do parsing: to make it more robust, just ignore any lines between the first and last one ("<sha1>" and "filename" lines) where you do not recognize the tag words (or care about that particular one) at the beginning of the "extended information" lines\&. That way, if there is ever added information (like the commit encoding or extended commit commentary), a blame viewer will not care\&.
658 .sp .5v
661 .SH "MAPPING AUTHORS"
663 See \fBgitmailmap\fR(5)\&.
664 .SH "CONFIGURATION"
666 Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
668 blame\&.blankBoundary
669 .RS 4
670 Show blank commit object name for boundary commits in
671 \fBgit-blame\fR(1)\&. This option defaults to false\&.
674 blame\&.coloring
675 .RS 4
676 This determines the coloring scheme to be applied to blame output\&. It can be
677 \fIrepeatedLines\fR,
678 \fIhighlightRecent\fR, or
679 \fInone\fR
680 which is the default\&.
683 blame\&.date
684 .RS 4
685 Specifies the format used to output dates in
686 \fBgit-blame\fR(1)\&. If unset the iso format is used\&. For supported values, see the discussion of the
687 \fB\-\-date\fR
688 option at
689 \fBgit-log\fR(1)\&.
692 blame\&.showEmail
693 .RS 4
694 Show the author email instead of author name in
695 \fBgit-blame\fR(1)\&. This option defaults to false\&.
698 blame\&.showRoot
699 .RS 4
700 Do not treat root commits as boundaries in
701 \fBgit-blame\fR(1)\&. This option defaults to false\&.
704 blame\&.ignoreRevsFile
705 .RS 4
706 Ignore revisions listed in the file, one unabbreviated object name per line, in
707 \fBgit-blame\fR(1)\&. Whitespace and comments beginning with
708 \fB#\fR
709 are ignored\&. This option may be repeated multiple times\&. Empty file names will reset the list of ignored revisions\&. This option will be handled before the command line option
710 \fB\-\-ignore\-revs\-file\fR\&.
713 blame\&.markUnblamableLines
714 .RS 4
715 Mark lines that were changed by an ignored revision that we could not attribute to another commit with a
716 \fI*\fR
717 in the output of
718 \fBgit-blame\fR(1)\&.
721 blame\&.markIgnoredLines
722 .RS 4
723 Mark lines that were changed by an ignored revision that we attributed to another commit with a
724 \fI?\fR
725 in the output of
726 \fBgit-blame\fR(1)\&.
728 .SH "SEE ALSO"
730 \fBgit-annotate\fR(1)
731 .SH "GIT"
733 Part of the \fBgit\fR(1) suite