Merge branch 'jc/maint-do-not-switch-to-non-commit' into maint
[git/trast.git] / Documentation / blame-options.txt
blob1ab1b96cf9e4c72a7d4e2a8a1d5dd8f016ac9d79
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 linkgit:git-rev-list[1].
44 -p::
45 --porcelain::
46         Show in a format designed for machine consumption.
48 --incremental::
49         Show the result incrementally in a format designed for
50         machine consumption.
52 --encoding=<encoding>::
53         Specifies the encoding used to output author names
54         and commit summaries. Setting it to `none` makes blame
55         output unconverted data. For more information see the
56         discussion about encoding in the linkgit:git-log[1]
57         manual page.
59 --contents <file>::
60         When <rev> is not specified, the command annotates the
61         changes starting backwards from the working tree copy.
62         This flag makes the command pretend as if the working
63         tree copy has the contents of the named file (specify
64         `-` to make the command read from the standard input).
66 -M|<num>|::
67         Detect moving lines in the file as well.  When a commit
68         moves a block of lines in a file (e.g. the original file
69         has A and then B, and the commit changes it to B and
70         then A), traditional 'blame' algorithm typically blames
71         the lines that were moved up (i.e. B) to the parent and
72         assigns blame to the lines that were moved down (i.e. A)
73         to the child commit.  With this option, both groups of lines
74         are blamed on the parent.
76 <num> is optional but it is the lower bound on the number of
77 alphanumeric characters that git must detect as moving
78 within a file for it to associate those lines with the parent
79 commit.
81 -C|<num>|::
82         In addition to `-M`, detect lines copied from other
83         files that were modified in the same commit.  This is
84         useful when you reorganize your program and move code
85         around across files.  When this option is given twice,
86         the command looks for copies from all other files in the
87         parent for the commit that creates the file in addition.
89 <num> is optional but it is the lower bound on the number of
90 alphanumeric characters that git must detect as moving
91 between files for it to associate those lines with the parent
92 commit.
94 -h::
95 --help::
96         Show help message.