Package: icu-devtools
Version: 72.1-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?
an.tmac:<stdin>:19: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:22: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:25: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:53: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:56: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:60: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
* 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.17-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 icu-devtools depends on:
ii libc6 2.40-7
ii libgcc-s1 14.2.0-17
ii libicu72 72.1-6
ii libstdc++6 14.2.0-17
icu-devtools recommends no packages.
icu-devtools suggests no packages.
-- no debconf information
Input file is gencnval.1
Output from "mandoc -T lint gencnval.1": (shortened list)
-.-.
Output from "test-nroff -mandoc -t -ww -z gencnval.1": (shortened list)
6 Use macro '.B' for one argument or split argument.
6 .BR is for at least 2 arguments, got 1
-.-.
Change '-' (\-) to '\(en' (en-dash) for a (numeric) range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.
gencnval.1:91:Copyright (C) 2000-2004 IBM, Inc. and others.
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
19:.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
22:.BR "\-v\fP, \fB\-\-verbose"
25:.BR "\-c\fP, \fB\-\-copyright"
53:.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
56:.BR "\-v\fP, \fB\-\-verbose"
60:.BR "\-c\fP, \fB\-\-copyright"
-.-.
Wrong distance (not two spaces) 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.
Mark a final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
57:Display verbose output. This information can include information about
77:Specifies the directory containing ICU data. Defaults to
79:Some tools in ICU depend on the presence of the trailing slash. It is thus
86:Description of ICU's converters and their aliases. This data file is not
91:Copyright (C) 2000-2004 IBM, Inc. and others.
-.-.
One space only after a possible end of sentence
(after a punctuation, that
can end a sentence).
gencnval.1:57:Display verbose output. This information can include information
about
gencnval.1:77:Specifies the directory containing ICU data. Defaults to
gencnval.1:79:Some tools in ICU depend on the presence of the trailing slash.
It is thus
gencnval.1:86:Description of ICU's converters and their aliases. This data file
is not
gencnval.1:91:Copyright (C) 2000-2004 IBM, Inc. and others.
-.-.
Put a subordinate sentence (after a comma) on a new line.
gencnval.1:42:This binary file can then be read directly by ICU, or used by
gencnval.1:48:is not provided, the default ICU
gencnval.1:87:normally installed, and it is available as a part of ICU source
code.
gencnval.1:91:Copyright (C) 2000-2004 IBM, Inc. and others.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:19: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:22: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:25: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:53: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:56: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:60: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- gencnval.1 2025-03-12 16:53:26.220524747 +0000
+++ gencnval.1.new 2025-03-12 17:08:27.693687285 +0000
@@ -16,19 +16,19 @@
.SH SYNOPSIS
.B gencnval
[
-.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
+.BR \-h ", " \-? ", " \-\-help
]
[
-.BR "\-v\fP, \fB\-\-verbose"
+.BR \-v ", " \-\-verbose
]
[
-.BR "\-c\fP, \fB\-\-copyright"
+.BR \-c ", " \-\-copyright
]
[
-.BI "\-s\fP, \fB\-\-sourcedir" " source"
+.BR \-s ", " \-\-sourcedir " \fIsource\fP"
]
[
-.BI "\-d\fP, \fB\-\-destdir" " destination"
+.BR \-d ", " \-\-destdir " \fIdestination\fP"
]
[
.I converterfile
@@ -39,34 +39,37 @@ converts the ICU aliases file
.I converterfile
into the binary file
.BR cnvalias.icu .
-This binary file can then be read directly by ICU, or used by
+This binary file can then be read directly by ICU,
+or used by
.BR pkgdata (1)
for incorporation into a larger archive or library.
.PP
If
.I converterfile
-is not provided, the default ICU
+is not provided,
+the default ICU
.B convrtrs.txt
file is used.
.SH OPTIONS
.TP
-.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
+.BR \-h ", " \-? ", " \-\-help
Print help about usage and exit.
.TP
-.BR "\-v\fP, \fB\-\-verbose"
-Display verbose output. This information can include information about
-conflicting aliases and the converters the aliases resolve to.
+.BR \-v ", " \-\-verbose
+Display verbose output.
+This information can include information about conflicting aliases
+and the converters the aliases resolve to.
.TP
-.BR "\-c\fP, \fB\-\-copyright"
+.BR \-c ", " \-\-copyright
Include a copyright notice in the binary data.
.TP
-.BI "\-s\fP, \fB\-\-sourcedir" " source"
+.BR \-s ", " \-\-sourcedir " \fIsource\fP"
Set the source directory to
.IR source .
The default source directory is specified by the environment variable
.BR ICU_DATA .
.TP
-.BI "\-d\fP, \fB\-\-destdir" " destination"
+.BR \-d ", " \-\-destdir " \fIdestination\fP"
Set the destination directory to
.IR destination .
The default destination directory is specified by the environment variable
@@ -74,20 +77,22 @@ The default destination directory is spe
.SH ENVIRONMENT
.TP 10
.B ICU_DATA
-Specifies the directory containing ICU data. Defaults to
+Specifies the directory containing ICU data.
+Defaults to
.BR ${prefix}/share/icu/72.1/ .
-Some tools in ICU depend on the presence of the trailing slash. It is thus
-important to make sure that it is present if
+Some tools in ICU depend on the presence of the trailing slash.
+It is thus important to make sure that it is present if
.B ICU_DATA
is set.
.SH FILES
.TP \w'\fBicu/source/data/mappings/convrtrs.txt'u+3n
.B icu/source/data/mappings/convrtrs.txt
-Description of ICU's converters and their aliases. This data file is not
-normally installed, and it is available as a part of ICU source code.
+Description of ICU's converters and their aliases.
+This data file is not normally installed,
+and it is available as a part of ICU source code.
.SH VERSION
72.1
.SH COPYRIGHT
-Copyright (C) 2000-2004 IBM, Inc. and others.
+Copyright (C) 2000\(en2004 IBM, Inc.\& and others.
.SH SEE ALSO
.BR pkgdata (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
-.-
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.
"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.
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)
-.-
