Documentation: use brackets for optional arguments
[git.git] / Documentation / blame-options.txt
blobc233a72f79b525efe9e82ba115d69c25e70fc22c
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 -L :<funcname>::
14         Annotate only the given line range. May be specified multiple times.
15         Overlapping ranges are allowed.
17 <start> and <end> are optional. ``-L <start>'' or ``-L <start>,'' spans from
18 <start> to end of file. ``-L ,<end>'' spans from start of file to <end>.
20 include::line-range-format.txt[]
22 -l::
23         Show long rev (Default: off).
25 -t::
26         Show raw timestamp (Default: off).
28 -S <revs-file>::
29         Use revisions from revs-file instead of calling linkgit:git-rev-list[1].
31 --reverse::
32         Walk history forward instead of backward. Instead of showing
33         the revision in which a line appeared, this shows the last
34         revision in which a line has existed. This requires a range of
35         revision like START..END where the path to blame exists in
36         START.
38 -p::
39 --porcelain::
40         Show in a format designed for machine consumption.
42 --line-porcelain::
43         Show the porcelain format, but output commit information for
44         each line, not just the first time a commit is referenced.
45         Implies --porcelain.
47 --incremental::
48         Show the result incrementally in a format designed for
49         machine consumption.
51 --encoding=<encoding>::
52         Specifies the encoding used to output author names
53         and commit summaries. Setting it to `none` makes blame
54         output unconverted data. For more information see the
55         discussion about encoding in the linkgit:git-log[1]
56         manual page.
58 --contents <file>::
59         When <rev> is not specified, the command annotates the
60         changes starting backwards from the working tree copy.
61         This flag makes the command pretend as if the working
62         tree copy has the contents of the named file (specify
63         `-` to make the command read from the standard input).
65 --date <format>::
66         Specifies the format used to output dates. If --date is not
67         provided, the value of the blame.date config variable is
68         used. If the blame.date config variable is also not set, the
69         iso format is used. For supported values, see the discussion
70         of the --date option at linkgit:git-log[1].
72 --[no-]progress::
73         Progress status is reported on the standard error stream
74         by default when it is attached to a terminal. This flag
75         enables progress reporting even if not attached to a
76         terminal. Can't use `--progress` together with `--porcelain`
77         or `--incremental`.
79 -M[<num>]::
80         Detect moved or copied lines within a file. When a commit
81         moves or copies a block of lines (e.g. the original file
82         has A and then B, and the commit changes it to B and then
83         A), the traditional 'blame' algorithm notices only half of
84         the movement and typically blames the lines that were moved
85         up (i.e. B) to the parent and assigns blame to the lines that
86         were moved down (i.e. A) to the child commit.  With this
87         option, both groups of lines are blamed on the parent by
88         running extra passes of inspection.
90 <num> is optional but it is the lower bound on the number of
91 alphanumeric characters that Git must detect as moving/copying
92 within a file for it to associate those lines with the parent
93 commit. The default value is 20.
95 -C[<num>]::
96         In addition to `-M`, detect lines moved or copied from other
97         files that were modified in the same commit.  This is
98         useful when you reorganize your program and move code
99         around across files.  When this option is given twice,
100         the command additionally looks for copies from other
101         files in the commit that creates the file. When this
102         option is given three times, the command additionally
103         looks for copies from other files in any commit.
105 <num> is optional but it is the lower bound on the number of
106 alphanumeric characters that Git must detect as moving/copying
107 between files for it to associate those lines with the parent
108 commit. And the default value is 40. If there are more than one
109 `-C` options given, the <num> argument of the last `-C` will
110 take effect.
112 -h::
113         Show help message.