#1039084 discover-config.1: remarks and a patch for the manual

Package:
debianutils
Source:
debianutils
Description:
Miscellaneous utilities specific to Debian
Submitter:
Bjarni Ingi Gislason
Date:
2023-07-12 21:09:03 UTC
Severity:
normal
Tags:
#1039084#5
Date:
2023-06-25 14:55:41 UTC
From:
To:
Dear Maintainer,

here are some notes and a patch 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 in the patch!

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


Output from "mandoc -T lint discover-config.1":

mandoc: discover-config.1:1:27: STYLE: whitespace at end of input line
mandoc: discover-config.1:1:2: WARNING: missing date, using "": TH
mandoc: discover-config.1:2:12: STYLE: whitespace at end of input line
mandoc: discover-config.1:3:35: STYLE: whitespace at end of input line
mandoc: discover-config.1:4:16: STYLE: whitespace at end of input line
mandoc: discover-config.1:5:2: WARNING: skipping paragraph macro: PP after SH
mandoc: discover-config.1:5:4: STYLE: whitespace at end of input line
mandoc: discover-config.1:6:33: STYLE: whitespace at end of input line
mandoc: discover-config.1:7:19: STYLE: whitespace at end of input line
mandoc: discover-config.1:8:2: WARNING: skipping paragraph macro: PP after SH
mandoc: discover-config.1:8:4: STYLE: whitespace at end of input line
mandoc: discover-config.1:9:30: STYLE: whitespace at end of input line
mandoc: discover-config.1:10:41: STYLE: whitespace at end of input line
mandoc: discover-config.1:11:15: STYLE: whitespace at end of input line
mandoc: discover-config.1:12:24: STYLE: whitespace at end of input line
mandoc: discover-config.1:13:50: STYLE: whitespace at end of input line
mandoc: discover-config.1:14:44: STYLE: whitespace at end of input line
mandoc: discover-config.1:15:11: STYLE: whitespace at end of input line
mandoc: discover-config.1:16:34: STYLE: whitespace at end of input line
mandoc: discover-config.1:17:30: STYLE: whitespace at end of input line
mandoc: discover-config.1:18:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:19:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:20:20: STYLE: whitespace at end of input line
mandoc: discover-config.1:21:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:22:20: STYLE: whitespace at end of input line
mandoc: discover-config.1:23:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:24:20: STYLE: whitespace at end of input line
mandoc: discover-config.1:25:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:26:14: STYLE: whitespace at end of input line
mandoc: discover-config.1:27:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:28:15: STYLE: whitespace at end of input line
mandoc: discover-config.1:29:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:30:14: STYLE: whitespace at end of input line
mandoc: discover-config.1:31:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:32:11: STYLE: whitespace at end of input line
mandoc: discover-config.1:33:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:34:13: STYLE: whitespace at end of input line
mandoc: discover-config.1:35:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:36:18: STYLE: whitespace at end of input line
mandoc: discover-config.1:37:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:38:13: STYLE: whitespace at end of input line
mandoc: discover-config.1:39:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:40:14: STYLE: whitespace at end of input line
mandoc: discover-config.1:41:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:42:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:43:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:44:14: STYLE: whitespace at end of input line
mandoc: discover-config.1:45:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:46:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:47:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:48:21: STYLE: whitespace at end of input line
mandoc: discover-config.1:49:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:50:20: STYLE: whitespace at end of input line
mandoc: discover-config.1:51:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:52:13: STYLE: whitespace at end of input line
mandoc: discover-config.1:53:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:54:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:55:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:56:20: STYLE: whitespace at end of input line
mandoc: discover-config.1:57:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:58:14: STYLE: whitespace at end of input line
mandoc: discover-config.1:59:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:60:13: STYLE: whitespace at end of input line
mandoc: discover-config.1:61:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:62:12: STYLE: whitespace at end of input line
mandoc: discover-config.1:63:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:64:16: STYLE: whitespace at end of input line
mandoc: discover-config.1:65:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:66:19: STYLE: whitespace at end of input line
mandoc: discover-config.1:67:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:68:15: STYLE: whitespace at end of input line
mandoc: discover-config.1:69:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:70:11: STYLE: whitespace at end of input line
mandoc: discover-config.1:71:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:72:15: STYLE: whitespace at end of input line
mandoc: discover-config.1:73:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:74:18: STYLE: whitespace at end of input line
mandoc: discover-config.1:75:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:76:14: STYLE: whitespace at end of input line
mandoc: discover-config.1:77:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:78:13: STYLE: whitespace at end of input line
mandoc: discover-config.1:79:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:80:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:81:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:82:20: STYLE: whitespace at end of input line
mandoc: discover-config.1:83:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:84:16: STYLE: whitespace at end of input line
mandoc: discover-config.1:85:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:86:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:87:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:88:18: STYLE: whitespace at end of input line
mandoc: discover-config.1:89:17: STYLE: whitespace at end of input line
mandoc: discover-config.1:90:13: STYLE: whitespace at end of input line
mandoc: discover-config.1:91:64: STYLE: whitespace at end of input line

#######

Use 'sed -e '  *$' to remove trailing space.

91:.\" created by instant / docbook-to-man, Mon 06 Aug 2007, 17:47

Report this to the creator of the man page.

#####

Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.

16:.IP "\fB-l, \-\-list-vars\fP" 10

#####

  Not in the patch!

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

Input file is ./discover-config.1

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-config.1	2023-06-25 14:20:10.000000000 +0000
+++ discover-config.1.new	2023-06-25 14:38:19.000000000 +0000
@@ -2,10 +2,8 @@
 .SH "NAME"
 discover-config \(em config script
 .SH "SYNOPSIS"
-.PP
 \fBdiscover-config\fR [options]
 .SH "Description"
-.PP
 \fBdiscover-config\fR reports
 stuff about the package's configuration.
 .SH "Options"
@@ -13,7 +11,7 @@ stuff about the package's configuration.
 Print the value of the variable VAR followed by a
 newline.  See below for a list of available
 variables.
-.IP "\fB-l, \-\-list-vars\fP" 10
+.IP "\fB\-l, \-\-list-vars\fP" 10
 List the available variables.
 .SH "Variables"
 .IP "   \(bu" 6

#1039084#10
Date:
2023-07-12 21:03:02 UTC
From:
To:
discover-config.1 is not in the source.