Bug#1107574: mkinitramfs.8: Some remarks and a patch with editorial changes for this man page
Package: initramfs-tools-core
Version: 0.148.1
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man page"
[Use
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' <file>
to find (most) trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
an.tmac:<stdin>:10: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:161: misuse, warning: .BR is for at least 2 arguments, got 0
Use macro '.B' for one argument or split argument.
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: 13.0
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.30-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages initramfs-tools-core depends on:
ii coreutils 9.7-2
ii cpio 2.15+dfsg-2
ii dracut-install 106-6
ii e2fsprogs 1.47.2-1+b1
ii initramfs-tools-bin 0.148.1
ii klibc-utils 2.0.14-1
ii kmod 34.2-2
ii logsave 1.47.2-1+b1
ii udev 257.6-1
Versions of packages initramfs-tools-core recommends:
pn busybox | busybox-static <none>
ii zstd 1.5.7+dfsg-1
Versions of packages initramfs-tools-core suggests:
ii bash-completion 1:2.16.0-7
-- no debconf information
Input file is mkinitramfs.8
Output from "mandoc -T lint mkinitramfs.8": (shortened list)
1 input text line longer than 80 bytes
-.-.
Output from
test-nroff -mandoc -t -ww -z mkinitramfs.8: (shortened list)
1 Use macro '.B' for one argument or split argument.
1 Use macro '.I' for one argument or split argument.
1 .BR is for at least 2 arguments, got 0
1 .IR is for at least 2 arguments, got 1
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended.
" \(em " creates a too big gap in the text (in "troff").
An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-"
(begin of an option or end of options)
then use "\-\-".
mkinitramfs.8:13:.BR mkinitramfs " " --version
-.-.
Reduce space between words.
mkinitramfs.8:1:.TH MKINITRAMFS 8 "2018/07/18" "initramfs\-tools" "System Administration"
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
13:.BR mkinitramfs " " --version
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
13:.BR mkinitramfs " " --version
15:.BR mkinitramfs " " -h
124:Specified modules will be put in the generated image and loaded when the system boots. The format - one per line - is identical to that of
145:.B mkinitramfs -o ~/tmp/initramfs-$(uname -r)
150:.B mkinitramfs -k -o ~/tmp/initramfs-2.6.21-686 2.6.21-686
154:.B sh -x mkinitramfs -o ~/tmp/initramfs-$(uname -r) 2> ~/tmp/log
-.-.
Add a "\&" (or a comma (Oxford comma)) after an abbreviation
or use English words
(man-pages(7)).
Abbreviation points should be marked as such and protected against being
interpreted as an end of sentence, if they are not, and that independent
of the current place on the line.
104:filesystem which allows the execution of files stored there, i.e.
-.-.
Wrong distance (not two spaces) between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
Mark a final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
21:The initramfs is a compressed cpio archive. The archive can be used on a
24:is meant for advanced usage. On your local box
30:keeps sha1sum of generated initramfs. It takes care to generate backups
34:uses it as initial root file system. All finding of the root device
100:environment variable. If set, it uses subdirectories in the given
101:directory to create its temporary working directories. Else it uses
103:as default value for that purpose. The given directory should be on a
118:The default configuration file for the script. See
124:Specified modules will be put in the generated image and loaded when the system boots. The format - one per line - is identical to that of
132:via config snippets. This allows one to set ROOT or RESUME.
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Add "\:" to split the string for the output, "\<newline>" in the source.
Line 124, length 138
Specified modules will be put in the generated image and loaded when the system boots. The format - one per line - is identical to that of
Longest line is number 124 with 138 characters
-.-.
Use \(en (en-dash) for a dash at the beginning (end) of a line,
or between space characters,
not a minus (\-) or a hyphen (-), except in the NAME section.
mkinitramfs.8:124:Specified modules will be put in the generated image and loaded when the system boots. The format - one per line - is identical to that of
-.-.
Split a punctuation from a single argument, if a two-font macro is meant.
125:.I /etc/modules,
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
mkinitramfs.8:152:Debug initramfs creation (check out written logfile)
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
mkinitramfs.8:21:The initramfs is a compressed cpio archive. The archive can be used on a
mkinitramfs.8:24:is meant for advanced usage. On your local box
mkinitramfs.8:30:keeps sha1sum of generated initramfs. It takes care to generate backups
mkinitramfs.8:34:uses it as initial root file system. All finding of the root device
mkinitramfs.8:100:environment variable. If set, it uses subdirectories in the given
mkinitramfs.8:101:directory to create its temporary working directories. Else it uses
mkinitramfs.8:103:as default value for that purpose. The given directory should be on a
mkinitramfs.8:118:The default configuration file for the script. See
mkinitramfs.8:124:Specified modules will be put in the generated image and loaded when the system boots. The format - one per line - is identical to that of
mkinitramfs.8:132:via config snippets. This allows one to set ROOT or RESUME.
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
mkinitramfs.8:1:.TH MKINITRAMFS 8 "2018/07/18" "initramfs\-tools" "System Administration"
-.-.
Add "\&" after an ellipsis, when it does not end a sentence.
8:.RI [ option ]...
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
an.tmac:<stdin>:10: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:161: misuse, warning: .BR is for at least 2 arguments, got 0
Use macro '.B' for one argument or split argument.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- mkinitramfs.8 2025-06-09 23:40:20.869907726 +0000
+++ mkinitramfs.8.new 2025-06-09 23:57:38.725402672 +0000
@@ -1,18 +1,18 @@
-.TH MKINITRAMFS 8 "2018/07/18" "initramfs\-tools" "System Administration"
+.TH MKINITRAMFS 8 2018/07/18 initramfs\-tools "System Administration"
.SH NAME
mkinitramfs \- low-level tool for generating an initramfs image
.SH SYNOPSIS
.B mkinitramfs
-.RI [ option ]...
+.RI [ option ]...\&
.B \-o
-.IR outfile
+.I outfile
.RI [ version ]
.br
-.BR mkinitramfs " " --version
+.BR mkinitramfs " " \-\-version
.br
-.BR mkinitramfs " " -h
+.BR mkinitramfs " " \-h
.SH DESCRIPTION
The
@@ -101,7 +101,7 @@ environment variable. If set, it uses su
directory to create its temporary working directories. Else it uses
.I /var/tmp
as default value for that purpose. The given directory should be on a
-filesystem which allows the execution of files stored there, i.e.
+filesystem which allows the execution of files stored there, i.e.\&
should not be mounted with the
.B noexec
mount option.
@@ -121,8 +121,8 @@ for a description of the available confi
.TP
.I /etc/initramfs-tools/modules
-Specified modules will be put in the generated image and loaded when the system boots. The format - one per line - is identical to that of
-.I /etc/modules,
+Specified modules will be put in the generated image and loaded when the system boots. The format \(en one per line \(en is identical to that of
+.IR /etc/modules ,
which is described in
.BR modules (5).
@@ -142,23 +142,22 @@ it to be loaded by ACPI.
Create an initramfs for current running kernel:
.PP
-.B mkinitramfs -o ~/tmp/initramfs-$(uname -r)
+.B mkinitramfs \-o ~/tmp/initramfs\-$(uname \-r)
Create an initramfs for specific kernel and keep builddirs:
.PP
-.B mkinitramfs -k -o ~/tmp/initramfs-2.6.21-686 2.6.21-686
+.B mkinitramfs \-k \-o ~/tmp/initramfs\-2.6.21\-686 2.6.21\-686
Debug initramfs creation (check out written logfile)
.PP
-.B sh -x mkinitramfs -o ~/tmp/initramfs-$(uname -r) 2> ~/tmp/log
+.B sh \-x mkinitramfs \-o ~/tmp/initramfs\-$(uname \-r) 2> ~/tmp/log
.SH AUTHOR
The initramfs-tools are written by Maximilian Attems <maks@debian.org>,
Jeff Bailey <jbailey@raspberryginger.com> and numerous others.
.SH SEE ALSO
-.BR
.IR initramfs.conf (5),
.IR initramfs-tools (7),
.IR update-initramfs (8),
Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)
[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>
To find trailing space use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
Not beginning each input sentence on a new line.
Line length and patch size should thus be reduced.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
See man-pages(7), item "semantic newline".
-.-
The difference between the formatted output of the original and patched file
can be seen with:
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -d -u <out1> <out2>
and for groff, using
\"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - \"
instead of 'nroff -mandoc'
Add the option '-t', if the file contains a table.
Read the output from 'diff -d -u ...' with 'less -R' or similar.
-.-.
If 'man' (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -b -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-
Reply to: