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