Package: libtirpc-dev
Version: 1.3.4+ds-1.3+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 ' $' -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?
troff:<stdin>:61: warning: name 'doc-list-type-stack0' not defined
doc.tmac:<stdin>:61: error: .It without preceding .Bl
troff:<stdin>:61: warning: register 'doc--type' not defined
troff:<stdin>:61: warning: name 'doc-' not defined (possibly missing space
after 'do')
* 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.11-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 libtirpc-dev depends on:
ii libtirpc3t64 1.3.4+ds-1.3+b1
libtirpc-dev recommends no packages.
libtirpc-dev suggests no packages.
-- no debconf information
Input file is rpc_gss_qop_to_num.3t
Output from "mandoc -T lint rpc_gss_qop_to_num.3t": (shortened list)
1 skipping item outside list: It number_ret
1 unusual Xr order: gssapi after rpc
-.-.
Output from "test-groff -mandoc -t -ww -z rpc_gss_qop_to_num.3t": (shortened
list)
1 .It without preceding .Bl
1 name 'doc-' not defined (possibly missing space after 'do')
1 name 'doc-list-type-stack0' not defined
1 register 'doc--type' not defined
-.-.
Move a full stop (period) and a comma outside of a quoted text, if it is
at the end of the quote and does not end a quoted sentence.
39:GSS_API QOP "qop" and mechanism "mech."
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:61: warning: name 'doc-list-type-stack0' not defined
doc.tmac:<stdin>:61: error: .It without preceding .Bl
troff:<stdin>:61: warning: register 'doc--type' not defined
troff:<stdin>:61: warning: name 'doc-' not defined (possibly missing space
after 'do')
--- rpc_gss_qop_to_num.3t 2025-02-03 21:35:29.669126448 +0000
+++ rpc_gss_qop_to_num.3t.new 2025-02-03 22:00:49.435960995 +0000
@@ -36,7 +36,7 @@
.Fn rpc_gss_qop_to_num "const char *qop" "const char *mech" "u_int *num_ret"
.Sh DESCRIPTION
This function returns the numeric QOP value associated with the
-GSS_API QOP "qop" and mechanism "mech."
+GSS_API QOP "qop" and mechanism "mech".
.Sh PARAMETERS
.Bl -tag -width ".It number_ret"
.It qop
@@ -58,15 +58,15 @@ The corresponding QOP number is returned
Otherwise
.Dv FALSE
is returned and
-.It number_ret
+.Fa *num_ret
is left untouched.
.Sh AVAILABILITY
The
.Fn rpc_gss_qop_to_num
function is part of libtirpc.
.Sh SEE ALSO
-.Xr rpc 3 ,
.Xr gssapi 3 ,
+.Xr rpc 3 ,
.Xr rpcsec_gss 3
.Sh AUTHORS
This
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.
Not beginning each input sentence on a new line.
Line length 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 -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 -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)
-.-
