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>:23: style: 1 leading space(s) on input line
an.tmac:<stdin>:45: style: 1 leading space(s) on input line
an.tmac:<stdin>:53: style: 1 leading space(s) on input line
an.tmac:<stdin>:60: style: 1 leading space(s) on input line
an.tmac:<stdin>:67: style: 1 leading space(s) on input line
an.tmac:<stdin>:74: style: 1 leading space(s) on input line
an.tmac:<stdin>:79: style: 1 leading space(s) on input line
an.tmac:<stdin>:85: style: 1 leading space(s) on input line
an.tmac:<stdin>:95: style: 1 leading space(s) on input line
an.tmac:<stdin>:104: style: 1 leading space(s) on input line
an.tmac:<stdin>:111: style: 1 leading space(s) on input line
an.tmac:<stdin>:116: style: 1 leading space(s) on input line
an.tmac:<stdin>:121: style: 1 leading space(s) on input line
an.tmac:<stdin>:135: 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 105-3
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.2-3
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 initramfs.conf.5
Output from "mandoc -T lint initramfs.conf.5": (shortened list)
-.-.
Output from "test-groff -mandoc -t -ww -z initramfs.conf.5": (shortened list)
1 Use macro '.B' for one argument or split argument.
1 .BR is for at least 2 arguments, got 0
-.-.
Strings longer than 3/4 of a standard line length (80)
Use "\:" to split the string at the end of an output line, for example a
long URLs (web address)
89 \fBhttps://www.kernel.org/doc/Documentation/filesystems/tmpfs.txt\fR for
-.-.
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.
12:or a comment. The value of an variable is assigned by an statement
87:or as percentage of your physical RAM. This parameter is used as the value of
88:the size mount option to tmpfs. See
90:details. Can be overridden by an optional \fBinitramfs.runsize=\fR bootarg.
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
initramfs.conf.5:81:The default is to boot from \fIlocal\fP media (hard drive,
USB stick).
initramfs.conf.5:86:The size of the \fI/run\fP tmpfs mount point in bytes
(suffixes are supported)
-.-.
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.
1:.TH INITRAMFS.CONF 5 "2018/07/18" "initramfs\-tools" "File Formats Manual"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:23: style: 1 leading space(s) on input line
an.tmac:<stdin>:45: style: 1 leading space(s) on input line
an.tmac:<stdin>:53: style: 1 leading space(s) on input line
an.tmac:<stdin>:60: style: 1 leading space(s) on input line
an.tmac:<stdin>:67: style: 1 leading space(s) on input line
an.tmac:<stdin>:74: style: 1 leading space(s) on input line
an.tmac:<stdin>:79: style: 1 leading space(s) on input line
an.tmac:<stdin>:85: style: 1 leading space(s) on input line
an.tmac:<stdin>:95: style: 1 leading space(s) on input line
an.tmac:<stdin>:104: style: 1 leading space(s) on input line
an.tmac:<stdin>:111: style: 1 leading space(s) on input line
an.tmac:<stdin>:116: style: 1 leading space(s) on input line
an.tmac:<stdin>:121: style: 1 leading space(s) on input line
an.tmac:<stdin>:135: misuse, warning: .BR is for at least 2 arguments, got 0
Use macro '.B' for one argument or split argument.
--- initramfs.conf.5 2025-02-10 21:01:17.434192436 +0000
+++ initramfs.conf.5.new 2025-02-10 21:13:08.227860766 +0000
@@ -9,7 +9,8 @@ The behaviour of
can be modified by its configuration file.
Each line in the file can be a configuration variable, a blank line,
-or a comment. The value of an variable is assigned by an statement
+or a comment.
+The value of an variable is assigned by an statement
of the form: \fIname\fP=[\fIvalue\fP]
Configuration options can be broken out into configuration snippets and
@@ -78,16 +79,21 @@ Useful to not disclose eventual keys.
.TP
\fB BOOT
Allows one to use an nfs drive as the root of the drive.
-The default is to boot from \fIlocal\fP media (hard drive, USB stick).
+The default is to boot from \fIlocal\fP media
+(hard drive, USB stick).
Set to \fInfs\fP for an NFS root share.
.TP
\fB RUNSIZE
-The size of the \fI/run\fP tmpfs mount point in bytes (suffixes are supported)
-or as percentage of your physical RAM. This parameter is used as the value of
-the size mount option to tmpfs. See
-\fBhttps://www.kernel.org/doc/Documentation/filesystems/tmpfs.txt\fR for
-details. Can be overridden by an optional \fBinitramfs.runsize=\fR bootarg.
+The size of the \fI/run\fP tmpfs mount point in bytes
+(suffixes are supported)
+or as percentage of your physical RAM.
+This parameter is used as the value of
+the size mount option to tmpfs.
+See
+\fBhttps://www.kernel.org/\:doc/\:Documentation/\:filesystems/\:tmpfs.txt\fR
+for details.
+Can be overridden by an optional \fBinitramfs.runsize=\fR bootarg.
The default is 10%.
.SH VARIABLES FOR LOCAL BOOT
@@ -132,7 +138,6 @@ Jeff Bailey <jbai...@raspberryginger.com
Loosely based on mkinitrd.conf by Herbert Xu.
.SH SEE ALSO
-.BR
-.IR initramfs-tools (7),
-.IR mkinitramfs (8),
-.IR update-initramfs (8).
+.BR initramfs-tools (7),
+.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.
Not beginning each input sentence on a new line.
Line length 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)
-.-
