[Pkg-openssl-devel] Bug#1103440: ossl-guide-quic-client-block.7ssl: Some remarks and a patch with editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Thu Apr 17 18:04:17 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>:93: warning [page 1, line 33]: cannot break line; overset by 6n
troff:<stdin>:254: warning [page 3, line 54]: cannot break line; overset by 33n
* 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-block.7ssl
Output from "mandoc -T lint ossl-guide-quic-client-block.7ssl": (shortened list)
20 input text line longer than 80 bytes
-.-.
Output from
test-nroff -mandoc -t -ww -z ossl-guide-quic-client-block.7ssl: (shortened list)
1 cannot break line; overset by 33n
1 cannot break line; overset by 6n
-.-.
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-block.7ssl:456: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.
93 <https://github.com/openssl/openssl/blob/master/demos/guide/quic\-client\-block.c>.
254 <https://www.iana.org/assignments/tls\-extensiontype\-values/tls\-extensiontype\-values.xml#alpn\-protocol\-ids>).
-.-.
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.
104:"method". OpenSSL offers two different QUIC client methods, i.e.
214:variables are strings, e.g. "www.example.com" and "443".
-.-.
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 262 with 139 characters
\& unsigned char alpn[] = { 8, \*(Aqh\*(Aq, \*(Aqt\*(Aq, \*(Aqt\*(Aq, \*(Aqp\*(Aq, \*(Aq/\*(Aq, \*(Aq1\*(Aq, \*(Aq.\*(Aq, \*(Aq0\*(Aq };
-.-.
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.]
-.-.
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-block.7ssl:455:.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 BLOCKING QUIC CLIENT EXAMPLE"
94:.SS "Creating the SSL_CTX and SSL objects"
136:.SS "Creating the socket and BIO"
243:.SS "Setting the server's hostname"
248:.SS "Setting the ALPN"
275:.SS "Setting the peer address"
296:.SS "The handshake and application data transfer"
398:.SS "Shutting down the connection"
445:.SH "FURTHER READING"
449:.SH "SEE ALSO"
-.-.
.\" Define a fallback for font CW with
.if \n(.g \{\
. ie t .ftr CW CR
. el .ftr CW R
.\}
91:the \f(CW\*(C`demos/guide\*(C'\fR directory of the OpenSSL source distribution in the file
92:\&\f(CW\*(C`quic\-client\-block.c\*(C'\fR. It is also available online at
-.-.
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.
93:<https://github.com/openssl/openssl/blob/master/demos/guide/quic\-client\-block.c>.
254:<https://www.iana.org/assignments/tls\-extensiontype\-values/tls\-extensiontype\-values.xml#alpn\-protocol\-ids>).
461:<https://www.openssl.org/source/license.html>.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
troff:<stdin>:254: warning: [page 3, 8.5i]: cannot break line; overset by 0.431875i
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
troff:<stdin>:93: warning [page 1, line 33]: cannot break line; overset by 6n
troff:<stdin>:254: warning [page 3, line 54]: cannot break line; overset by 33n
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-------------- next part --------------
--- ossl-guide-quic-client-block.7ssl 2025-04-17 02:34:45.396710371 +0000
+++ ossl-guide-quic-client-block.7ssl.new 2025-04-17 03:33:52.482475502 +0000
@@ -90,7 +90,15 @@ tutorial will discuss how to write a mul
The complete source code for this example blocking QUIC client is available in
the \f(CW\*(C`demos/guide\*(C'\fR directory of the OpenSSL source distribution in the file
\&\f(CW\*(C`quic\-client\-block.c\*(C'\fR. It is also available online at
-<https://github.com/openssl/openssl/blob/master/demos/guide/quic\-client\-block.c>.
+.ie \n(.g \{\
+.br
+<https://github.com/openssl/openssl/\:blob/\:master/\:demos/\:guide/\:quic\-client\-block.c>.
+.\}
+.el \{\
+.br
+<https://github.com/openssl/openssl/blob/master/demos/guide/
+quic\-client\-block.c>.
+.\}
.SS "Creating the SSL_CTX and SSL objects"
.IX Subsection "Creating the SSL_CTX and SSL objects"
In the TLS tutorial (\fBossl\-guide\-tls\-client\-block\fR\|(7)) we created an \fBSSL_CTX\fR
@@ -251,7 +259,16 @@ ALPN (Application-Layer Protocol Negotia
the application to negotiate which protocol will be used over the connection.
For example, if you intend to use HTTP/3 over the connection then the ALPN value
for that is "h3" (see
-<https://www.iana.org/assignments/tls\-extensiontype\-values/tls\-extensiontype\-values.xml#alpn\-protocol\-ids>).
+.ie \n(.g \{\
+.br
+<https://www.iana.org/assignments/\:tls\-extensiontype\-values/\:tls\-extensiontype\-values.xml#alpn\-protocol\-ids>).
+.\}
+.el \{\
+.br
+<https://www.iana.org/assignments/tls\-extensiontype\-values/
+tls\-extensiontype\-values.xml#alpn\-protocol\-ids>).
+.\}
+.br
OpenSSL provides the ability for a client to specify the ALPN to use via the
\&\fBSSL_set_alpn_protos\fR\|(3) function. This is optional for a TLS client and so our
simple client that we developed in \fBossl\-guide\-tls\-client\-block\fR\|(7) did not use
-------------- 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