Bug#1086599: gccmakedep.1: Some remarks and editorial changes for this man page
Package: xutils-dev
Version: 1:7.7+7
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>':119
troff:<stdin>:119: warning: trailing space in the line
troff: backtrace: file '<stdin>':121
troff:<stdin>:121: 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.4-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 xutils-dev depends on:
ii cpp 4:14.2.0-1
ii libc6 2.40-3
xutils-dev recommends no packages.
xutils-dev suggests no packages.
-- no debconf information
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 gccmakedep.1": (possibly shortened list)
mandoc: gccmakedep.1:119:19: STYLE: whitespace at end of input line
mandoc: gccmakedep.1:121:57: STYLE: whitespace at end of input line
-.-.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
119:The version of the
121:included in this X.Org Foundation release was originally
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
11:.BI \-a
-.-.
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.
3:gccmakedep \- create dependencies in makefiles using 'gcc -M'
22:program calls 'gcc -M' to output
-.-.
Split a punctuation from a single argument, if a two-font macro is meant
35:.I Makefile.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: file '<stdin>':119
troff:<stdin>:119: warning: trailing space in the line
troff: backtrace: file '<stdin>':121
troff:<stdin>:121: warning: trailing space in the line
-.-
--- gccmakedep.1 2024-11-01 23:24:06.991493301 +0000
+++ gccmakedep.1.new 2024-11-01 23:28:31.157505519 +0000
@@ -1,6 +1,6 @@
.TH gccmakedep 1 "gccmakedep 1.0.3" "X Version 11"
.SH NAME
-gccmakedep \- create dependencies in makefiles using 'gcc -M'
+gccmakedep \- create dependencies in makefiles using 'gcc \-M'
.SH SYNOPSIS
.B gccmakedep
[
@@ -8,7 +8,7 @@ gccmakedep \- create dependencies in mak
] [
.BI \-f makefile
] [
-.BI \-a
+.B \-a
] [
\-\^\-
.I options
@@ -19,7 +19,7 @@ gccmakedep \- create dependencies in mak
.SH DESCRIPTION
The
.B gccmakedep
-program calls 'gcc -M' to output
+program calls 'gcc \-M' to output
.I makefile
rules describing the dependencies of each
.IR sourcefile ,
@@ -32,7 +32,7 @@ By default,
places its output in the file named
.I makefile
if it exists, otherwise
-.I Makefile.
+.IR Makefile .
An alternate makefile may be specified with the
.B \-f
option.
@@ -116,9 +116,9 @@ normally.
.BR make (1),
.BR makedepend (1).
.SH AUTHOR
-The version of the
+The version of the
.B gccmakedep
-included in this X.Org Foundation release was originally
+included in this X.Org Foundation release was originally
written by the XFree86 Project based on code supplied by Hongjiu Lu.
.PP
Colin Watson wrote this manual page, originally for the Debian Project,
Reply to: