Dear Maintainer,

here are notes and fixes for the man page.

####

The difference between the formatted outputs can be seen with:

  nroff -man <file1> > <out1>
  nroff -man <file2> > <out2>
  diff -u <out1> <out2>

and for groff using

"groff -man -Z" instead of "nroff -man"

#####

  Only "skipping paragraph macro" is fixed.

  Use "sed" to remove trailing spaces.

  Use "git apply ... --whitespace=fix" to fix extra space issues,
or use global configuration "core.whitespace".

  Report this to the creator of the man page.

42:.\" created by instant / docbook-to-man, Thu 31 Aug 2006, 11:05

Output from "mandoc -T lint discover-modprobe.conf.5":

mandoc: discover-modprobe.conf.5:1:2: WARNING: missing date, using "": TH
mandoc: discover-modprobe.conf.5:1:34: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:2:12: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:3:72: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:4:19: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:5:2: WARNING: skipping paragraph macro: PP after SH
mandoc: discover-modprobe.conf.5:5:4: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:6:50: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:7:55: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:8:43: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:9:4: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:10:4: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:11:14: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:12:4: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:13:33: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:14:68: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:15:66: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:16:67: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:17:49: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:18:4: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:19:4: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:20:41: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:21:40: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:22:24: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:23:22: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:24:54: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:25:21: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:26:21: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:27:46: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:28:57: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:29:40: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:30:13: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:31:40: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:32:42: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:33:43: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:34:61: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:35:64: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:36:47: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:37:20: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:39:16: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:40:2: WARNING: skipping paragraph macro: PP after SH
mandoc: discover-modprobe.conf.5:40:4: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:41:47: STYLE: whitespace at end of input line
mandoc: discover-modprobe.conf.5:42:64: STYLE: whitespace at end of input line

#######

Wrong distance between sentences.

  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.

  The amount of space between sentences in the output can then be
controlled with the ".ss" request.

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

#####

The name of a man page is set in bold type and the section in roman (see
man-pages(7)).

41:discover-modprobe(8), modprobe(8), discover(1)

#####
#####

  Not fixed in the patch.

Output from "test-nroff -man -b -ww -z":


[ "test-groff" is a developmental version of "groff" ]

Input file is ./discover-modprobe.conf.5

Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z -rSTYLECHECK=3":

an.tmac::1: style: .TH missing third argument; suggest document modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac::1: style: .TH missing fourth argument; suggest package/project name and version (e.g., "groff 1.23.0")

#####
--- discover-modprobe.conf.5	2023-06-25 15:59:41.000000000 +0000
+++ discover-modprobe.conf.5.new	2023-06-25 16:39:37.000000000 +0000
@@ -2,7 +2,6 @@
 .SH "NAME"
 discover-modprobe.conf \(em configuration file for discover-modprobe(5)
 .SH "Description"
-.PP
 \fBdiscover-modprobe.conf\fP is the configuration
 file for \fBdiscover-modprobe\fR, which is responsible
 for retrieving and loading kernel modules.
@@ -11,32 +10,34 @@ for retrieving and loading kernel module
 \fBWarning:
 .PP
 This file is a shell script, and
-as such is subject to a string variable assignment syntax. No space 
-is allowed between the variable name, the equal (=) sign, and the 
-value(s) assigned. If multiple values are to be assigned, the list 
-must be space-delimited with surrounding quotes. 
+as such is subject to a string variable assignment syntax.
+No space is allowed between the variable name,
+the equal (=) sign, and the value(s) assigned.
+If multiple values are to be assigned,
+the list must be space-delimited with surrounding quotes.
 .RE
 .PP
-Two directives can be used in this file: 
-\fBtypes\fP and \fBskip\fP. Both can be
-defined multiple times. 
+Two directives can be used in this file:
+\fBtypes\fP and \fBskip\fP.
+Both can be defined multiple times.
 .IP "\fBtypes\fP" 10
 This describes the classes of hardware that should be
 scanned and queried.
 .IP "\fBskip\fP" 10
-These modules should never be loaded. See the 
-``\fIFiles\fP'' section for details on the mechanism for
-generating these entries automatically. 
+These modules should never be loaded.
+See the
+.RI `` Files ''
+section for details on the mechanism for
+generating these entries automatically.
 .SH "Files"
 .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 
+\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(8), modprobe(8), discover(1)
 .\" created by instant / docbook-to-man, Thu 31 Aug 2006, 11:05