Package: discover
Version: 2.1.2-10.1
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page"
[Use "groff -e ' $' <file>" to find 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?
troff: backtrace: file '<stdin>':3
troff:<stdin>:3: warning: trailing space in the line
troff: backtrace: file '<stdin>':6
troff:<stdin>:6: warning: trailing space in the line
troff: backtrace: file '<stdin>':9
troff:<stdin>:9: warning: trailing space in the line
troff: backtrace: file '<stdin>':10
troff:<stdin>:10: warning: trailing space in the line
troff: backtrace: file '<stdin>':11
troff:<stdin>:11: warning: trailing space in the line
troff: backtrace: file '<stdin>':14
troff:<stdin>:14: warning: trailing space in the line
troff: backtrace: file '<stdin>':15
troff:<stdin>:15: warning: trailing space in the line
troff: backtrace: file '<stdin>':17
troff:<stdin>:17: warning: trailing space in the line
troff: backtrace: file '<stdin>':20
troff:<stdin>:20: warning: trailing space in the line
troff: backtrace: file '<stdin>':21
troff:<stdin>:21: warning: trailing space in the line
troff: backtrace: file '<stdin>':22
troff:<stdin>:22: warning: trailing space in the line
troff: backtrace: file '<stdin>':24
troff:<stdin>:24: warning: trailing space in the line
troff: backtrace: file '<stdin>':25
troff:<stdin>:25: warning: trailing space in the line
troff: backtrace: file '<stdin>':26
troff:<stdin>:26: warning: trailing space in the line
troff: backtrace: file '<stdin>':27
troff:<stdin>:27: warning: trailing space in the line
troff: backtrace: file '<stdin>':28
troff:<stdin>:28: warning: trailing space in the line
troff: backtrace: file '<stdin>':29
troff:<stdin>:29: warning: trailing space in the line
troff: backtrace: file '<stdin>':33
troff:<stdin>:33: warning: trailing space in the line
* 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.11.5-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 discover depends on:
ii debconf [debconf-2.0] 1.5.87
ii libc6 2.40-3
ii libdiscover2 2.1.2-10.1
discover recommends no packages.
Versions of packages discover suggests:
ii lsb-base 11.6
ii sysvinit-utils [lsb-base] 3.11-1
-- debconf information excluded
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
-.-
So any 'generator' should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
This is just a simple quality control measure.
The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Input text line longer than 80 bytes.
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.
Lines should thus be shorter.
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 -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 of 'diff -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)
-.-.
Output from "mandoc -T lint discover-modprobe.8": (possibly shortened list)
mandoc: discover-modprobe.8:1:29: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:1:2: WARNING: missing date, using "": TH
mandoc: discover-modprobe.8:2:12: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:3:63: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:4:16: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:5:2: WARNING: skipping paragraph macro: PP after SH
mandoc: discover-modprobe.8:5:4: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:6:38: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:7:19: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:8:2: WARNING: skipping paragraph macro: PP after SH
mandoc: discover-modprobe.8:8:4: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:9:45: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:10:59: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:11:28: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:12:15: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:13:19: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:14:47: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:15:14: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:16:19: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:17:12: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:18:13: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:19:44: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:20:53: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:21:41: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:22:19: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:23:40: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:24:42: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:25:43: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:26:61: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:27:64: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:28:47: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:29:20: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:31:16: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:32:2: WARNING: skipping paragraph macro: PP after SH
mandoc: discover-modprobe.8:32:4: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:33:52: STYLE: whitespace at end of input line
mandoc: discover-modprobe.8:34:64: STYLE: whitespace at end of input line
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
3:discover-modprobe \(em kernel module loading using discover(1)
5:.PP
6:\fBdiscover-modprobe\fR [\-n] [\-v]
8:.PP
9:\fBdiscover-modprobe\fR loads kernel modules
10:identified by \fBdiscover\fR. It will typically be invoked
11:automatically at boot time.
13:.IP "\fB-n\fP" 10
14:Echo the \fBmodprobe\fR invocations instead of
15:running them.
16:.IP "\fB-v\fP" 10
17:Be verbose.
19:.IP "\fB/etc/discover-modprobe.conf\fP" 10
20:This configuration file defines the types of modules
21:to load by default, and specific modules
22:\fInot\fP to load.
23:.IP "\fB/var/lib/discover/crash\fP" 10
24:A crash file written and erased each time
25:\fBdiscover-modprobe\fR attempts to load a
26:module. If the file lingers, the computer is assumed to have
27:crashed while loading that module, and the module name is added
28:to \fBdiscover-modprobe.conf\fP as a module to
29:skip in the future.
32:.PP
33:discover-modprobe.conf(5), modprobe(8), discover(1)
34:.\" created by instant / docbook-to-man, Thu 31 Aug 2006, 11:05
-.-.
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:.IP "\fB-n\fP" 10
16:.IP "\fB-v\fP" 10
-.-.
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.
10:identified by \fBdiscover\fR. It will typically be invoked
26:module. If the file lingers, the computer is assumed to have
-.-.
Show if docman-to-man created this
34:.\" created by instant / docbook-to-man, Thu 31 Aug 2006, 11:05
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: file '<stdin>':3
troff:<stdin>:3: warning: trailing space in the line
troff: backtrace: file '<stdin>':6
troff:<stdin>:6: warning: trailing space in the line
troff: backtrace: file '<stdin>':9
troff:<stdin>:9: warning: trailing space in the line
troff: backtrace: file '<stdin>':10
troff:<stdin>:10: warning: trailing space in the line
troff: backtrace: file '<stdin>':11
troff:<stdin>:11: warning: trailing space in the line
troff: backtrace: file '<stdin>':14
troff:<stdin>:14: warning: trailing space in the line
troff: backtrace: file '<stdin>':15
troff:<stdin>:15: warning: trailing space in the line
troff: backtrace: file '<stdin>':17
troff:<stdin>:17: warning: trailing space in the line
troff: backtrace: file '<stdin>':20
troff:<stdin>:20: warning: trailing space in the line
troff: backtrace: file '<stdin>':21
troff:<stdin>:21: warning: trailing space in the line
troff: backtrace: file '<stdin>':22
troff:<stdin>:22: warning: trailing space in the line
troff: backtrace: file '<stdin>':24
troff:<stdin>:24: warning: trailing space in the line
troff: backtrace: file '<stdin>':25
troff:<stdin>:25: warning: trailing space in the line
troff: backtrace: file '<stdin>':26
troff:<stdin>:26: warning: trailing space in the line
troff: backtrace: file '<stdin>':27
troff:<stdin>:27: warning: trailing space in the line
troff: backtrace: file '<stdin>':28
troff:<stdin>:28: warning: trailing space in the line
troff: backtrace: file '<stdin>':29
troff:<stdin>:29: warning: trailing space in the line
troff: backtrace: file '<stdin>':33
troff:<stdin>:33: warning: trailing space in the line
--- discover-modprobe.8 2024-11-07 21:07:33.749741955 +0000
+++ discover-modprobe.8.new 2024-11-07 21:18:17.804777714 +0000
@@ -1,34 +1,30 @@
-.TH "discover-modprobe" "8"
-.SH "NAME"
-discover-modprobe \(em kernel module loading using discover(1)
-.SH "SYNOPSIS"
-.PP
-\fBdiscover-modprobe\fR [\-n] [\-v]
-.SH "Description"
-.PP
-\fBdiscover-modprobe\fR loads kernel modules
-identified by \fBdiscover\fR. It will typically be invoked
-automatically at boot time.
-.SH "Options"
-.IP "\fB-n\fP" 10
-Echo the \fBmodprobe\fR invocations instead of
-running them.
-.IP "\fB-v\fP" 10
-Be verbose.
-.SH "Files"
-.IP "\fB/etc/discover-modprobe.conf\fP" 10
-This configuration file defines the types of modules
-to load by default, and specific modules
-\fInot\fP to load.
-.IP "\fB/var/lib/discover/crash\fP" 10
-A crash file written and erased each time
-\fBdiscover-modprobe\fR attempts to load a
-module. If the file lingers, the computer is assumed to have
-crashed while loading that module, and the module name is added
-to \fBdiscover-modprobe.conf\fP as a module to
-skip in the future.
-
-.SH "See Also"
-.PP
-discover-modprobe.conf(5), modprobe(8), discover(1)
-.\" created by instant / docbook-to-man, Thu 31 Aug 2006, 11:05
+.TH "discover-modprobe" "8"
+.SH "NAME"
+discover-modprobe \(em kernel module loading using discover(1)
+.SH "SYNOPSIS"
+\fBdiscover-modprobe\fR [\-n] [\-v]
+.SH "Description"
+\fBdiscover-modprobe\fR loads kernel modules identified by \fBdiscover\fR.
+It will typically be invoked automatically at boot time.
+.SH "Options"
+.IP "\fB\-n\fP" 10
+Echo the \fBmodprobe\fR invocations instead of
+running them.
+.IP "\fB\-v\fP" 10
+Be verbose.
+.SH "Files"
+.IP "\fB/etc/discover-modprobe.conf\fP" 10
+This configuration file defines the types of modules
+to load by default, and specific modules
+\fInot\fP to load.
+.IP "\fB/var/lib/discover/crash\fP" 10
+A crash file written and erased each time
+\fBdiscover-modprobe\fR attempts to load a module.
+If the file lingers,
+the computer is assumed to have crashed while loading that module,
+and the module name is added to \fBdiscover-modprobe.conf\fP as a module to
+skip in the future.
+
+.SH "See Also"
+discover-modprobe.conf(5), modprobe(8), discover(1)
+.\" created by instant / docbook-to-man, Thu 31 Aug 2006, 11:05
