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>:83: warning [page 1, line 25]: cannot break line; overset by 6n
* 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
Input file is ossl-guide-quic-server-block.7ssl
Output from "mandoc -T lint ossl-guide-quic-server-block.7ssl": (shortened
list)
2 input text line longer than 80 bytes
-.-.
Output from
test-nroff -mandoc -t -ww -z ossl-guide-quic-server-block.7ssl: (shortened list)
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-server-block.7ssl:350:Copyright 2024\-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.
83
<https://github.com/openssl/openssl/blob/master/demos/guide/quic\-server\-block.c>.
-.-.
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 200 with 144 characters
\& 10, \*(Aqh\*(Aq, \*(Aqq\*(Aq, \*(Aq\-\*(Aq, \*(Aqi\*(Aq, \*(Aqn\*(Aq,
\*(Aqt\*(Aq, \*(Aqe\*(Aq, \*(Aqr\*(Aq, \*(Aqo\*(Aq, \*(Aqp\*(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).
ossl-guide-quic-server-block.7ssl:89:libcrypto and libssl libraries that are
provided by OpenSSL. It also assumes
ossl-guide-quic-server-block.7ssl:93:The first step is to create an
\fBSSL_CTX\fR object for our server. We use the
ossl-guide-quic-server-block.7ssl:101:\& * subsequent per\-client SSL
connections. We specifically load a QUIC
ossl-guide-quic-server-block.7ssl:187:\& /* Setup ALPN negotiation callback
to decide which ALPN is accepted. */
ossl-guide-quic-server-block.7ssl:195:\& * ALPN strings for TLS handshake.
Only \*(Aqhttp/1.0\*(Aq and \*(Aqhq\-interop\*(Aq
ossl-guide-quic-server-block.7ssl:242:\& * Create a new QUIC listener.
Listeners, and other QUIC objects, default
ossl-guide-quic-server-block.7ssl:243:\& * to operating in blocking mode.
The configured behaviour is inherited by
ossl-guide-quic-server-block.7ssl:250:\& /* Provide the listener with our
UDP socket. */
ossl-guide-quic-server-block.7ssl:254:\& /* Begin listening. */
ossl-guide-quic-server-block.7ssl:301:\& /* Signal the end of the stream. */
ossl-guide-quic-server-block.7ssl:350:Copyright 2024\-2025 The OpenSSL Project
Authors. All Rights Reserved.
-.-.
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-server-block.7ssl:349:.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 SERVER EXAMPLE"
91:.SS "Creating the SSL_CTX and SSL objects"
258:.SS "Server loop"
325:.SS "Final clean up"
342:.SH "SEE ALSO"
-.-.
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.
83:<https://github.com/openssl/openssl/blob/master/demos/guide/quic\-server\-block.c>.
191:In this case, we only accept "http/1.0" and "hq-interop".
195:\& * ALPN strings for TLS handshake. Only \*(Aqhttp/1.0\*(Aq and
\*(Aqhq\-interop\*(Aq
355:<https://www.openssl.org/source/license.html>.
-.-.
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:83: warning [page 1, line 25]: cannot break line; overset by 6n
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- ossl-guide-quic-server-block.7ssl 2025-04-17 23:53:07.920083509 +0000
+++ ossl-guide-quic-server-block.7ssl.new 2025-04-18 00:01:12.861387580
+0000
@@ -80,7 +80,14 @@ events.
The complete source code for this example blocking QUIC server is available in
the \fBdemos/guide\fR directory of the OpenSSL source distribution in the file
\&\fBquic\-server\-block.c\fR. It is also available online at
-<https://github.com/openssl/openssl/blob/master/demos/guide/quic\-server\-block.c>.
+.br
+.ie \n(.g \{\
+<https://github.com/openssl/openssl/blob/\:master/\:demos/\:guide/\:quic\-server\-block.c>.
+.\}
+.el \{\
+<https://github.com/openssl/openssl/blob/master/demos/guide/
+quic\-server\-block.c>.
+.\}
.PP
We assume that you already have OpenSSL installed on your system; that you
already have some fundamental understanding of OpenSSL concepts and QUIC (see
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)
-.-
