Package: locales
Version: 2.40-6
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>:28: warning: trailing space in the line
troff:<stdin>:30: 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.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 locales depends on:
ii debconf [debconf-2.0] 1.5.89
ii libc-bin 2.40-6
ii libc-l10n 2.40-6
locales recommends no packages.
locales suggests no packages.
-- debconf information excluded
Input file is locale.gen.5
Output from "mandoc -T lint locale.gen.5": (shortened list)
2 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z locale.gen.5": (shortened list)
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
-.-.
FSF office address update. See
https://lists.gnu.org/archive/html/bug-gnulib/2024-09/msg00004.html
16:.\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-.-.
Section headings (.SH and .SS) do not need quoting.
18:.SH "NAME"
20:.SH "DESCRIPTION"
38:.SH "SEE ALSO"
40:.SH "AUTHOR"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:28: warning: trailing space in the line
troff:<stdin>:30: warning: trailing space in the line
--- locale.gen.5 2025-02-12 02:15:05.571480220 +0000
+++ locale.gen.5.new 2025-02-12 02:20:30.521788206 +0000
@@ -15,9 +15,9 @@
.\" along with this program; if not, write to the Free Software Foundation,
.\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.TH locale.gen 5 "July 2005" "Debian GNU/Linux"
-.SH "NAME"
+.SH NAME
locale.gen \- Configuration file for locale-gen
-.SH "DESCRIPTION"
+.SH DESCRIPTION
The file \fI/etc/locale.gen\fP lists the locales that are to be generated
by the \fBlocale-gen\fP command.
@@ -25,9 +25,9 @@ Each line is of the form:
<locale> <charset>
-where <locale> is one of the locales given in
+where <locale> is one of the locales given in
.B /usr/share/i18n/locales
-and <charset> is one of the character sets listed in
+and <charset> is one of the character sets listed in
.B /usr/share/i18n/charmaps
The
@@ -35,7 +35,7 @@ The
command will generate all the locales, placing them in
\fB/usr/lib/locale\fP.
-.SH "SEE ALSO"
+.SH SEE ALSO
\fBlocale-gen\fP(8), \fBlocaledef\fP(1), \fBlocale\fP(1)
-.SH "AUTHOR"
+.SH AUTHOR
Alastair McKinstry <mckins...@computer.org>
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 -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)
-.-
