Package: icu-devtools
Version: 72.1-5+b1
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>':12
troff:<stdin>:12: warning: trailing space in the line
troff: backtrace: file '<stdin>':44
troff:<stdin>:44: warning: trailing space in the line
troff: backtrace: file '<stdin>':81
troff:<stdin>:81: warning: trailing space in the line
troff: backtrace: file '<stdin>':86
troff:<stdin>:86: warning: trailing space in the line
troff: backtrace: file '<stdin>':98
troff:<stdin>:98: 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.5-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-3
ii libgcc-s1 14.2.0-6
ii libicu72 72.1-5+b1
ii libstdc++6 14.2.0-6
icu-devtools recommends no packages.
icu-devtools suggests no packages.
-- no debconf information
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 gensprep.8": (possibly shortened list)
mandoc: gensprep.8:12:67: STYLE: whitespace at end of input line
mandoc: gensprep.8:44:9: STYLE: whitespace at end of input line
mandoc: gensprep.8:81:37: STYLE: whitespace at end of input line
mandoc: gensprep.8:85:20: STYLE: whitespace at end of input line
mandoc: gensprep.8:86:76: STYLE: whitespace at end of input line
mandoc: gensprep.8:92:111: STYLE: input text line longer than 80 bytes:
Contains the list of...
mandoc: gensprep.8:98:94: STYLE: input text line longer than 80 bytes: Contains
the list of...
mandoc: gensprep.8:98:94: STYLE: whitespace at end of input line
-.-.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
12:\- compile StringPrep data from files filtered by filterRFC3454.pl
44:section.
81:/misc for rfc3454_*.txt files and in
85:.B rfc3453_A_1.txt
86:Contains the list of unassigned codepoints in Unicode version 3.2.0.\|.\|..
98:Contains the list of code points whose normalization has changed since
Unicode Version 3.2.0.
-.-.
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.
gensprep.8:102:Copyright (C) 2000-2002 IBM, Inc. and others.
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
16:.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
19:.BR "\-v\fP, \fB\-\-verbose"
22:.BI "\-c\fP, \fB\-\-copyright"
47:.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
50:.BR "\-v\fP, \fB\-\-verbose"
53:.BI "\-c\fP, \fB\-\-copyright"
-.-.
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.
70:Specifies the directory containing ICU data. Defaults to
72:Some tools in ICU depend on the presence of the trailing slash. It is thus
102:Copyright (C) 2000-2002 IBM, Inc. and others.
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Line 92, length 111
Contains the list of mappings for casefolding of code points when
Normalization form NFKC is specified.\|.\|..
Line 98, length 94
Contains the list of code points whose normalization has changed since Unicode
Version 3.2.0.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: file '<stdin>':12
troff:<stdin>:12: warning: trailing space in the line
troff: backtrace: file '<stdin>':44
troff:<stdin>:44: warning: trailing space in the line
troff: backtrace: file '<stdin>':81
troff:<stdin>:81: warning: trailing space in the line
troff: backtrace: file '<stdin>':86
troff:<stdin>:86: warning: trailing space in the line
troff: backtrace: file '<stdin>':98
troff:<stdin>:98: warning: trailing space in the line
-.-
Additionally (general):
Abbreviations get a '\&' added after their final full stop (.) to mark them
as such and not as an end of a sentence.
".\|.\|.." > ".\|.\|."
--- gensprep.8 2024-11-10 00:55:20.915677554 +0000
+++ gensprep.8.new 2024-11-10 01:16:05.300735544 +0000
@@ -9,17 +9,17 @@
.TH gensprep 8 "18 March 2003" "ICU MANPAGE" "ICU 72.1 Manual"
.SH NAME
.B gensprep
-\- compile StringPrep data from files filtered by filterRFC3454.pl
+\- compile StringPrep data from files filtered by filterRFC3454.pl
.SH SYNOPSIS
.B gensprep
[
-.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
+.B "\-h\fP, \fB\-?\fP, \fB\-\-help"
]
[
-.BR "\-v\fP, \fB\-\-verbose"
+.B "\-v\fP, \fB\-\-verbose"
]
[
-.BI "\-c\fP, \fB\-\-copyright"
+.B "\-c\fP, \fB\-\-copyright"
]
[
.BI "\-s\fP, \fB\-\-sourcedir" " source"
@@ -41,7 +41,7 @@ The files read by
.B gensprep
are described in the
.B FILES
-section.
+section.
.SH OPTIONS
.TP
.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
@@ -67,10 +67,11 @@ 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
@@ -78,27 +79,29 @@ The following files are read by
.B gensprep
and are looked for in the
.I source
-/misc for rfc3454_*.txt files and in
+/misc for rfc3454_*.txt files and in
.I source
/unidata for NormalizationCorrections.txt.
.TP 20
-.B rfc3453_A_1.txt
-Contains the list of unassigned codepoints in Unicode version 3.2.0.\|.\|..
+.B rfc3453_A_1.txt
+Contains the list of unassigned codepoints in Unicode version 3.2.0.\|.\|.
.TP
.B rfc3454_B_1.txt
-Contains the list of code points that are commonly mapped to nothing.\|.\|..
+Contains the list of code points that are commonly mapped to nothing.\|.\|.
.TP
.B rfc3454_B_2.txt
-Contains the list of mappings for casefolding of code points when
Normalization form NFKC is specified.\|.\|..
+Contains the list of mappings for casefolding of code points when
+Normalization form NFKC is specified.\|.\|.
.TP
.B rfc3454_C_X.txt
Contains the list of code points that are prohibited for IDNA.
.TP
.B NormalizationCorrections.txt
-Contains the list of code points whose normalization has changed since Unicode
Version 3.2.0.
+Contains the list of code points whose normalization has changed since
+Unicode Version 3.2.0.
.SH VERSION
72.1
.SH COPYRIGHT
-Copyright (C) 2000-2002 IBM, Inc. and others.
+Copyright (C) 2000\(en2002 IBM, Inc.\& and others.
.SH SEE ALSO
.BR pkgdata (8)
