[Pkg-openssl-devel] Bug#1103283: openssl-quic.7ssl: Some remarks and a patch with editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Wed Apr 16 03:56:06 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>:306: warning: trailing space in the line
* 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 openssl-quic.7ssl
Output from "mandoc -T lint openssl-quic.7ssl": (shortened list)
4 empty block: RS
57 input text line longer than 80 bytes
2 input text line longer than 80 bytes: Changes needed
1 input text line longer than 80 bytes: option
1 whitespace at end of input line
Find trailing space with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Output from
test-nroff -mandoc -t -ww -z openssl-quic.7ssl: (shortened list)
1 line(s) with a trailing space
Find trailing space with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
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)
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
1
-.-.
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.
openssl-quic.7ssl:772:Copyright 2022\-2025 The OpenSSL Project Authors. All Rights Reserved.
-.-.
Find a repeated word
! 395 --> to
-.-.
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.
424 <https://github.com/openssl/openssl/tree/master/doc/designs/ddd>.
-.-.
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.
414:a network socket (e.g. via \fBBIO_s_datagram\fR\|(3)) or whether it intends to buffer
-.-.
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 642 with 135 characters
.IP "\fBBIO_dgram_get_local_addr_cap\fR\|(3), \fBBIO_dgram_set_local_addr_enable\fR\|(3), \fBBIO_dgram_get_local_addr_enable\fR\|(3)" 4
-.-.
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".
openssl-quic.7ssl:197:Traditionally, whether the application-level I/O APIs (such as \fBSSL_read\fR\|(3)
openssl-quic.7ssl:207:network BIO provided to QUIC (such as a \fBBIO_s_datagram\fR\|(3)) must be configured
openssl-quic.7ssl:408:level (configured using \fBSSL_set_blocking_mode\fR\|(3)).
openssl-quic.7ssl:414:a network socket (e.g. via \fBBIO_s_datagram\fR\|(3)) or whether it intends to buffer
openssl-quic.7ssl:421:Whether thread assisted mode will be used (see \fBTHREAD ASSISTED MODE\fR).
openssl-quic.7ssl:445:\&\fBSSL_handle_events\fR\|(3) (or another I/O function such as \fBSSL_read\fR\|(3) or
openssl-quic.7ssl:518:object hierarchy (if any).
openssl-quic.7ssl:731:The timeout returned by \fBSSL_get_event_timeout\fR\|(3) (if any) expires.
openssl-quic.7ssl:751:\&\fBSSL_handle_events\fR\|(3) (or another I/O function on the SSL object), and ensure
openssl-quic.7ssl:774:Licensed under the Apache License 2.0 (the "License"). You may not use
-.-.
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.
openssl-quic.7ssl:66:.IX Header "DESCRIPTION"
openssl-quic.7ssl:732:.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
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
93:.SH "CLIENT MODES OF OPERATION"
107:.SS "Default Stream Mode"
146:.SS "Multi-Stream Mode"
164:.SH "CHANGES TO EXISTING APIS"
296:.SH "CONSIDERATIONS FOR EXISTING APPLICATIONS"
402:.SH "RECOMMENDED USAGE IN NEW APPLICATIONS"
436:.SH "QUIC-SPECIFIC APIS"
653:.SH "THREAD ASSISTED MODE"
673:.SH "APPLICATION-DRIVEN EVENT LOOPS"
754:.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.
424:<https://github.com/openssl/openssl/tree/master/doc/designs/ddd>.
777:<https://www.openssl.org/source/license.html>.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
troff:<stdin>:306: warning: trailing space in the line
-.-.
Spelling (codespell):
listner ==> listener
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-------------- next part --------------
--- openssl-quic.7ssl 2025-04-16 02:17:42.921604234 +0000
+++ openssl-quic.7ssl.new 2025-04-16 02:26:53.796215772 +0000
@@ -303,7 +303,7 @@ or \fBOSSL_QUIC_client_thread_method\fR\
on the differences between these two methods, see
\&\fBTHREAD ASSISTED MODE\fR.
.IP \(bu 4
-A server application wishing to use QUIC must use \fBOSSL_QUIC_server_method\fR\|(3).
+A server application wishing to use QUIC must use \fBOSSL_QUIC_server_method\fR\|(3).
The server can then accept new connections with \fBSSL_accept_connection\fR\|(3).
.IP \(bu 4
Determine how to provide QUIC with network access. Determine which of the below
@@ -489,7 +489,7 @@ to call this because it will be called a
\&\fBSSL_accept_connection\fR\|(3).
.IP \fBSSL_accept_connection\fR\|(3) 4
.IX Item "SSL_accept_connection"
-Accepts a new incoming connection for a listner SSL object. A new SSL object
+Accepts a new incoming connection for a listener SSL object. A new SSL object
representing the accepted connection is created and returned on success. If no
incoming connection is available and the listener SSL object is configured in
nonblocking mode, NULL is returned.
-------------- 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