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
 109 SPECIFYING RANGES
 110 -----------------
 111
 112 Unlike 'git blame' and 'git annotate' in older versions of git, the extent
 113 of the annotation can be limited to both line ranges and revision
 114 ranges.  When you are interested in finding the origin for
 115 lines 40-60 for file `foo`, you can use the `-L` option like so
 116 (they mean the same thing -- both ask for 21 lines starting at
 117 line 40):
 118
 119         git blame -L 40,60 foo
 120         git blame -L 40,+21 foo
 121
 122 Also you can use a regular expression to specify the line range:
 123
 124         git blame -L '/^sub hello {/,/^}$/' foo
 125
 126 which limits the annotation to the body of the `hello` subroutine.
 127
 128 When you are not interested in changes older than version
 129 v2.6.18, or changes older than 3 weeks, you can use revision
 130 range specifiers  similar to 'git rev-list':
 131
 132         git blame v2.6.18.. -- foo
 133         git blame --since=3.weeks -- foo
 134
 135 When revision range specifiers are used to limit the annotation,
 136 lines that have not changed since the range boundary (either the
 137 commit v2.6.18 or the most recent commit that is more than 3
 138 weeks old in the above example) are blamed for that range
 139 boundary commit.
 140
 141 A particularly useful way is to see if an added file has lines
 142 created by copy-and-paste from existing files.  Sometimes this
 143 indicates that the developer was being sloppy and did not
 144 refactor the code properly.  You can first find the commit that
 145 introduced the file with:
 146
 147         git log --diff-filter=A --pretty=short -- foo
 148
 149 and then annotate the change between the commit and its
 150 parents, using `commit{caret}!` notation:
 151
 152         git blame -C -C -f $commit^! -- foo
 153
 154
 155 INCREMENTAL OUTPUT
 156 ------------------
 157
 158 When called with `--incremental` option, the command outputs the
 159 result as it is built.  The output generally will talk about
 160 lines touched by more recent commits first (i.e. the lines will
 161 be annotated out of order) and is meant to be used by
 162 interactive viewers.
 163
 164 The output format is similar to the Porcelain format, but it
 165 does not contain the actual lines from the file that is being
 166 annotated.
 167
 168 . Each blame entry always starts with a line of:
 169
 170         <40-byte hex sha1> <sourceline> <resultline> <num_lines>
 171 +
 172 Line numbers count from 1.
 173
 174 . The first time that a commit shows up in the stream, it has various
 175   other information about it printed out with a one-word tag at the
 176   beginning of each line describing the extra commit information (author,
 177   email, committer, dates, summary, etc.).
 178
 179 . Unlike the Porcelain format, the filename information is always
 180   given and terminates the entry:
 181
 182         "filename" <whitespace-quoted-filename-goes-here>
 183 +
 184 and thus it is really quite easy to parse for some line- and word-oriented
 185 parser (which should be quite natural for most scripting languages).
 186 +
 187 [NOTE]
 188 For people who do parsing: to make it more robust, just ignore any
 189 lines between the first and last one ("<sha1>" and "filename" lines)
 190 where you do not recognize the tag words (or care about that particular
 191 one) at the beginning of the "extended information" lines. That way, if
 192 there is ever added information (like the commit encoding or extended
 193 commit commentary), a blame viewer will not care.
 194
 195
 196 MAPPING AUTHORS
 197 ---------------
 198
 199 include::mailmap.txt[]
 200
 201
 202 SEE ALSO
 203 --------
 204 linkgit:git-annotate[1]
 205
 206 GIT
 207 ---
 208 Part of the linkgit:git[1] suite