Merge branch 'tb/pack-revindex-on-disk'
[git/debian.git] / Documentation / blame-options.txt
blob117f4cf80645e13b991534318ed7d7eb33e62fa1
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 line range given by '<start>,<end>',
15         or by the function name regex '<funcname>'.
16         May be specified multiple times. Overlapping ranges are allowed.
18 '<start>' and '<end>' are optional. `-L <start>` or `-L <start>,` spans from
19 '<start>' to end of file. `-L ,<end>` spans from start of file to '<end>'.
21 include::line-range-format.txt[]
23 -l::
24         Show long rev (Default: off).
26 -t::
27         Show raw timestamp (Default: off).
29 -S <revs-file>::
30         Use revisions from revs-file instead of calling linkgit:git-rev-list[1].
32 --reverse <rev>..<rev>::
33         Walk history forward instead of backward. Instead of showing
34         the revision in which a line appeared, this shows the last
35         revision in which a line has existed. This requires a range of
36         revision like START..END where the path to blame exists in
37         START.  `git blame --reverse START` is taken as `git blame
38         --reverse START..HEAD` for convenience.
40 --first-parent::
41         Follow only the first parent commit upon seeing a merge
42         commit. This option can be used to determine when a line
43         was introduced to a particular integration branch, rather
44         than when it was introduced to the history overall.
46 -p::
47 --porcelain::
48         Show in a format designed for machine consumption.
50 --line-porcelain::
51         Show the porcelain format, but output commit information for
52         each line, not just the first time a commit is referenced.
53         Implies --porcelain.
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         Specifies the format used to output dates. If --date is not
75         provided, the value of the blame.date config variable is
76         used. If the blame.date config variable is also not set, the
77         iso format is used. For supported values, see the discussion
78         of the --date option at linkgit:git-log[1].
80 --[no-]progress::
81         Progress status is reported on the standard error stream
82         by default when it is attached to a terminal. This flag
83         enables progress reporting even if not attached to a
84         terminal. Can't use `--progress` together with `--porcelain`
85         or `--incremental`.
87 -M[<num>]::
88         Detect moved or copied lines within a file. When a commit
89         moves or copies a block of lines (e.g. the original file
90         has A and then B, and the commit changes it to B and then
91         A), the traditional 'blame' algorithm notices only half of
92         the movement and typically blames the lines that were moved
93         up (i.e. B) to the parent and assigns blame to the lines that
94         were moved down (i.e. A) to the child commit.  With this
95         option, both groups of lines are blamed on the parent by
96         running extra passes of inspection.
98 <num> is optional but it is the lower bound on the number of
99 alphanumeric characters that Git must detect as moving/copying
100 within a file for it to associate those lines with the parent
101 commit. The default value is 20.
103 -C[<num>]::
104         In addition to `-M`, detect lines moved or copied from other
105         files that were modified in the same commit.  This is
106         useful when you reorganize your program and move code
107         around across files.  When this option is given twice,
108         the command additionally looks for copies from other
109         files in the commit that creates the file. When this
110         option is given three times, the command additionally
111         looks for copies from other files in any commit.
113 <num> is optional but it is the lower bound on the number of
114 alphanumeric characters that Git must detect as moving/copying
115 between files for it to associate those lines with the parent
116 commit. And the default value is 40. If there are more than one
117 `-C` options given, the <num> argument of the last `-C` will
118 take effect.
120 --ignore-rev <rev>::
121         Ignore changes made by the revision when assigning blame, as if the
122         change never happened.  Lines that were changed or added by an ignored
123         commit will be blamed on the previous commit that changed that line or
124         nearby lines.  This option may be specified multiple times to ignore
125         more than one revision.  If the `blame.markIgnoredLines` config option
126         is set, then lines that were changed by an ignored commit and attributed to
127         another commit will be marked with a `?` in the blame output.  If the
128         `blame.markUnblamableLines` config option is set, then those lines touched
129         by an ignored commit that we could not attribute to another revision are
130         marked with a '*'.
132 --ignore-revs-file <file>::
133         Ignore revisions listed in `file`, which must be in the same format as an
134         `fsck.skipList`.  This option may be repeated, and these files will be
135         processed after any files specified with the `blame.ignoreRevsFile` config
136         option.  An empty file name, `""`, will clear the list of revs from
137         previously processed files.
139 -h::
140         Show help message.