Package: aspell
Version: 0.60.8.1-1+b2
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>':23
troff:<stdin>:23: 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.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 aspell depends on:
ii dictionaries-common 1.30.2
ii libaspell15 0.60.8.1-1+b2
ii libc6 2.40-3
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 aspell-import.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 aspell-import.1 ": (shortened list)
2 skipping paragraph macro
1 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -b -z aspell-import.1 ": (shortened list)
1 trailing space in the line
-.-.
Output from "mandoc -T lint aspell-import.1 ":
mandoc: aspell-import.1:6:2: WARNING: skipping paragraph macro: br at the end
of SH
mandoc: aspell-import.1:15:2: WARNING: skipping paragraph macro: PP after SH
mandoc: aspell-import.1:23:4: STYLE: whitespace at end of input line
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
23:The
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
21:.BR Aspell
-.-.
Wrong distance between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
10:import them into GNU Aspell. It will look for both Ispell and Aspell
11:dictionaries. To use it just run it from the command prompt.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: file '<stdin>':23
troff:<stdin>:23: warning: trailing space in the line
-.-
Add a missing '.' (end of sentence).
--- aspell-import.1 2024-12-01 22:55:49.982396270 +0000
+++ aspell-import.1.new 2024-12-01 23:28:07.658531866 +0000
@@ -3,24 +3,24 @@
aspell-import \- import old personal dictionaries into GNU Aspell
.SH SYNOPSIS
.B aspell-import
-.br
.SH DESCRIPTION
.B aspell-import
-is a command that will search for old personal dictionaries and will
-import them into GNU Aspell. It will look for both Ispell and Aspell
-dictionaries. To use it just run it from the command prompt.
+is a command
+that will search for old personal dictionaries
+and will import them into GNU Aspell.
+It will look for both Ispell and Aspell dictionaries.
+To use it just run it from the command prompt.
.SH OPTIONS
This program does not accept any command-line options.
.SH SEE ALSO
-.PP
.BR aspell (1),
.BR run\-with\-aspell (1),
.BR word\-list\-compress (1)
.PP
The full documentation for
-.BR Aspell
-is maintained as a Texinfo manual
-The
+.B Aspell
+is maintained as a Texinfo manual.
+The
.RB "`\|" aspell "\|'"
entry in
.B info
