Bug#1099117: unmkinitramfs.8: Some remarks and a patch with editorial changes for this man page
Package: initramfs-tools-core
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>:42: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:52: 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-core depends on:
ii coreutils 9.5-1+b1
ii cpio 2.15+dfsg-2
ii dracut-install 106-5
ii e2fsprogs 1.47.2-1
ii klibc-utils 2.0.13-4
ii kmod 33+20240816-2
ii logsave 1.47.2-1
ii udev 257.3-1
Versions of packages initramfs-tools-core recommends:
pn busybox | busybox-static <none>
ii zstd 1.5.6+dfsg-2
Versions of packages initramfs-tools-core suggests:
ii bash-completion 1:2.16.0-7
-- no debconf information
Input file is unmkinitramfs.8
Output from "mandoc -T lint unmkinitramfs.8": (shortened list)
-.-.
Output from "test-groff -mandoc -t -ww -z unmkinitramfs.8": (shortened list)
2 Use macro '.B' for one argument or split argument.
1 .BR is for at least 2 arguments, got 0
1 .BR is for at least 2 arguments, got 1
-.-.
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.
8:.RB [ -v ]
11:.BR unmkinitramfs " " -h
25:.B -h
29:.B -v
38:.B unmkinitramfs /boot/initrd.img-$(uname -r) initramfs/
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
an.tmac:<stdin>:42: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:52: 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.
--- unmkinitramfs.8 2025-02-28 14:35:34.108127954 +0000
+++ unmkinitramfs.8.new 2025-02-28 14:49:08.112057092 +0000
@@ -5,10 +5,10 @@ unmkinitramfs \- extract content from an
.SH SYNOPSIS
.B unmkinitramfs
-.RB [ -v ]
+.RB [ \-v ]
.IR initramfs-file " " directory
.br
-.BR unmkinitramfs " " -h
+.B unmkinitramfs \-h
.SH DESCRIPTION
The
@@ -22,11 +22,11 @@ in order.
.SH OPTIONS
.TP
-.B -h
+.B \-h
Display usage information and exit.
.TP
-.B -v
+.B \-v
Display verbose messages about extraction.
@@ -35,11 +35,11 @@ Display verbose messages about extractio
Extract initramfs content of current running kernel:
.PP
-.B unmkinitramfs /boot/initrd.img-$(uname -r) initramfs/
+.B unmkinitramfs /boot/initrd.img\-$(uname \-r) initramfs/
.SH BUGS
-.BR unmkinitramfs
+.B unmkinitramfs
cannot deal with multiple-segmented initramfs images, except where an
early (uncompressed) initramfs with system firmware is prepended to
the regular compressed initramfs.
@@ -49,8 +49,7 @@ The initramfs-tools are written by Maxim
and numerous others.
.SH SEE ALSO
-.BR
-.IR initramfs-tools (7),
-.IR lsinitramfs (8),
-.IR mkinitramfs (8),
-.IR update-initramfs (8).
+.BR initramfs-tools (7),
+.BR lsinitramfs (8),
+.BR mkinitramfs (8),
+.BR 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>
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: