Documentation/git-blame.txt

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