Package: aspell
Version: 0.60.8.1-2
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 ' $' <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?
an.tmac:<stdin>:6: misuse, warning: .BR is for at least 2 arguments, got 0
Use macro '.B' for one argument or split argument.
troff:<stdin>:9: warning: trailing space in the line
troff:<stdin>:24: 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.6-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 aspell depends on:
ii dictionaries-common 1.30.2
ii libaspell15 0.60.8.1-2
ii libc6 2.40-4
ii libncursesw6 6.5-2+b1
ii libstdc++6 14.2.0-8
ii libtinfo6 6.5-2+b1
Versions of packages aspell recommends:
ii aspell-de [aspell-dictionary] 20161207-14
ii aspell-en [aspell-dictionary] 2020.12.07-0-1
ii aspell-is [aspell-dictionary] 0.51.1-0-2
Versions of packages aspell suggests:
pn aspell-doc <none>
pn spellutils <none>
-- no debconf information
Input file is prezip.1
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 prezip.1": (shortened list)
2 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z prezip.1": (shortened list)
1 Use macro '.B' for one argument or split argument.
1 .BR is for at least 2 arguments, got 0
2 trailing space in the line
-.-.
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
2
-.-.
Find a repeated word
! 9 --> a
-.-.
Split a punctuation from a single argument, if a two-font macro is meant.
17:.B prezip,
19:.B preunzip,
21:.B precat,
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
Not considered in a patch, too many lines.
prezip.1:59:do not rename .wl suffix to .cwl (use .wl.pz instead)
-.-.
Remove quotes when there is no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
1:.TH PREZIP 1 "March 2010" "GNU" "Aspell Abbreviated User's Manual"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:6: misuse, warning: .BR is for at least 2 arguments, got 0
Use macro '.B' for one argument or split argument.
troff:<stdin>:9: warning: trailing space in the line
troff:<stdin>:24: warning: trailing space in the line
-.-.
--- prezip.1 2025-01-04 10:40:24.439004094 +0000
+++ prezip.1.new 2025-01-04 10:49:47.966944216 +0000
@@ -1,12 +1,11 @@
-.TH PREZIP 1 "March 2010" "GNU" "Aspell Abbreviated User's Manual"
+.TH PREZIP 1 "March 2010" GNU "Aspell Abbreviated User's Manual"
.SH NAME
-prezip, preunzip, precat \- prefix delta compressor for Aspell
+prezip, preunzip, precat \- prefix delta compressor for Aspell
.SH SYNOPSIS
precat [\-dzhLV] [\-cfksSq] [file ...]
-.BR
.SH DESCRIPTION
.B prezip
-is a a prefix delta compressor. It is
+is a prefix delta compressor. It is
.I not
a general purpose compressor and should only be used on sorted word
lists or other similar text files. It will likely
@@ -14,14 +13,14 @@ lists or other similar text files. It w
the size of binary data.
.PP
If invoked as
-.B prezip,
+.BR prezip ,
the default action is to compress. If invoked as
-.B preunzip,
+.BR preunzip ,
the default action is to decompress. If invoked as
-.B precat,
+.BR precat ,
the default action is to decompress to stdout.
.PP
-If no file names are given then
+If no file names are given then
.B prezip
will compress or decompress from the standard input to the standard
output. Short flags can be combined so that "\-c \fB\-s\fR" is the same
@@ -56,7 +55,8 @@ keep input files
sort and remove duplicates before compressing
.TP
\fB\-S\fR \fB\-\-nocwl\fR
-do not rename .wl suffix to .cwl (use .wl.pz instead)
+do not rename .wl suffix to .cwl
+(use .wl.pz instead)
.TP
\fB\-q\fR \fB\-\-quiet\fR
suppress all warnings
