Merge branch 'master' of git://git.kernel.org/pub/scm/git/git
[git/jnareb-git.git] / Documentation / blame-options.txt
blobb0d31df0e750141fb8adc7a487c81663246ddf04
1 -b::
2         Show blank SHA-1 for boundary commits.  This can also
3         be controlled via the `blame.blankboundary` config option.
5 --root::
6         Do not treat root commits as boundaries.  This can also be
7         controlled via the `blame.showroot` config option.
9 --show-stats::
10         Include additional statistics at the end of blame output.
12 -L <start>,<end>::
13         Annotate only the given line range.  <start> and <end> can take
14         one of these forms:
16         - number
18 If <start> or <end> is a number, it specifies an
19 absolute line number (lines count from 1).
22 - /regex/
24 This form will use the first line matching the given
25 POSIX regex.  If <end> is a regex, it will search
26 starting at the line given by <start>.
29 - +offset or -offset
31 This is only valid for <end> and will specify a number
32 of lines before or after the line given by <start>.
35 -l::
36         Show long rev (Default: off).
38 -t::
39         Show raw timestamp (Default: off).
41 -S <revs-file>::
42         Use revisions from revs-file instead of calling linkgit:git-rev-list[1].
44 --reverse::
45         Walk history forward instead of backward. Instead of showing
46         the revision in which a line appeared, this shows the last
47         revision in which a line has existed. This requires a range of
48         revision like START..END where the path to blame exists in
49         START.
51 -p::
52 --porcelain::
53         Show in a format designed for machine consumption.
55 --line-porcelain::
56         Show the porcelain format, but output commit information for
57         each line, not just the first time a commit is referenced.
58         Implies --porcelain.
60 --incremental::
61         Show the result incrementally in a format designed for
62         machine consumption.
64 --encoding=<encoding>::
65         Specifies the encoding used to output author names
66         and commit summaries. Setting it to `none` makes blame
67         output unconverted data. For more information see the
68         discussion about encoding in the linkgit:git-log[1]
69         manual page.
71 --contents <file>::
72         When <rev> is not specified, the command annotates the
73         changes starting backwards from the working tree copy.
74         This flag makes the command pretend as if the working
75         tree copy has the contents of the named file (specify
76         `-` to make the command read from the standard input).
78 --date <format>::
79         The value is one of the following alternatives:
80         {relative,local,default,iso,rfc,short}. If --date is not
81         provided, the value of the blame.date config variable is
82         used. If the blame.date config variable is also not set, the
83         iso format is used. For more information, See the discussion
84         of the --date option at linkgit:git-log[1].
86 -M|<num>|::
87         Detect moved or copied lines within a file. When a commit
88         moves or copies a block of lines (e.g. the original file
89         has A and then B, and the commit changes it to B and then
90         A), the traditional 'blame' algorithm notices only half of
91         the movement and typically blames the lines that were moved
92         up (i.e. B) to the parent and assigns blame to the lines that
93         were moved down (i.e. A) to the child commit.  With this
94         option, both groups of lines are blamed on the parent by
95         running extra passes of inspection.
97 <num> is optional but it is the lower bound on the number of
98 alphanumeric characters that Git must detect as moving/copying
99 within a file for it to associate those lines with the parent
100 commit. The default value is 20.
102 -C|<num>|::
103         In addition to `-M`, detect lines moved or copied from other
104         files that were modified in the same commit.  This is
105         useful when you reorganize your program and move code
106         around across files.  When this option is given twice,
107         the command additionally looks for copies from other
108         files in the commit that creates the file. When this
109         option is given three times, the command additionally
110         looks for copies from other files in any commit.
112 <num> is optional but it is the lower bound on the number of
113 alphanumeric characters that Git must detect as moving/copying
114 between files for it to associate those lines with the parent
115 commit. And the default value is 40. If there are more than one
116 `-C` options given, the <num> argument of the last `-C` will
117 take effect.
119 -h::
120         Show help message.