Package: locales Version: 2.43-4 Severity: minor Tags: patch Additional remarks.
Mails from me to "[email protected]" are no longer acknowledged. A Debian maintainer told me, that he would contact the mail administrator about me not wanting to send bugs upstream. -.- Dear Maintainer, >From "/usr/share/doc/debian/bug-reporting.txt.gz": Don't file bugs upstream If you file a bug in Debian, don't send a copy to the upstream software maintainers yourself, as it is possible that the bug exists only in Debian. If necessary, the maintainer of the package will forward the bug upstream. -.- For forwarding bug reports to upstream see: https://www.debian.org/Bugs/Developer#forward -.- "Handling bug reports" in http://people.debian.org/~enrico/dcg/ch03s02.html -.- I do not send reports upstream if I have to get an account there. The Debian maintainers have one already. -.- * 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=0 -ww -z < "man page" [Use grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' -e ' "$' <file> to find (most) 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? Output from "test-groff -mandoc -K utf8 -rF0 -rHY=0 -ww -z ": an.tmac:<stdin>:1: style: .TH missing fifth argument and second argument '8' not a recognized manual section; specify its title troff:<stdin>:10: warning: end of sentence detected before end of text line [-w style] * 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: forky/sid APT prefers testing APT policy: (500, 'testing') Architecture: amd64 (x86_64) Kernel: Linux 7.1.12+deb14-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.92 ii libc-bin 2.43-4 ii libc-l10n 2.43-4 locales recommends no packages. locales suggests no packages. -- debconf information excluded
Input file is validlocale.8
Output from "mandoc -T lint validlocale.8": (shortened list)
1 STYLE: input text line longer than 80 bytes
14 STYLE: whitespace at end of input line
7 WARNING: skipping paragraph macro: PP after SH
3 WARNING: skipping paragraph macro: PP empty
-.-.
Output from
test-groff mandoc -Kutf8 -ww -z validlocale.8: (shortened list)
1 .TH missing fifth argument and second argument '8' not a recognized
manual section; specify its title
1 end of sentence detected before end of text line [-w style]
-.-.
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".
See more information in the attachment "trailing whitespace".
Number of lines affected is
18
-.-.
Split lines longer than 80 characters (fill completely
an A4 sized page line on a terminal)
into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Line 35, length 131
outputs a string on stderr telling that this is an invalid locale, and a string
to stdout with the string to add to /etc/locale.gen
Longest line is number 35 with 131 characters
-.-.
The name of a man page is typeset in bold (or italic) and the section in
roman (see man-pages(7)).
49:locale\-gen(8), localedef(1), locale(1)
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
validlocale.8:12:locale\-gen generate the locale (if it exists at all).
validlocale.8:34:When given a invalid (not generated or just nonexistent), it
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
validlocale.8:1:.TH "validlocale" "8" "0.1" "Petter Reinholdtsen" ""
validlocale.8:2:.SH "NAME"
validlocale.8:5:.SH "SYNTAX"
validlocale.8:8:.SH "DESCRIPTION"
validlocale.8:13:.SH "FILES"
validlocale.8:24:.SH "EXAMPLES"
validlocale.8:44:.SH "AUTHORS"
-.-.
Remove a space character after a macro call.
3:.LP
6:.LP
9:.LP
14:.LP
19:.LP
20:.TP
25:.LP
28:.LP
29:.IP
33:.LP
37:.LP
38:.IP
45:.LP
48:.LP
-.-.
Additionally:
The last argument of the macro TH may not be empty (has then no meaning
and causes a warning).
-.-
Size/bytes:
1226 validlocale.8
1166 validlocale.8.new
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-.-
Tables:
Use the preprocessor 'tbl' to make tables.
Put data, that are wider than the header in the (centered) last column,
in a "T{...\nT}" block.
Table headings, that are wider than any data in the corresponding
column, do not need to be centered, so left adjustment (l, L) is
sufficient. There is thereby no change in the standard output.
--- validlocale.8 2026-09-05 01:10:26.301975869 +0000 +++ validlocale.8.new 2026-09-05 02:33:49.306297922 +0000 @@ -1,49 +1,39 @@ -.TH "validlocale" "8" "0.1" "Petter Reinholdtsen" "" -.SH "NAME" -.LP +.TH validlocale 8 "0.1" "Petter Reinholdtsen" +.SH NAME validlocale \- Test if a given locale is available -.SH "SYNTAX" -.LP +.SH SYNTAX validlocale <\fIlocale\fP> -.SH "DESCRIPTION" -.LP +.SH DESCRIPTION Test if the locale given as argument is a valid locale. If it isn't, print on stdout the string to add to /etc/locale.gen to make locale\-gen generate the locale (if it exists at all). -.SH "FILES" -.LP +.SH FILES \fI/usr/sbin/validlocale\fP .br \fI/usr/share/i18n/SUPPORTED\fP .SH "ENVIRONMENT VARIABLES" -.LP -.TP +.TP \fBDEFAULTCHARSET\fP Which charset to assume if the given locale is missing from the list of supported locales. -.SH "EXAMPLES" -.LP +.SH EXAMPLES If you give a valid locale as parameter, it outputs a string specifying this on stderr: -.LP -.IP +.IP % validlocale C .br locale 'C' valid and available -.LP +.LP When given a invalid (not generated or just nonexistent), it outputs a string on stderr telling that this is an invalid locale, and a string to stdout with the string to add to /etc/locale.gen to have this locale generated: -.LP -.IP +.IP % validlocale de_AU@euro .br locale 'de_AU@euro' not available .br de_AU@euro ISO\-8859\-15 -.SH "AUTHORS" -.LP +.SH AUTHORS Petter Reinholdtsen <[email protected]> .SH "SEE ALSO" -.LP -locale\-gen(8), localedef(1), locale(1) +.BR locale\-gen "(8), " localedef "(1), " locale (1)
Check the output from "lintian" in the Debian distribution. 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> To find most trailing spaces use grep -n -e ' $' -e ' \\f.$' -e ' \\"' -e ' "$' <man page> The same goes for man pages that are used as an input. -.- For a style guide use mandoc -T lint -.- For general input conventions consult the man page "nroff(7)" (item "Input conventions") or the Texinfo manual about the same item. -.- 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. Debian can fix simple bugs in the used generators and distribute them, and does not need to wait for upstream to do that and distribute them. -.- 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 when that has been fixed. 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 a script "cmp.manuals" in the attachment. Or 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) -.-
cmp.manuals.gz
Description: application/gzip
