Fix grammar nits in documentation and in code comments.
[git/fastimport.git] / Documentation / blame-options.txt
blob17379f057613f2dc82bf6d5d4f8181d4e29dee50
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 revs from revs-file instead of calling gitlink:git-rev-list[1].
44 -p, --porcelain::
45         Show in a format designed for machine consumption.
47 --incremental::
48         Show the result incrementally in a format designed for
49         machine consumption.
51 --contents <file>::
52         When <rev> is not specified, the command annotates the
53         changes starting backwards from the working tree copy.
54         This flag makes the command pretend as if the working
55         tree copy has the contents of he named file (specify
56         `-` to make the command read from the standard input).
58 -M|<num>|::
59         Detect moving lines in the file as well.  When a commit
60         moves a block of lines in a file (e.g. the original file
61         has A and then B, and the commit changes it to B and
62         then A), traditional 'blame' algorithm typically blames
63         the lines that were moved up (i.e. B) to the parent and
64         assigns blame to the lines that were moved down (i.e. A)
65         to the child commit.  With this option, both groups of lines
66         are blamed on the parent.
68 <num> is optional but it is the lower bound on the number of
69 alphanumeric characters that git must detect as moving
70 within a file for it to associate those lines with the parent
71 commit.
73 -C|<num>|::
74         In addition to `-M`, detect lines copied from other
75         files that were modified in the same commit.  This is
76         useful when you reorganize your program and move code
77         around across files.  When this option is given twice,
78         the command looks for copies from all other files in the
79         parent for the commit that creates the file in addition.
81 <num> is optional but it is the lower bound on the number of
82 alphanumeric characters that git must detect as moving
83 between files for it to associate those lines with the parent
84 commit.
86 -h, --help::
87         Show help message.