Package: icu-devtools
Version: 72.1-5+b1
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 ' $' <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?
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: .BI 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>:41: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:44: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:102: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:149: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:153: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:156: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:159: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
troff:<stdin>:165: warning: trailing space in the line
troff:<stdin>:170: warning: trailing space in the line
an.tmac:<stdin>:175: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:178: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
troff:<stdin>:190: warning: trailing space in the line
an.tmac:<stdin>:191: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:205: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:224: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:227: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:250: misuse, warning: .BI 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.6-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-4
ii libgcc-s1 14.2.0-8
ii libicu72 72.1-5+b1
ii libstdc++6 14.2.0-8
icu-devtools recommends no packages.
icu-devtools suggests no packages.
-- no debconf information
Input file is 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
-.-
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 pkgdata.1": (shortened list)
1 input text line longer than 80 bytes
8 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z pkgdata.1": (shortened list)
17 Use macro '.B' for one argument or split argument.
7 .BI is for at least 2 arguments, got 1
10 .BR is for at least 2 arguments, got 1
3 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
8
-.-.
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.
pkgdata.1:259:Copyright (C) 2000-2009 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:.BI "\-v\fP, \fB\-\-verbose"
25:.BR "\-c\fP, \fB\-\-copyright"
41:.BI "\-F\fP, \fB\-\-rebuild"
44:.BI "\-I\fP, \fB\-\-install"
102:.BR static
149:.BR make
153:.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
156:.BR "\-v\fP, \fB\-\-verbose"
159:.BR "\-c\fP, \fB\-\-copyright"
175:.BR common
178:.BR dll
191:.BR icu-config
205:.BI "\-n\fP, \fB\-\-name"
224:.BI "\-F\fP, \fB\-\-rebuild"
227:.BI "\-I\fP, \fB\-\-install"
250:.BI "\-d\fP, \fB\-\-destdir"
-.-.
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.
Mark a final abbreviation point as such by suffixing it with "\&".
61:applications that use ICU. The typical reason to package files using
82:ICU. Data packaged using this mode will be looked up under the ICU
83:data directory. Such packaging is easy to use for applications resource
91:mode, where the data files are compiled into a shared library. ICU
93:ICU 2.0, such support has been removed. This mode is still useful for
96:linked to the application that uses them. Such resource bundles can
139:them as a single file or library. This mode is mainly intended to
142:GNU/Linux for example. Please refer to the packaging documentation in
174:section above. The valid mode names are
185:Specify options for the builder. The builder is used internally by
187:to generate the correct packaged file. Such options include, but are
190:during the build of the packaged file. Note: If
213:mode. The version number has the format
217:are optional. If only
230:mode). If the variable
259:Copyright (C) 2000-2009 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 147, length 85
builds, packages, installs, or cleans the appropriate data based on the options
given
-.-.
Use a font macro that contains the italic correction (\,), like ".IR" or
".IB".
pkgdata.1:214:.I major\fP.\fIminor\fP.\fIpatchlevel
pkgdata.1:214:.I major\fP.\fIminor\fP.\fIpatchlevel
-.-.
Put a subordinate sentence (after a comma) on a new line.
67:resource files, or even with none at all if they link against the
80:In this mode, the different data files are bundled together as an
84:bundles, for example, as long as the application can install the
91:mode, where the data files are compiled into a shared library. ICU
92:used to be able to dynamically load these shared libraries, but as of
93:ICU 2.0, such support has been removed. This mode is still useful for
94:two main purposes: to build ICU itself, as the ICU data is packaged as
98:looking for shared libraries, instead of being forced to live inside
147:builds, packages, installs, or cleans the appropriate data based on the
options given
187:to generate the correct packaged file. Such options include, but are
188:not limited to, setting variables used by
192:is available, then this option is not needed.
-.-.
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: .BI 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>:41: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:44: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:102: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:149: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:153: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:156: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:159: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
troff:<stdin>:165: warning: trailing space in the line
troff:<stdin>:170: warning: trailing space in the line
an.tmac:<stdin>:175: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:178: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
troff:<stdin>:190: warning: trailing space in the line
an.tmac:<stdin>:191: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:205: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:224: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:227: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:250: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
-.-.
Spelling:
files -> file (in "a files mode")
Additionally (general):
Abbreviations get a '\&' added after their final full stop (.) to mark them
as such and not as an end of a sentence.
--- pkgdata.1 2025-01-03 00:57:38.019530964 +0000
+++ pkgdata.1.new 2025-01-03 02:19:20.227139973 +0000
@@ -16,60 +16,73 @@
.SH SYNOPSIS
.B pkgdata
[
-.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
+.BR \-h ", " \-? ", " \-\-help
]
[
-.BI "\-v\fP, \fB\-\-verbose"
+.BR \-v ", " \-\-verbose
]
[
-.BR "\-c\fP, \fB\-\-copyright"
+.BR \-c ", " \-\-copyright
|
-.BI "\-C\fP, \fB\-\-comment" " comment"
+.BR \-C ", " \-\-comment
+.I comment
]
[
-.BI "\-m\fP, \fB\-\-mode" " mode"
+.BR \-m ", " \-\-mode
+.I mode
]
-.BI "\-p\fP, \fB\-\-name" " name"
-.BI "\-O\fP, \fB\-\-bldopt" " options"
+.BR \-p ", " \-\-name
+.I name
+.BR \-O ", " \-\-bldopt
+.I options
[
-.BI "\-e\fP, \fB\-\-entrypoint" " name"
+.BR \-e ", " \-\-entrypoint
+.I name
]
[
-.BI "\-r\fP, \fB\-\-revision" " version"
+.BR \-r ", " \-\-revision
+.I version
]
[
-.BI "\-F\fP, \fB\-\-rebuild"
+.BR \-F ", " \-\-rebuild
]
[
-.BI "\-I\fP, \fB\-\-install"
+.BR \-I ", " \-\-install
]
[
-.BI "\-s\fP, \fB\-\-sourcedir" " source"
+.BR \-s ", " \-\-sourcedir
+.I source
]
[
-.BI "\-d\fP, \fB\-\-destdir" " destination"
+.BR \-d ", " \-\-destdir
+.I destination
]
[
-.BI "\-T\fP, \fB\-\-tempdir" " directory"
+.BR \-T ", " \-\-tempdir
+.I directory
]
[
.IR file " .\|.\|."
]
.SH DESCRIPTION
.B pkgdata
-takes a set of data files and packages them for use by ICU or
-applications that use ICU. The typical reason to package files using
+takes a set of data files
+and packages them for use by ICU
+or applications that use ICU.
+The typical reason to package files using
.B pkgdata
-is to make their distribution easier and their loading by ICU faster
-and less consuming of limited system resources such as file
-descriptors.
+is to make their distribution easier
+and their loading by ICU faster
+and less consuming of limited system resources
+such as file descriptors.
Packaged data also allow applications to be distributed with fewer
-resource files, or even with none at all if they link against the
-packaged data directly.
+resource files,
+or even with none at all
+if they link against the packaged data directly.
.PP
.B pkgdata
-supports a few different methods of packaging data that serve
-different purposes.
+supports a few different methods of packaging data
+that serve different purposes.
.PP
The default packaging
.I mode
@@ -77,38 +90,47 @@ is
.BR common ,
or
.BR archive .
-In this mode, the different data files are bundled together as an
-architecture-dependent file that can later be memory mapped for use by
-ICU. Data packaged using this mode will be looked up under the ICU
-data directory. Such packaging is easy to use for applications resource
-bundles, for example, as long as the application can install the
-packaged file in the ICU data directory.
+In this mode,
+the different data files are bundled together
+as an architecture-dependent file
+that can later be memory mapped for use by ICU.
+Data packaged using this mode
+will be looked up under the ICU data directory.
+Such packaging is easy to use for applications resource bundles,
+for example,
+as long as the application can install the packaged file in the ICU data
+directory.
.PP
Another packaging mode is the
.BR dll ,
or
.BR library ,
-mode, where the data files are compiled into a shared library. ICU
-used to be able to dynamically load these shared libraries, but as of
-ICU 2.0, such support has been removed. This mode is still useful for
-two main purposes: to build ICU itself, as the ICU data is packaged as
-a shared library by default; and to build resource bundles that are
-linked to the application that uses them. Such resource bundles can
-then be placed anywhere where the system's dynamic linker will be
-looking for shared libraries, instead of being forced to live inside
-the ICU data directory.
+mode,
+where the data files are compiled into a shared library.
+ICU used to be able to dynamically load these shared libraries,
+but as of ICU 2.0,
+such support has been removed.
+This mode is still useful for two main purposes:
+to build ICU itself,
+as the ICU data is packaged as a shared library by default;
+and to build resource bundles
+that are linked to the application
+that uses them.
+Such resource bundles can then be placed anywhere
+where the system's dynamic linker will be looking for shared libraries,
+instead of being forced to live inside the ICU data directory.
.PP
The
-.BR static
+.B static
packaging mode is similar to the shared library one except that it
produces a static library.
.\" Note that many platforms are not able to
.\" dynamically load symbols from static object files, so for this reason
-.\" .BR udata_setAppData()
+.\" .BR udata_setAppData()
.\" must be called
.\" to install this data. As a convenience, pkgdata will build a C source file
.\" and a header file. Given a data package named
-.\" .IR name, in the output
+.\" .IR name, in the output
.\" directory will be created
.\" .IR name .c
.\" and
@@ -124,130 +146,140 @@ produces a static library.
.\" is that of
.\" .BR udata_setAppData() .
.\" .PP
-.\" Data pakackaged in a library, whether shared or static,
+.\" Data pakackaged in a library, whether shared or static,
.\" Subsequently, the application can access this data by passing
.\" .I name for the
-.\" .I path
+.\" .I path
.\" rgument to functions such as
.\" .BR Bures_open() .
.PP
Finally,
.B pkgdata
supports a
-.B files
-mode which simply copies the data files instead of packaging
-them as a single file or library. This mode is mainly intended to
-provide support for building ICU before it is packaged as separate
-small packages for distribution with operating systems such as Debian
-GNU/Linux for example. Please refer to the packaging documentation in
-the ICU source distribution for further information on the use of this
-mode.
+.B file
+mode
+which simply copies the data files instead of packaging
+them as a single file or library.
+This mode is mainly intended to provide support for building ICU
+before it is packaged as separate small packages for distribution with
+operating systems such as Debian GNU/Linux for example.
+Please refer to the packaging documentation in the ICU source distribution
+for further information on the use of this mode.
.PP
.B pkgdata
-builds, packages, installs, or cleans the appropriate data based on the
options given
+builds, packages, installs,
+or cleans the appropriate data based on the options given
without the need to call GNU
-.BR make
+.B make
anymore.
.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"
+.BR \-v ", " \-\-verbose
Display extra informative messages during execution.
.TP
-.BR "\-c\fP, \fB\-\-copyright"
+.BR \-c ", " \-\-copyright
Include a copyright notice in the binary data.
.TP
-.BI "\-C\fP, \fB\-\-comment" " comment"
+.BR \-C ", " \-\-comment " \fIcomment\fR"
Includes the specified
.I comment
-in the resulting data instead of the ICU copyright notice.
+in the resulting data instead of the ICU copyright notice.
.TP
-.BI "\-m\fP, \fB\-\-mode" " mode"
+.BR \-m ", " \-\-mode " \fImode\fR"
Set the packaging
.I mode
-to be used by
+to be used by
.BR pkgdata .
The different modes and their meaning are explained in the
.B DESCRIPTION
-section above. The valid mode names are
-.BR common
+section above.
+The valid mode names are
+.B common
(or
.BR archive ),
-.BR dll
+.B dll
(or
.BR library ),
and
.BR files .
.TP
-.BI "\-O\fP, \fB\-\-bldopt" " options"
-Specify options for the builder. The builder is used internally by
+.BR \-O ", " \-\-bldopt " \fIoptions\fR"
+Specify options for the builder.
+The builder is used internally by
.B pkgdata
-to generate the correct packaged file. Such options include, but are
-not limited to, setting variables used by
+to generate the correct packaged file.
+Such options include,
+but are not limited to,
+setting variables used by
.BR make (1)
-during the build of the packaged file. Note: If
-.BR icu-config
+during the build of the packaged file.
+Note: If
+.B icu-config
is available, then this option is not needed.
.TP
-.BI "\-p\fP, \fB\-\-name" " name"
+.BR \-p ", " \-\-name " \fIname\fR"
Set the packaged file name to
.IR name .
This name is also used as the default entry point name after having
been turned into a valid C identifier.
.TP
-.BI "\-e\fP, \fB\-\-entrypoint" " name"
+.BR \-e ", " \-\-entrypoint " \fIname\fR"
Set the data entry point (used for linking against the data in a
shared library form) to
.IR name .
The default entry point name is the name set by the
-.BI "\-n\fP, \fB\-\-name"
+.BR \-n ", " \-\-name
option.
.TP
-.BI "\-r\fP, \fB\-\-revision" " version"
+.BR \-r ", " \-\-revision " \fIversion\fR"
Enable versioning of the shared library produced in
.BR dll ,
or
.BR library ,
-mode. The version number has the format
-.I major\fP.\fIminor\fP.\fIpatchlevel
+mode.
+The version number has the format
+.IB major . minor . patchlevel
and all parts except for
.I major
-are optional. If only
+are optional.
+If only
.I major
is supplied then the version is
assumed to be
-.IR major .0
+.IB major .0
for versioning purposes.
.TP
-.BI "\-F\fP, \fB\-\-rebuild"
+.BR \-F ", " \-\-rebuild
Force the rebuilding of all data and their repackaging.
.TP
-.BI "\-I\fP, \fB\-\-install"
+.BR \-I ", " \-\-install
Install the packaged file (or all the files in the
.B files
-mode). If the variable
+mode).
+If the variable
.B DESTDIR
is set it will be used for installation.
.TP
-.BI "\-s\fP, \fB\-\-sourcedir" " source"
+.BR \-s ", " \-\-sourcedir " \fIsource\fR"
Set the source directory to
.IR source .
The default source directory is the current directory.
.TP
-.BI "\-d\fP, \fB\-\-destdir" " destination"
+.BR \-d ", " \-\-destdir " \fIdestination\fR"
Set the destination directory to
.IR destination .
The default destination directory is the current directory.
.TP
-.BI "\-T\fP, \fB\-\-tempdir" " directory"
+.BR \-T ", " \-\-tempdir " \fIdirectory\fR"
Set the directory used to generate temporary files to
.IR directory .
The default temporary directory is the same as the destination
directory
as set by the
-.BI "\-d\fP, \fB\-\-destdir"
+.BR \-d ", " \-\-destdir
option.
.SH AUTHORS
Steven Loomis
@@ -256,5 +288,5 @@ Yves Arrouye
.SH VERSION
72.1
.SH COPYRIGHT
-Copyright (C) 2000-2009 IBM, Inc. and others.
+Copyright (C) 2000\(en2009 IBM, Inc.\& and others.
