Package: uuid-dev Version: 2.40.2-7 Severity: minor * What led up to the situation?
Checking for defects with
[test-]groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page"
[test-groff is a script in the repository for "groff"] (local copy and
"troff" slightly changed by me).
* What was the outcome of this action?
troff: backtrace: file '<stdin>':10
troff:<stdin>:10: warning: macro 'Aq' not defined
troff: backtrace: file '<stdin>':65
troff:<stdin>:65: warning: macro '.' not defined
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks are in the attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.10.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 uuid-dev depends on:
ii libc6-dev [libc-dev] 2.40-2
ii libuuid1 2.40.2-7
uuid-dev recommends no packages.
uuid-dev suggests no packages.
-- no debconf information
Any program (person), that produces man pages, should check its content for
defects by using
groff -mandoc -t -ww -b -z [ -K utf8 | k ] <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 lines 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 outputs 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 uuid.3": (possibly shortened list)
mandoc: uuid.3:10:61: WARNING: undefined string, using "": Aq
mandoc: uuid.3:33:2: WARNING: skipping paragraph macro: sp after SH
mandoc: uuid.3:36:2: WARNING: skipping paragraph macro: sp after SH
mandoc: uuid.3:37:278: STYLE: input text line longer than 80 bytes: The UUID
library is ...
mandoc: uuid.3:39:294: STYLE: input text line longer than 80 bytes: The UUIDs
generated ...
mandoc: uuid.3:41:2: WARNING: skipping paragraph macro: sp after SH
mandoc: uuid.3:42:107: STYLE: input text line longer than 80 bytes: This
library generat...
mandoc: uuid.3:45:2: WARNING: skipping paragraph macro: sp after SH
mandoc: uuid.3:48:2: WARNING: skipping paragraph macro: sp after SH
mandoc: uuid.3:58:2: WARNING: skipping paragraph macro: sp after SH
mandoc: uuid.3:62:2: WARNING: skipping paragraph macro: sp after SH
mandoc: uuid.3:63:111: STYLE: input text line longer than 80 bytes: The
\fBlibuuid\fP li...
-.-.
Lines containing '\c'. This is unnecessary to join a normal text line with a
line beginning with a macro.
42:This library generates UUIDs compatible with OSF DCE 1.1, and hash based
UUIDs V3 and V5 compatible with \c
59:For bug reports, use the issue tracker at \c
63:The \fBlibuuid\fP library is part of the util\-linux package since version
2.15.1. It can be downloaded from \c
-.-
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.
37:The UUID library is used to generate unique identifiers for objects that may
be accessible beyond the local system. This library generates UUIDs compatible
with those created by the Open Software Foundation (OSF) Distributed Computing
Environment (DCE) utility \fBuuidgen\fP(1).
39:The UUIDs generated by this library can be reasonably expected to be unique
within a system, and unique across all systems. They could be used, for
instance, to generate unique HTTP cookies across multiple web servers without
communication between the servers, and without fear of a name clash.
63:The \fBlibuuid\fP library is part of the util\-linux package since version
2.15.1. It can be downloaded from \c
-.-.
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 37, length 278
The UUID library is used to generate unique identifiers for objects that may be
accessible beyond the local system. This library generates UUIDs compatible
with those created by the Open Software Foundation (OSF) Distributed Computing
Environment (DCE) utility \fBuuidgen\fP(1).
Line 39, length 294
The UUIDs generated by this library can be reasonably expected to be unique
within a system, and unique across all systems. They could be used, for
instance, to generate unique HTTP cookies across multiple web servers without
communication between the servers, and without fear of a name clash.
Line 42, length 107
This library generates UUIDs compatible with OSF DCE 1.1, and hash based UUIDs
V3 and V5 compatible with \c
Line 63, length 111
The \fBlibuuid\fP library is part of the util\-linux package since version
2.15.1. It can be downloaded from \c
Line 64, length 85
.URL "https://www.kernel.org/pub/linux/utils/util\-linux/"; "Linux Kernel
Archive" "."
-.-.
Output from "test-groff -b -mandoc -rF0 -rHY=0 -K utf8 -t -ww -z ":
troff: backtrace: file '<stdin>':10
troff:<stdin>:10: warning: macro 'Aq' not defined
troff: backtrace: file '<stdin>':65
troff:<stdin>:65: warning: macro '.' not defined
Strings and macros must be defined before they are used.
uuid.3.diff
Description: inode/empty
