#1039113 discover-pkginstall.8: some remarks and a patch for the manual

Package:
debianutils
Source:
debianutils
Description:
Miscellaneous utilities specific to Debian
Submitter:
Bjarni Ingi Gislason
Date:
2023-06-25 20:15:04 UTC
Severity:
normal
Tags:
#1039113#5
Date:
2023-06-25 20:12:18 UTC
From:
To:
Dear Maintainer,

here are some notes and a fix 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"

#####

  Spelling mistakes:

intsall
pkgintsall

#####

  Only "skipping paragraph ..." is in the patch.

  Use "sed" to remove trailing space.

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

  Report defects to the creator.

27:.\" created by instant / docbook-to-man, Sun 13 Jan 2008, 09:40


Output from "mandoc -T lint discover-pkginstall.8":

mandoc: discover-pkginstall.8:1:2: WARNING: missing date, using "": TH
mandoc: discover-pkginstall.8:1:31: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:2:12: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:3:83: STYLE: input text line longer than 80 bytes: discover-pkginstall ...
mandoc: discover-pkginstall.8:3:83: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:4:16: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:5:2: WARNING: skipping paragraph macro: PP after SH
mandoc: discover-pkginstall.8:5:4: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:6:47: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:7:19: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:8:2: WARNING: skipping paragraph macro: PP after SH
mandoc: discover-pkginstall.8:8:4: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:9:49: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:10:65: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:11:61: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:12:64: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:13:64: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:14:30: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:15:15: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:16:19: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:17:32: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:18:19: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:19:25: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:20:51: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:21:6: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:22:19: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:23:12: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:24:16: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:25:2: WARNING: skipping paragraph macro: PP after SH
mandoc: discover-pkginstall.8:25:4: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:26:46: STYLE: whitespace at end of input line
mandoc: discover-pkginstall.8:27:64: STYLE: whitespace at end of input line

#######

Reduce space between words.

6:\fBdiscover-pkginstall\fR [\-l]  [\-n]  [\-v]

#####

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

16:.IP "\fB-l\fP" 10
18:.IP "\fB-n\fP" 10
22:.IP "\fB-v\fP" 10

#####

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

26:aptitude(8), discover(1), module-assistant(8)

#####

  Not in the patch.

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

Input file is ./discover-pkginstall.8

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

an.tmac:<stdin>:1: style: .TH missing third argument; suggest document
modification date in ISO 8601 format (YYYY-MM-DD)

an.tmac:<stdin>:1: style: .TH missing fourth argument; suggest
package/project name and version (e.g., "groff 1.23.0")

####
--- discover-pkginstall.8	2023-06-25 19:23:06.000000000 +0000
+++ discover-pkginstall.8.new	2023-06-25 19:53:03.000000000 +0000
@@ -1,11 +1,9 @@
-.TH "discover-pkgintsall" "8"
+.TH "discover-pkginstall" "8"
 .SH "NAME"
-discover-pkginstall \(em intsall packages for available hardware using discover(1) 
+discover-pkginstall \(em install packages for available hardware using discover(1)
 .SH "SYNOPSIS"
-.PP
-\fBdiscover-pkginstall\fR [\-l]  [\-n]  [\-v]
+\fBdiscover-pkginstall\fR [\-l] [\-n] [\-v]
 .SH "Description"
-.PP
 \fBdiscover-pkginstall\fR install packages based
 on detected hardware.  It will use the discover-data database to
 map for hardware to debian packages, install the packages by
@@ -13,15 +11,16 @@ default.  Packages using module-assistan
 built and the result installed if module-assistant is installed
 or pulled in as a dependency.
 .SH "Options"
-.IP "\fB-l\fP" 10
+.IP "\fB\-l\fP" 10
 Only list the detected packages
-.IP "\fB-n\fP" 10
+.IP "\fB\-n\fP" 10
 Echo the \fBaptitude and
 module-assistant\fR invocations instead of running
 them.
-.IP "\fB-v\fP" 10
+.IP "\fB\-v\fP" 10
 Be verbose.
 .SH "See Also"
-.PP
-aptitude(8), discover(1), module-assistant(8) 
+.BR aptitude (8),
+.BR discover (1),
+.BR module-assistant (8)
 .\" created by instant / docbook-to-man, Sun 13 Jan 2008, 09:40