Merge branch 'cs/pretty-formats-doc-typofix'
[git.git] / Documentation / blame-options.txt
blob5d122db6e9e6863fcf1e69ebc14feb1393501e0b
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 <rev>..<rev>::
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.  `git blame --reverse START` is taken as `git blame
37         --reverse START..HEAD` for convenience.
39 -p::
40 --porcelain::
41         Show in a format designed for machine consumption.
43 --line-porcelain::
44         Show the porcelain format, but output commit information for
45         each line, not just the first time a commit is referenced.
46         Implies --porcelain.
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 --date <format>::
67         Specifies the format used to output dates. If --date is not
68         provided, the value of the blame.date config variable is
69         used. If the blame.date config variable is also not set, the
70         iso format is used. For supported values, see the discussion
71         of the --date option at linkgit:git-log[1].
73 --[no-]progress::
74         Progress status is reported on the standard error stream
75         by default when it is attached to a terminal. This flag
76         enables progress reporting even if not attached to a
77         terminal. Can't use `--progress` together with `--porcelain`
78         or `--incremental`.
80 -M[<num>]::
81         Detect moved or copied lines within a file. When a commit
82         moves or copies a block of lines (e.g. the original file
83         has A and then B, and the commit changes it to B and then
84         A), the traditional 'blame' algorithm notices only half of
85         the movement and typically blames the lines that were moved
86         up (i.e. B) to the parent and assigns blame to the lines that
87         were moved down (i.e. A) to the child commit.  With this
88         option, both groups of lines are blamed on the parent by
89         running extra passes of inspection.
91 <num> is optional but it is the lower bound on the number of
92 alphanumeric characters that Git must detect as moving/copying
93 within a file for it to associate those lines with the parent
94 commit. The default value is 20.
96 -C[<num>]::
97         In addition to `-M`, detect lines moved or 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 other
102         files in the commit that creates the file. When this
103         option is given three times, the command additionally
104         looks for copies from other files in any commit.
106 <num> is optional but it is the lower bound on the number of
107 alphanumeric characters that Git must detect as moving/copying
108 between files for it to associate those lines with the parent
109 commit. And the default value is 40. If there are more than one
110 `-C` options given, the <num> argument of the last `-C` will
111 take effect.
113 --ignore-rev <rev>::
114         Ignore changes made by the revision when assigning blame, as if the
115         change never happened.  Lines that were changed or added by an ignored
116         commit will be blamed on the previous commit that changed that line or
117         nearby lines.  This option may be specified multiple times to ignore
118         more than one revision.  If the `blame.markIgnoredLines` config option
119         is set, then lines that were changed by an ignored commit and attributed to
120         another commit will be marked with a `?` in the blame output.  If the
121         `blame.markUnblamableLines` config option is set, then those lines touched
122         by an ignored commit that we could not attribute to another revision are
123         marked with a '*'.
125 --ignore-revs-file <file>::
126         Ignore revisions listed in `file`, which must be in the same format as an
127         `fsck.skipList`.  This option may be repeated, and these files will be
128         processed after any files specified with the `blame.ignoreRevsFile` config
129         option.  An empty file name, `""`, will clear the list of revs from
130         previously processed files.
132 -h::
133         Show help message.