doc: git-blame: convert to new doc format
- Use _<placeholder>_ instead of <placeholder> in the description - Use _underscores_ around math associated with <placeholders> - Use `backticks` for keywords and more complex option descriptions. The new rendering engine will apply synopsis rules to these spans. Signed-off-by: Michael Lyons <git@michael.lyo.nz> Acked-by: Jean-Noël AVILA <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Michael Lyons committed
Jan 8, 2026 at 10:30 UTC
e40e01a75a795bc40822d80c14a3cfe728d45c1b
1 file changed
+37
-35
Documentation/git-blame.adoc
+37
-35
@@ -7,12 +7,12 @@ git-blame - Show what revision and author last modified each line of a file
7
8
SYNOPSIS
9
--------
10
-[verse]
11
-'git blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w] [--incremental]
12
- [-L <range>] [-S <revs-file>] [-M] [-C] [-C] [-C] [--since=<date>]
13
- [--ignore-rev <rev>] [--ignore-revs-file <file>]
14
- [--color-lines] [--color-by-age] [--progress] [--abbrev=<n>]
15
- [ --contents <file> ] [<rev> | --reverse <rev>..<rev>] [--] <file>
10
+[synopsis]
11
+git blame [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w] [--incremental]
12
+ [-L <range>] [-S <revs-file>] [-M] [-C] [-C] [-C] [--since=<date>]
13
+ [--ignore-rev <rev>] [--ignore-revs-file <file>]
14
+ [--color-lines] [--color-by-age] [--progress] [--abbrev=<n>]
15
+ [ --contents <file> ] [<rev> | --reverse <rev>..<rev>] [--] <file>
16
17
DESCRIPTION
18
-----------
@@ -30,7 +30,7 @@ lines that were copied and pasted from another file, etc., see the
30
`-C` and `-M` options.
31
32
The report does not tell you anything about lines which have been deleted or
33
-replaced; you need to use a tool such as 'git diff' or the "pickaxe"
33
+replaced; you need to use a tool such as `git diff` or the "pickaxe"
34
interface briefly mentioned in the following paragraph.
35
36
Apart from supporting file annotation, Git also supports searching the
@@ -50,47 +50,47 @@ OPTIONS
50
-------
51
include::blame-options.adoc[]
52
53
--c::
53
+`-c`::
54
Use the same output mode as linkgit:git-annotate[1] (Default: off).
55
56
---score-debug::
56
+`--score-debug`::
57
Include debugging information related to the movement of
58
lines between files (see `-C`) and lines moved within a
59
file (see `-M`). The first number listed is the score.
60
This is the number of alphanumeric characters detected
61
as having been moved between or within files. This must be above
62
- a certain threshold for 'git blame' to consider those lines
62
+ a certain threshold for `git blame` to consider those lines
63
of code to have been moved.
64
65
--f::
66
---show-name::
65
+`-f`::
66
+`--show-name`::
67
Show the filename in the original commit. By default
68
the filename is shown if there is any line that came from a
69
file with a different name, due to rename detection.
70
71
--n::
72
---show-number::
71
+`-n`::
72
+`--show-number`::
73
Show the line number in the original commit (Default: off).
74
75
--s::
75
+`-s`::
76
Suppress the author name and timestamp from the output.
77
78
--e::
79
---show-email::
78
+`-e`::
79
+`--show-email`::
80
Show the author email instead of the author name (Default: off).
81
This can also be controlled via the `blame.showEmail` config
82
option.
83
84
--w::
84
+`-w`::
85
Ignore whitespace when comparing the parent's version and
86
the child's to find where the lines came from.
87
88
include::diff-algorithm-option.adoc[]
89
90
---abbrev=<n>::
91
- Instead of using the default 7+1 hexadecimal digits as the
92
- abbreviated object name, use <m>+1 digits, where <m> is at
93
- least <n> but ensures the commit object names are unique.
90
+`--abbrev=<n>`::
91
+ Instead of using the default _7+1_ hexadecimal digits as the
92
+ abbreviated object name, use _<m>+1_ digits, where _<m>_ is at
93
+ least _<n>_ but ensures the commit object names are unique.
94
Note that 1 column
95
is used for a caret to mark the boundary commit.
96
@@ -124,21 +124,21 @@ header at the minimum has the first line which has:
124
This header line is followed by the following information
125
at least once for each commit:
126
127
-- the author name ("author"), email ("author-mail"), time
128
- ("author-time"), and time zone ("author-tz"); similarly
127
+- the author name (`author`), email (`author-mail`), time
128
+ (`author-time`), and time zone (`author-tz`); similarly
129
for committer.
130
- the filename in the commit that the line is attributed to.
131
-- the first line of the commit log message ("summary").
131
+- the first line of the commit log message (`summary`).
132
133
The contents of the actual line are output after the above
134
-header, prefixed by a TAB. This is to allow adding more
134
+header, prefixed by a _TAB_. This is to allow adding more
135
header elements later.
136
137
The porcelain format generally suppresses commit information that has
138
already been seen. For example, two lines that are blamed to the same
139
commit will both be shown, but the details for that commit will be shown
140
only once. Information which is specific to individual lines will not be
141
-grouped together, like revs to be marked 'ignored' or 'unblamable'. This
141
+grouped together, like revs to be marked `ignored` or `unblamable`. This
142
is more efficient, but may require more state be kept by the reader. The
143
`--line-porcelain` option can be used to output full commit information
144
for each line, allowing simpler (but less efficient) usage like:
@@ -152,7 +152,7 @@ for each line, allowing simpler (but less efficient) usage like:
152
SPECIFYING RANGES
153
-----------------
154
155
-Unlike 'git blame' and 'git annotate' in older versions of git, the extent
155
+Unlike `git blame` and `git annotate` in older versions of git, the extent
156
of the annotation can be limited to both line ranges and revision
157
ranges. The `-L` option, which limits annotation to a range of lines, may be
158
specified multiple times.
@@ -173,7 +173,7 @@ which limits the annotation to the body of the `hello` subroutine.
173
174
When you are not interested in changes older than version
175
v2.6.18, or changes older than 3 weeks, you can use revision
176
-range specifiers similar to 'git rev-list':
176
+range specifiers similar to `git rev-list`:
177
178
git blame v2.6.18.. -- foo
179
git blame --since=3.weeks -- foo
@@ -212,8 +212,9 @@ does not contain the actual lines from the file that is being
212
annotated.
213
214
. Each blame entry always starts with a line of:
215
-
216
- <40-byte-hex-sha1> <sourceline> <resultline> <num-lines>
215
++
216
+[synopsis]
217
+<40-byte-hex-sha1> <sourceline> <resultline> <num-lines>
218
+
219
Line numbers count from 1.
220
@@ -224,16 +225,17 @@ Line numbers count from 1.
225
226
. Unlike the Porcelain format, the filename information is always
227
given and terminates the entry:
227
-
228
- "filename" <whitespace-quoted-filename-goes-here>
228
++
229
+[synopsis]
230
+filename <whitespace-quoted-filename-goes-here>
231
+
232
and thus it is really quite easy to parse for some line- and word-oriented
233
parser (which should be quite natural for most scripting languages).
234
+
235
[NOTE]
236
For people who do parsing: to make it more robust, just ignore any
235
-lines between the first and last one ("<sha1>" and "filename" lines)
236
-where you do not recognize the tag words (or care about that particular
237
+lines between the first and last one (_<40-byte-hex-sha1>_ and `filename`
238
+lines) where you do not recognize the tag words (or care about that particular
239
one) at the beginning of the "extended information" lines. That way, if
240
there is ever added information (like the commit encoding or extended
241
commit commentary), a blame viewer will not care.