Package: discover
Version: 2.1.2-10.1
Severity: minor
Tags: upstream
* 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>:1: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:3: warning: trailing space in the line
troff:<stdin>:6: warning: trailing space in the line
troff:<stdin>:7: warning: trailing space in the line
troff:<stdin>:8: warning: trailing space in the line
troff:<stdin>:11: warning: trailing space in the line
troff:<stdin>:13: warning: trailing space in the line
troff:<stdin>:14: warning: trailing space in the line
troff:<stdin>:15: warning: trailing space in the line
troff:<stdin>:16: warning: trailing space in the line
troff:<stdin>:17: warning: trailing space in the line
troff:<stdin>:20: warning: trailing space in the line
troff:<stdin>:21: warning: trailing space in the line
troff:<stdin>:22: warning: trailing space in the line
troff:<stdin>:24: warning: trailing space in the line
troff:<stdin>:25: warning: trailing space in the line
troff:<stdin>:27: warning: trailing space in the line
troff:<stdin>:28: warning: trailing space in the line
troff:<stdin>:29: warning: trailing space in the line
troff:<stdin>:32: warning: trailing space in the line
troff:<stdin>:33: warning: trailing space in the line
troff:<stdin>:34: warning: trailing space in the line
troff:<stdin>:35: warning: trailing space in the line
troff:<stdin>:36: warning: trailing space in the line
troff:<stdin>:37: warning: trailing space in the line
troff:<stdin>:41: 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.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 discover depends on:
ii debconf [debconf-2.0] 1.5.89
ii libc6 2.40-6
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.13-1
-- debconf information excluded
Input file is discover-modprobe.conf.5
Output from "mandoc -T lint discover-modprobe.conf.5": (shortened list)
1 missing date, using "": TH
2 skipping paragraph macro: PP after SH
41 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z discover-modprobe.conf.5": (shortened
list)
25 trailing space in the line
-.-.
Show if docman-to-man created this.
Who is actually creating this man page? Debian or upstream?
Is the generating software out of date?
42:.\" created by instant / docbook-to-man, Thu 31 Aug 2006, 11:05
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
36
-.-.
Use a macro to change to the italic font, instead of \fI, if
possible (see man-pages(7)).
The macros have the italic corrections, but "\c" removes the "\/" part,
which is in the macro.
So "\/" must be added between the italic argument and the "\c" string.
Or
add the italic corrections.
28:``\fIFiles\fP'' section for details on the mechanism 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.
14:as such is subject to a string variable assignment syntax. No space
16:value(s) assigned. If multiple values are to be assigned, the list
21:\fBtypes\fP and \fBskip\fP. Both can be
27:These modules should never be loaded. See the
34:module. If the file lingers, the computer is assumed to have
-.-.
Use a font macro that contains the italic correction (\,), like ".IR" or
".IB".
discover-modprobe.conf.5:28:``\fIFiles\fP'' section for details on the
mechanism for
discover-modprobe.conf.5:28:``\fIFiles\fP'' section for details on the
mechanism for
-.-.
Use a font macro that contains the right italic correction "\/" instead of a
"\fI".
28:``\fIFiles\fP'' section for details on the mechanism for
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
3:discover-modprobe.conf \(em configuration file for discover-modprobe(5)
41:discover-modprobe(8), modprobe(8), discover(1)
-.-.
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 "discover-modprobe.conf" "5"
2:.SH "NAME"
4:.SH "Description"
23:.IP "\fBtypes\fP" 10
26:.IP "\fBskip\fP" 10
30:.SH "Files"
31:.IP "\fB/var/lib/discover/crash\fP" 10
-.-.
Space character after a macro call.
5:.PP
9:.PP
10:.RS
12:.PP
18:.RE
19:.PP
40:.PP
-.-.
an.tmac:<stdin>:1: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:3: warning: trailing space in the line
troff:<stdin>:6: warning: trailing space in the line
troff:<stdin>:7: warning: trailing space in the line
troff:<stdin>:8: warning: trailing space in the line
troff:<stdin>:11: warning: trailing space in the line
troff:<stdin>:13: warning: trailing space in the line
troff:<stdin>:14: warning: trailing space in the line
troff:<stdin>:15: warning: trailing space in the line
troff:<stdin>:16: warning: trailing space in the line
troff:<stdin>:17: warning: trailing space in the line
troff:<stdin>:20: warning: trailing space in the line
troff:<stdin>:21: warning: trailing space in the line
troff:<stdin>:22: warning: trailing space in the line
troff:<stdin>:24: warning: trailing space in the line
troff:<stdin>:25: warning: trailing space in the line
troff:<stdin>:27: warning: trailing space in the line
troff:<stdin>:28: warning: trailing space in the line
troff:<stdin>:29: warning: trailing space in the line
troff:<stdin>:32: warning: trailing space in the line
troff:<stdin>:33: warning: trailing space in the line
troff:<stdin>:34: warning: trailing space in the line
troff:<stdin>:35: warning: trailing space in the line
troff:<stdin>:36: warning: trailing space in the line
troff:<stdin>:37: warning: trailing space in the line
troff:<stdin>:41: warning: trailing space in the line
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)
-.-
