[Pkg-openssl-devel] Bug#1103456: ossl-guide-quic-client-non-block.7ssl: Some remarks and a patch with editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Thu Apr 17 20:14:11 BST 2025
Package: openssl
Version: 3.5.0-1
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
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' <file>
to find (most) 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>:76: warning [page 1, line 16]: cannot break line; overset by 10n
* 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.21-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 openssl depends on:
ii libc6 2.41-6
ii libssl3t64 3.5.0-1
openssl recommends no packages.
Versions of packages openssl suggests:
ii ca-certificates 20241223
-- no debconf information
-------------- next part --------------
Input file is ossl-guide-quic-client-non-block.7ssl
Output from "mandoc -T lint ossl-guide-quic-client-non-block.7ssl": (shortened list)
36 input text line longer than 80 bytes
-.-.
Output from
test-nroff -mandoc -t -ww -z ossl-guide-quic-client-non-block.7ssl: (shortened list)
1 cannot break line; overset by 10n
-.-.
Show if Pod::Man generated this.
Who is actually creating this man page? Debian or upstream?
Is the generating software out of date?
2:.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
-.-.
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.
ossl-guide-quic-client-non-block.7ssl:523:Copyright 2023\-2025 The OpenSSL Project Authors. All Rights Reserved.
-.-.
Strings longer than 3/4 of a standard line length (80).
Use "\:" to split the string at the end of an output line, for example a
long URL (web address).
This is a groff extension.
76 <https://github.com/openssl/openssl/blob/master/demos/guide/quic\-client\-non\-block.c>.
-.-.
Add a "\&" (or a comma (Oxford comma)) after an abbreviation
or use English words
(man-pages(7)).
Abbreviation points should be marked as such and protected against being
interpreted as an end of sentence, if they are not, and that independent
of the current place on the line.
103:In fact this is the whole point of using a nonblocking \fBSSL\fR object, i.e. to
161:\& * real application you probably want to go and do other work here (e.g.
393:that the parameters must be \fIexactly\fR the same, i.e. the same pointer to the
-.-.
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"
[List of affected lines removed.]
-.-.
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.
Add "\:" to split the string for the output, "\<newline>" in the source.
[List of affected lines removed.]
Longest line is number 213 with 93 characters
function to do the same thing. \f(CW\*(C`select\*(C'\fR waits for the state of the underlying
-.-.
Add a zero (0) in front of a decimal fraction that begins with a period
(.)
7:.if t .sp .5v
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
[List of affected lines removed.]
-.-.
Use a no-break space between a number and a (SI) unit
165:\& * a GUI every 100ms. One way to do that would be to use the timeout in
167:\& * than 100ms then use 100ms instead. Then, when select returns, you
169:\& * because of the timeout. If the 100ms GUI timeout has expired but the
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
[List of affected lines removed.]
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
ossl-guide-quic-client-non-block.7ssl:522:.IX Header "COPYRIGHT"
-.-.
Use ".na" (no adjustment) instead of ".ad l" (and ".ad" to begin the
same adjustment again as before).
61:.if n .ad l
-.-.
Add lines to use the CR font for groff instead of CW.
.if t \{\
. ie \\n(.g .ft CR
. el .ft CW
.\}
11:.ft CW
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
66:.SH "SIMPLE NONBLOCKING QUIC CLIENT EXAMPLE"
99:.SS "Performing work while waiting for the socket"
216:.SS "Handling errors from OpenSSL I/O functions"
320:.SS "Creating the SSL_CTX and SSL objects"
364:.SS "Performing the handshake"
387:.SS "Sending and receiving data"
477:.SS "Shutting down the connection"
506:.SS "Final clean up"
511:.SH "FURTHER READING"
516:.SH "SEE ALSO"
-.-.
.\" Define a fallback for font CW with
.if \n(.g \{\
. ie t .ftr CW CR
. el .ftr CW R
.\}
121:function \f(CWwait_for_activity()\fR.
210:In this example we are using the \f(CW\*(C`select\*(C'\fR function to check the
213:function to do the same thing. \f(CW\*(C`select\*(C'\fR waits for the state of the underlying
317:might succeed (by using the \f(CWwait_for_activity()\fR function that we developed
384:Otherwise we use the \f(CWhandle_io_failure()\fR function that we created earlier to
-.-.
Put a (long) web address on a new output line to reduce the posibility of
splitting the address between two output lines.
Or inhibit hyphenation with "\%" in front of the name.
76:<https://github.com/openssl/openssl/blob/master/demos/guide/quic\-client\-non\-block.c>.
528:<https://www.openssl.org/source/license.html>.
-.-.
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
troff:<stdin>:76: warning [page 1, line 16]: cannot break line; overset by 10n
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-------------- next part --------------
--- ossl-guide-quic-client-non-block.7ssl 2025-04-17 18:45:59.803694796 +0000
+++ ossl-guide-quic-client-non-block.7ssl.new 2025-04-17 19:05:30.664116012 +0000
@@ -73,7 +73,14 @@ supports nonblocking functionality.
The complete source code for this example nonblocking QUIC client is available
in the \fBdemos/guide\fR directory of the OpenSSL source distribution in the file
\&\fBquic\-client\-non\-block.c\fR. It is also available online at
-<https://github.com/openssl/openssl/blob/master/demos/guide/quic\-client\-non\-block.c>.
+.br
+.ie \n(.g \{\
+<https://github.com/openssl/openssl/\:blob/\:master/\:demos/\:guide/\:quic\-client\-non\-block.c>.
+.\}
+.el \{\
+<https://github.com/openssl/openssl/blob/master/demos/guide/
+quic\-client\-non\-block.c>.
+.\}
.PP
As we saw in the previous example an OpenSSL QUIC application always uses a
nonblocking socket. However, despite this, the \fBSSL\fR object still has blocking
-------------- next part --------------
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>
To find trailing space use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <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)
-.-
More information about the Pkg-openssl-devel
mailing list