Merge branch 'rs/pretty-wrap'
[git/jnareb-git.git] / Documentation / blame-options.txt
blob1625ffce6a1910c879447705fea4e3301039debd
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 --incremental::
56         Show the result incrementally in a format designed for
57         machine consumption.
59 --encoding=<encoding>::
60         Specifies the encoding used to output author names
61         and commit summaries. Setting it to `none` makes blame
62         output unconverted data. For more information see the
63         discussion about encoding in the linkgit:git-log[1]
64         manual page.
66 --contents <file>::
67         When <rev> is not specified, the command annotates the
68         changes starting backwards from the working tree copy.
69         This flag makes the command pretend as if the working
70         tree copy has the contents of the named file (specify
71         `-` to make the command read from the standard input).
73 --date <format>::
74         The value is one of the following alternatives:
75         {relative,local,default,iso,rfc,short}. If --date is not
76         provided, the value of the blame.date config variable is
77         used. If the blame.date config variable is also not set, the
78         iso format is used. For more information, See the discussion
79         of the --date option at linkgit:git-log[1].
81 -M|<num>|::
82         Detect moving lines in the file as well.  When a commit
83         moves a block of lines in a file (e.g. the original file
84         has A and then B, and the commit changes it to B and
85         then A), the traditional 'blame' algorithm typically blames
86         the lines that were moved up (i.e. B) to the parent and
87         assigns blame to the lines that were moved down (i.e. A)
88         to the child commit.  With this option, both groups of lines
89         are blamed on the parent.
91 <num> is optional but it is the lower bound on the number of
92 alphanumeric characters that git must detect as moving
93 within a file for it to associate those lines with the parent
94 commit.
96 -C|<num>|::
97         In addition to `-M`, detect lines copied from other
98         files that were modified in the same commit.  This is
99         useful when you reorganize your program and move code
100         around across files.  When this option is given twice,
101         the command additionally looks for copies from all other
102         files in the parent for the commit that creates the file.
104 <num> is optional but it is the lower bound on the number of
105 alphanumeric characters that git must detect as moving
106 between files for it to associate those lines with the parent
107 commit.
109 -h::
110 --help::
111         Show help message.