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