Move setup_diff_pager to libgit.a
[git/jnareb-git.git] / Documentation / git-blame.txt
blobe44173f66afa9e1e1656e7b388fd707c417a1d28
1 git-blame(1)
2 ============
4 NAME
5 ----
6 git-blame - Show what revision and author last modified each line of a file
8 SYNOPSIS
9 --------
10 [verse]
11 'git blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w] [--incremental] [-L n,m]
12             [-S <revs-file>] [-M] [-C] [-C] [-C] [--since=<date>] [--abbrev=<n>]
13             [<rev> | --contents <file> | --reverse <rev>] [--] <file>
15 DESCRIPTION
16 -----------
18 Annotates each line in the given file with information from the revision which
19 last modified the line. Optionally, start annotating from the given revision.
21 The command can also limit the range of lines annotated.
23 The origin of lines is automatically followed across whole-file
24 renames (currently there is no option to turn the rename-following
25 off). To follow lines moved from one file to another, or to follow
26 lines that were copied and pasted from another file, etc., see the
27 `-C` and `-M` options.
29 The report does not tell you anything about lines which have been deleted or
30 replaced; you need to use a tool such as 'git diff' or the "pickaxe"
31 interface briefly mentioned in the following paragraph.
33 Apart from supporting file annotation, git also supports searching the
34 development history for when a code snippet occurred in a change. This makes it
35 possible to track when a code snippet was added to a file, moved or copied
36 between files, and eventually deleted or replaced. It works by searching for
37 a text string in the diff. A small example:
39 -----------------------------------------------------------------------------
40 $ git log --pretty=oneline -S'blame_usage'
41 5040f17eba15504bad66b14a645bddd9b015ebb7 blame -S <ancestry-file>
42 ea4c7f9bf69e781dd0cd88d2bccb2bf5cc15c9a7 git-blame: Make the output
43 -----------------------------------------------------------------------------
45 OPTIONS
46 -------
47 include::blame-options.txt[]
49 -c::
50         Use the same output mode as linkgit:git-annotate[1] (Default: off).
52 --score-debug::
53         Include debugging information related to the movement of
54         lines between files (see `-C`) and lines moved within a
55         file (see `-M`).  The first number listed is the score.
56         This is the number of alphanumeric characters detected
57         as having been moved between or within files.  This must be above
58         a certain threshold for 'git blame' to consider those lines
59         of code to have been moved.
61 -f::
62 --show-name::
63         Show the filename in the original commit.  By default
64         the filename is shown if there is any line that came from a
65         file with a different name, due to rename detection.
67 -n::
68 --show-number::
69         Show the line number in the original commit (Default: off).
71 -s::
72         Suppress the author name and timestamp from the output.
74 -e::
75 --show-email::
76         Show the author email instead of author name (Default: off).
78 -w::
79         Ignore whitespace when comparing the parent's version and
80         the child's to find where the lines came from.
82 --abbrev=<n>::
83         Instead of using the default 7+1 hexadecimal digits as the
84         abbreviated object name, use <n>+1 digits. Note that 1 column
85         is used for a caret to mark the boundary commit.
88 THE PORCELAIN FORMAT
89 --------------------
91 In this format, each line is output after a header; the
92 header at the minimum has the first line which has:
94 - 40-byte SHA-1 of the commit the line is attributed to;
95 - the line number of the line in the original file;
96 - the line number of the line in the final file;
97 - on a line that starts a group of lines from a different
98   commit than the previous one, the number of lines in this
99   group.  On subsequent lines this field is absent.
101 This header line is followed by the following information
102 at least once for each commit:
104 - the author name ("author"), email ("author-mail"), time
105   ("author-time"), and timezone ("author-tz"); similarly
106   for committer.
107 - the filename in the commit that the line is attributed to.
108 - the first line of the commit log message ("summary").
110 The contents of the actual line is output after the above
111 header, prefixed by a TAB. This is to allow adding more
112 header elements later.
114 The porcelain format generally suppresses commit information that has
115 already been seen. For example, two lines that are blamed to the same
116 commit will both be shown, but the details for that commit will be shown
117 only once. This is more efficient, but may require more state be kept by
118 the reader. The `--line-porcelain` option can be used to output full
119 commit information for each line, allowing simpler (but less efficient)
120 usage like:
122         # count the number of lines attributed to each author
123         git blame --line-porcelain file |
124         sed -n 's/^author //p' |
125         sort | uniq -c | sort -rn
128 SPECIFYING RANGES
129 -----------------
131 Unlike 'git blame' and 'git annotate' in older versions of git, the extent
132 of the annotation can be limited to both line ranges and revision
133 ranges.  When you are interested in finding the origin for
134 lines 40-60 for file `foo`, you can use the `-L` option like so
135 (they mean the same thing -- both ask for 21 lines starting at
136 line 40):
138         git blame -L 40,60 foo
139         git blame -L 40,+21 foo
141 Also you can use a regular expression to specify the line range:
143         git blame -L '/^sub hello {/,/^}$/' foo
145 which limits the annotation to the body of the `hello` subroutine.
147 When you are not interested in changes older than version
148 v2.6.18, or changes older than 3 weeks, you can use revision
149 range specifiers  similar to 'git rev-list':
151         git blame v2.6.18.. -- foo
152         git blame --since=3.weeks -- foo
154 When revision range specifiers are used to limit the annotation,
155 lines that have not changed since the range boundary (either the
156 commit v2.6.18 or the most recent commit that is more than 3
157 weeks old in the above example) are blamed for that range
158 boundary commit.
160 A particularly useful way is to see if an added file has lines
161 created by copy-and-paste from existing files.  Sometimes this
162 indicates that the developer was being sloppy and did not
163 refactor the code properly.  You can first find the commit that
164 introduced the file with:
166         git log --diff-filter=A --pretty=short -- foo
168 and then annotate the change between the commit and its
169 parents, using `commit^!` notation:
171         git blame -C -C -f $commit^! -- foo
174 INCREMENTAL OUTPUT
175 ------------------
177 When called with `--incremental` option, the command outputs the
178 result as it is built.  The output generally will talk about
179 lines touched by more recent commits first (i.e. the lines will
180 be annotated out of order) and is meant to be used by
181 interactive viewers.
183 The output format is similar to the Porcelain format, but it
184 does not contain the actual lines from the file that is being
185 annotated.
187 . Each blame entry always starts with a line of:
189         <40-byte hex sha1> <sourceline> <resultline> <num_lines>
191 Line numbers count from 1.
193 . The first time that a commit shows up in the stream, it has various
194   other information about it printed out with a one-word tag at the
195   beginning of each line describing the extra commit information (author,
196   email, committer, dates, summary, etc.).
198 . Unlike the Porcelain format, the filename information is always
199   given and terminates the entry:
201         "filename" <whitespace-quoted-filename-goes-here>
203 and thus it is really quite easy to parse for some line- and word-oriented
204 parser (which should be quite natural for most scripting languages).
206 [NOTE]
207 For people who do parsing: to make it more robust, just ignore any
208 lines between the first and last one ("<sha1>" and "filename" lines)
209 where you do not recognize the tag words (or care about that particular
210 one) at the beginning of the "extended information" lines. That way, if
211 there is ever added information (like the commit encoding or extended
212 commit commentary), a blame viewer will not care.
215 MAPPING AUTHORS
216 ---------------
218 include::mailmap.txt[]
221 SEE ALSO
222 --------
223 linkgit:git-annotate[1]
227 Part of the linkgit:git[1] suite