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>:12: style: 1 leading space(s) on input line
an.tmac:<stdin>:20: style: 1 leading space(s) on input line
an.tmac:<stdin>:31: 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.conf.5
Output from "mandoc -T lint update-initramfs.conf.5": (shortened list)
1 input text line longer than 80 bytes: If set \fBupdate_ini...
-.-.
Output from "test-groff -mandoc -t -ww -z update-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
-.-.
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.
17:conservative manners needs to be applied. This disables
21:If set \fBupdate_initramfs\fP keeps an .bak file of the previous initramfs.
If unset the backup initramfs will not be kept.
-.-.
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 1, length 82
.TH UPDATE-INITRAMFS.CONF 5 "2010/04/05" "initramfs\-tools" "File Formats
Manual"
Line 21, length 123
If set \fBupdate_initramfs\fP keeps an .bak file of the previous initramfs. If
unset the backup initramfs will not be kept.
-.-.
Split a punctuation from a single argument, if a two-font macro is meant.
8:.B update-initramfs.
-.-.
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 UPDATE-INITRAMFS.CONF 5 "2010/04/05" "initramfs\-tools" "File Formats
Manual"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:12: style: 1 leading space(s) on input line
an.tmac:<stdin>:20: style: 1 leading space(s) on input line
an.tmac:<stdin>:31: misuse, warning: .BR is for at least 2 arguments, got 0
Use macro '.B' for one argument or split argument.
--- update-initramfs.conf.5 2025-02-17 09:16:05.936861118 +0000
+++ update-initramfs.conf.5.new 2025-02-17 09:21:35.722938102 +0000
@@ -1,24 +1,25 @@
-.TH UPDATE-INITRAMFS.CONF 5 "2010/04/05" "initramfs\-tools" "File Formats
Manual"
+.TH UPDATE-INITRAMFS.CONF 5 2010/04/05 initramfs\-tools "File Formats Manual"
.SH NAME
update-initramfs.conf \- configuration file for update-initramfs
.SH DESCRIPTION
The configuration file allows one to disable the update action from
-.B update-initramfs.
+.BR update-initramfs .
.SH GENERAL VARIABLES
.TP
-\fB update_initramfs
+\fBupdate_initramfs
Default is \fIyes\fP for running the latest initramfs-tools hooks in the
newest Linux image.
Setting it to \fIall\fP updates any known initramfs.
It is possible to set it to \fIno\fP for remote servers or boxes where
-conservative manners needs to be applied. This disables
-the \fBupdate_initramfs \-u\fP call.
+conservative manners needs to be applied.
+This disables the \fBupdate_initramfs \-u\fP call.
.TP
-\fB backup_initramfs
-If set \fBupdate_initramfs\fP keeps an .bak file of the previous initramfs. If
unset the backup initramfs will not be kept.
+\fBbackup_initramfs
+If set \fBupdate_initramfs\fP keeps an .bak file of the previous initramfs.
+If unset the backup initramfs will not be kept.
.SH FILES
.TP
@@ -28,7 +29,6 @@ If set \fBupdate_initramfs\fP keeps an .
The initramfs-tools are written by Maximilian Attems <m...@debian.org>,
Jeff Bailey <jbai...@raspberryginger.com> and numerous others.
.SH SEE ALSO
-.BR
.IR initramfs.conf (5),
.IR initramfs-tools (7),
.IR mkinitramfs (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)
-.-
