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