Package: initramfs-tools
Version: 0.145
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 "groff -e ' $' -e '\\~$' <file>" to find obvious 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>:91: 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: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.12-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 depends on:
ii initramfs-tools-core 0.145
ii linux-base 4.11
initramfs-tools recommends no packages.
Versions of packages initramfs-tools suggests:
ii bash-completion 1:2.16.0-7
-- no debconf information
Input file is update-initramfs.8
Output from "mandoc -T lint update-initramfs.8": (shortened list)
-.-.
Output from "test-groff -mandoc -t -ww -z update-initramfs.8": (shortened list)
1 Use macro '.B' for one argument or split argument.
1 .BR is for at least 2 arguments, got 0
-.-.
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 "\-\-".
update-initramfs.8:66:\fB\-h\fR, \fB--help\fR
-.-.
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.
66:\fB\-h\fR, \fB--help\fR
75:.B update\-initramfs -u
81:.B update\-initramfs -c -k 2.6.18-1-686
-.-.
Wrong distance 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.
N.B.
The number of lines affected can be too large to be in a patch.
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"
26:uses it as initial root file system. All finding of the root device
34:This argument is optional for update. The default is the latest kernel
version.
-.-.
Split a punctuation from a single argument, if a two-font macro is meant.
68:.B update\-initramfs.
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
Not considered in a patch, too many lines.
update-initramfs.8:40:should operate on all installed kernel versions (with
\fB\-c\fR), or
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:91: 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.
--- update-initramfs.8 2025-02-28 17:42:06.182485027 +0000
+++ update-initramfs.8.new 2025-02-28 17:48:58.237633491 +0000
@@ -18,27 +18,33 @@ The
.B update\-initramfs
script manages your initramfs images on your local box.
It keeps track of the existing initramfs archives in /boot.
-There are three modes of operation create, update or delete.
+There are three modes of operation create,
+update or delete.
You must at least specify one of those modes.
The initramfs is a gzipped cpio archive.
-At boot time, the kernel unpacks that archive into RAM disk, mounts and
-uses it as initial root file system. All finding of the root device
-happens in this early userspace.
+At boot time,
+the kernel unpacks that archive into RAM disk,
+mounts and
+uses it as initial root file system.
+All finding of the root device happens in this early userspace.
.SH OPTIONS
.TP
\fB\-k \fI version
Set the specific kernel version for whom the initramfs will be generated.
For example the output of uname \-r for your currently running kernel.
-This argument is optional for update. The default is the latest kernel version.
+This argument is optional for update.
+The default is the latest kernel version.
The use of "all" for the
.I version
string specifies that
.B update\-initramfs
-should operate on all installed kernel versions (with \fB\-c\fR), or
-on all installed kernel versions that already have an initramfs
+should operate on all installed kernel versions
+(with \fB\-c\fR),
+or on all installed kernel versions
+that already have an initramfs
(with \fB\-d\fR or \fB\-u\fR).
.TP
@@ -63,22 +69,22 @@ the chosen action.
Set an different bootdir for the image creation.
.TP
-\fB\-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
Print a short help page describing the available options in
-.B update\-initramfs.
+.BR update\-initramfs .
.SH EXAMPLES
Update the initramfs of the newest kernel:
.PP
-.B update\-initramfs -u
+.B update\-initramfs \-u
Create the initramfs for a specific kernel:
.PP
-.B update\-initramfs -c -k 2.6.18-1-686
+.B update\-initramfs \-c \-k 2.6.18\-1\-686
.SH FILES
/etc/initramfs-tools/update-initramfs.conf
@@ -88,8 +94,7 @@ The initramfs-tools are written by Maxim
Jeff Bailey <jbai...@raspberryginger.com> and numerous others.
.SH SEE ALSO
-.BR
-.IR initramfs.conf (5),
-.IR initramfs-tools (7),
-.IR mkinitramfs (8),
-.IR lsinitramfs (8).
+.BR initramfs.conf (5),
+.BR initramfs-tools (7),
+.BR mkinitramfs (8),
+.BR lsinitramfs (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>
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)
-.-
