Package: xz-utils
Version: 5.6.3-1+b1
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?
troff:<stdin>:759: warning: trailing space in the line
troff:<stdin>:847: warning: trailing space in the line
an.tmac:<stdin>:871: style: use of deprecated macro: .PD
an.tmac:<stdin>:874: style: use of deprecated macro: .PD
an.tmac:<stdin>:1433: style: use of deprecated macro: .PD
an.tmac:<stdin>:1436: style: use of deprecated macro: .PD
an.tmac:<stdin>:1802: style: use of deprecated macro: .PD
an.tmac:<stdin>:1817: style: use of deprecated macro: .PD
an.tmac:<stdin>:2165: style: use of deprecated macro: .PD
an.tmac:<stdin>:2197: style: use of deprecated macro: .PD
an.tmac:<stdin>:2202: style: use of deprecated macro: .PD
an.tmac:<stdin>:2223: style: use of deprecated macro: .PD
an.tmac:<stdin>:2228: style: use of deprecated macro: .PD
an.tmac:<stdin>:2250: style: use of deprecated macro: .PD
an.tmac:<stdin>:2261: style: use of deprecated macro: .PD
an.tmac:<stdin>:2293: style: use of deprecated macro: .PD
an.tmac:<stdin>:2298: style: use of deprecated macro: .PD
an.tmac:<stdin>:2320: style: use of deprecated macro: .PD
an.tmac:<stdin>:2325: style: use of deprecated macro: .PD
an.tmac:<stdin>:2348: style: use of deprecated macro: .PD
an.tmac:<stdin>:2356: style: use of deprecated macro: .PD
an.tmac:<stdin>:2378: style: use of deprecated macro: .PD
troff:<stdin>:2612: warning: trailing space in the line
troff:<stdin>:2637: warning: trailing space in the line
troff:<stdin>:3002: 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.12.10-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 xz-utils depends on:
ii libc6 2.40-5
ii liblzma5 5.6.3-1+b1
xz-utils recommends no packages.
xz-utils suggests no packages.
-- no debconf information
Input file is xz.1
Output from "mandoc -T lint xz.1": (shortened list)
1 input text line longer than 80 bytes: xz, unxz, xzcat, lzm...
-.-.
Output from "test-groff -mandoc -t -ww -z xz.1": (shortened list)
5 trailing space in the line
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:759: warning: trailing space in the line
troff:<stdin>:847: warning: trailing space in the line
an.tmac:<stdin>:871: style: use of deprecated macro: .PD
an.tmac:<stdin>:874: style: use of deprecated macro: .PD
an.tmac:<stdin>:1433: style: use of deprecated macro: .PD
an.tmac:<stdin>:1436: style: use of deprecated macro: .PD
an.tmac:<stdin>:1802: style: use of deprecated macro: .PD
an.tmac:<stdin>:1817: style: use of deprecated macro: .PD
an.tmac:<stdin>:2165: style: use of deprecated macro: .PD
an.tmac:<stdin>:2197: style: use of deprecated macro: .PD
an.tmac:<stdin>:2202: style: use of deprecated macro: .PD
an.tmac:<stdin>:2223: style: use of deprecated macro: .PD
an.tmac:<stdin>:2228: style: use of deprecated macro: .PD
an.tmac:<stdin>:2250: style: use of deprecated macro: .PD
an.tmac:<stdin>:2261: style: use of deprecated macro: .PD
an.tmac:<stdin>:2293: style: use of deprecated macro: .PD
an.tmac:<stdin>:2298: style: use of deprecated macro: .PD
an.tmac:<stdin>:2320: style: use of deprecated macro: .PD
an.tmac:<stdin>:2325: style: use of deprecated macro: .PD
an.tmac:<stdin>:2348: style: use of deprecated macro: .PD
an.tmac:<stdin>:2356: style: use of deprecated macro: .PD
an.tmac:<stdin>:2378: style: use of deprecated macro: .PD
troff:<stdin>:2612: warning: trailing space in the line
troff:<stdin>:2637: warning: trailing space in the line
troff:<stdin>:3002: warning: trailing space in the line
-.-
Tables:
Use format 'l' (L), not 'c', for the last header column
if it is wider than data in its column.
--- xz.1 2025-01-28 06:10:43.848834963 +0000
+++ xz.1.new 2025-01-28 06:22:13.262961275 +0000
@@ -754,7 +754,7 @@ The following table summarises the featu
.PP
.TS
tab(;);
-c c c c c
+c c c c l
n n n n n.
Preset;DictSize;CompCPU;CompMem;DecMem
\-0;256 KiB;0;3 MiB;1 MiB
@@ -842,7 +842,7 @@ That way no two presets are identical.
.PP
.TS
tab(;);
-c c c c c
+c c c c l
n n n n n.
Preset;DictSize;CompCPU;CompMem;DecMem
\-0e;256 KiB;8;4 MiB;1 MiB
@@ -2607,7 +2607,7 @@ Dictionary size is roughly equal to the
.PP
.TS
tab(;);
-c c c
+c c l
c n n.
Level;xz;LZMA Utils
\-0;256 KiB;N/A
@@ -2632,7 +2632,7 @@ make the difference even bigger:
.PP
.TS
tab(;);
-c c c
+c c l
c n n.
Level;xz;LZMA Utils 4.32.x
\-0;3 MiB;N/A
@@ -2997,7 +2997,7 @@ Here are the relevant parts collected fr
.PP
.TS
tab(;);
-c c
+c l
n n.
Preset;CompCPU
\-0;0
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.
Not beginning each input sentence on a new line.
Line length 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 -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 -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)
-.-
