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