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