Package: xfonts-utils
Version: 1:7.7+7
Severity: minor
Tags: patch
* 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?
devtag.tmac: warning: Refrain from reading this file again
* 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 xfonts-utils depends on:
ii libc6 2.40-7
ii libfontenc1 1:1.1.8-1+b2
ii libfreetype6 2.13.3+dfsg-1
ii x11-common 1:7.7+24
ii xfonts-encodings 1:1.0.4-2.2
ii zlib1g 1:1.3.dfsg+really1.3.1-1+b1
xfonts-utils recommends no packages.
xfonts-utils suggests no packages.
-- no debconf information
Input file is update-fonts-dir.8
Output from "mandoc -T lint update-fonts-dir.8": (shortened list)
1 skipping insecure request: mso
3 whitespace at end of input line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Output from "test-groff -mandoc -t -ww -z update-fonts-dir.8": (shortened list)
2 trailing space in the line
Remove trailing space with: sed -e 's/ *$//'
-.-.
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
3
-.-.
FSF office address update. See
https://lists.gnu.org/archive/html/bug-gnulib/2024-09/msg00004.html
17:.\" Suite 330, Boston, MA 02111-1307 USA
-.-.
Trailing space in a macro call.
Remove with "sed -i -e 's/ *$//'"
94:.IR /usr/share/fonts/X11/ directory
-.-.
Section headings (.SH and .SS) do not need quoting.
148:.SH "EXIT STATUS"
174:.SH "SEE ALSO"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
devtag.tmac: warning: Refrain from reading this file again
troff:<stdin>:93: warning: trailing space in the line
troff:<stdin>:95: warning: trailing space in the line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- update-fonts-dir.8 2025-02-28 17:24:09.003667398 +0000
+++ update-fonts-dir.8.new 2025-02-28 17:30:49.020033775 +0000
@@ -90,9 +90,9 @@ in package maintainer scripts is provide
displays a brief usage message and exits.
.PP
.B \-7\fR, \fB\-\-x11r7\-layout
-switches the font layout to the one introduced in X11R7: fonts in
-.IR /usr/share/fonts/X11/ directory
-(default is: fonts in
+switches the font layout to the one introduced in X11R7: fonts in
+.IR /usr/share/fonts/X11/ directory
+(default is: fonts in
.IR /usr/lib/X11/fonts/ directory)
.SH OPERANDS
.B update\-fonts\-dir
@@ -145,7 +145,7 @@ The supplied
was invalid.
.B update\-fonts\-dir
skipped it.
-.SH "EXIT STATUS"
+.SH EXIT STATUS
.TP
0
.B update\-fonts\-dir
@@ -171,6 +171,6 @@ command.
.SH AUTHOR
.B update\-fonts\-dir
was written by Branden Robinson.
-.SH "SEE ALSO"
+.SH SEE ALSO
.BR mkfontdir (1x)
.\" vim:set et tw=80:
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.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
Not beginning each input sentence on a new line.
Line length and patch size 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)
-.-
