QUIC Front End I/O API: Minor doc fixes

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/19703)

diff --git a/doc/man3/BIO_get_rpoll_descriptor.pod b/doc/man3/BIO_get_rpoll_descriptor.pod
index 652837d924a5cb06ad1f2b1fc7545ec17a35ece7..0aa1fd9369a7020cc478d3d18324b19d46be1e03 100644 (file)
--- a/doc/man3/BIO_get_rpoll_descriptor.pod
+++ b/doc/man3/BIO_get_rpoll_descriptor.pod
@@ -26,7 +26,7 @@ can be used to determine when a BIO object can next be read or written
 =head1 DESCRIPTION
 
 BIO_get_rpoll_descriptor() and BIO_get_wpoll_descriptor(), on success, fill
-B<*desc> with a poll descriptor. A poll descriptor is a tagged union structure
+I<*desc> with a poll descriptor. A poll descriptor is a tagged union structure
 which represents some kind of OS or non-OS resource which can be used to
 synchronise on I/O availability events.
 
@@ -52,12 +52,12 @@ Represents the absence of a valid poll descriptor. It may be used by
 BIO_get_rpoll_descriptor() or BIO_get_wpoll_descriptor() to indicate that the
 BIO is not pollable for readability or writeability respectively.
 
-For this type, no field within the B<value> field of the B<BIO_POLL_DESCRIPTOR>
+For this type, no field within the I<value> field of the B<BIO_POLL_DESCRIPTOR>
 is valid.
 
 =item BIO_POLL_DESCRIPTOR_TYPE_SOCK_FD
 
-The poll descriptor represents an OS socket resource. The field B<value.fd>
+The poll descriptor represents an OS socket resource. The field I<value.fd>
 in the B<BIO_POLL_DESCRIPTOR> is valid if it is not set to -1.
 
 The resource is whatever kind of handle is used by a given OS to represent
@@ -74,7 +74,7 @@ complete a BIO_write() operation.
 =item BIO_POLL_DESCRIPTOR_CUSTOM_START
 
 Type values beginning with this value (inclusive) are reserved for application
-allocation for custom poll descriptor types. The field B<value.custom> in the
+allocation for custom poll descriptor types. The field I<value.custom> in the
 B<BIO_POLL_DESCRIPTOR> is an array of length B<BIO_POLL_DESCRIPTOR_NUM_CUSTOM>.
 Each entry in this array can store a void pointer or a B<uint64_t> and can be
 used by the application arbitrarily.
@@ -90,7 +90,7 @@ including by applications, according to their needs.
 The functions BIO_get_rpoll_descriptor() and BIO_get_wpoll_descriptor() return 1
 on success and 0 on failure.
 
-These functions are permitted to succeed and initialise B<*desc> with a poll
+These functions are permitted to succeed and initialise I<*desc> with a poll
 descriptor of type B<BIO_POLL_DESCRIPTOR_TYPE_NONE> to indicate that the BIO is
 not pollable for readability or writeability respectively.
 
@@ -106,7 +106,7 @@ added in OpenSSL 3.2.
 
 =head1 COPYRIGHT
 
-Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
 
 Licensed under the Apache License 2.0 (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy

diff --git a/doc/man3/SSL_get_rpoll_descriptor.pod b/doc/man3/SSL_get_rpoll_descriptor.pod
index a23fbfe86e0ecd12a9edf465f7c03b55b5d90221..3f0b1f16c4cf9a3a5761f6da010515f6c4f8a7e5 100644 (file)
--- a/doc/man3/SSL_get_rpoll_descriptor.pod
+++ b/doc/man3/SSL_get_rpoll_descriptor.pod
@@ -83,7 +83,7 @@ and SSL_want_net_write() functions were added in OpenSSL 3.2.
 
 =head1 COPYRIGHT
 
-Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
 
 Licensed under the Apache License 2.0 (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy

diff --git a/doc/man3/SSL_get_tick_timeout.pod b/doc/man3/SSL_get_tick_timeout.pod
index 9c46c0c6c06202e732f9000e296282b915cd9c43..5cab7a54744abce93953c468064cd8e4ae74f216 100644 (file)
--- a/doc/man3/SSL_get_tick_timeout.pod
+++ b/doc/man3/SSL_get_tick_timeout.pod
@@ -15,10 +15,10 @@ SSL_get_tick_timeout - determine when an SSL object next needs to be ticked
 SSL_get_tick_timeout() determines when the SSL object next needs to perform
 internal processing due to the passage of time.
 
-Calling SSL_get_tick_timeout() results in B<*tv> being written with an amount of
+Calling SSL_get_tick_timeout() results in I<*tv> being written with an amount of
 time left before the SSL object needs to be ticked. If the SSL object needs to
 be ticked immediately, it is set to zero; if the SSL object currently does not
-need to be ticked at any point in the future, B<tv_sec> is set to -1,
+need to be ticked at any point in the future, I<tv->tv_sec> is set to -1,
 representing infinity.
 
 This function is currently applicable only to DTLS and QUIC connection SSL
@@ -45,7 +45,7 @@ The SSL_get_tick_timeout() function was added in OpenSSL 3.2.
 
 =head1 COPYRIGHT
 
-Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
 
 Licensed under the Apache License 2.0 (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy

diff --git a/doc/man3/SSL_set_blocking_mode.pod b/doc/man3/SSL_set_blocking_mode.pod
index 328e2709bf6e290eb3b9cc630e016e0e6bc30f9c..7a14613e6a15c55a59327ca17fa9a78e9d01ace2 100644 (file)
--- a/doc/man3/SSL_set_blocking_mode.pod
+++ b/doc/man3/SSL_set_blocking_mode.pod
@@ -20,8 +20,8 @@ configured to use an underlying read or write BIO which cannot provide a poll
 descriptor (see L<BIO_get_rpoll_descriptor(3)>), as blocking mode cannot be
 supported in this case.
 
-To enable blocking mode, call SSL_set_blocking_mode() with B<blocking> set to 1;
-to disable it, call SSL_set_blocking_mode() with B<blocking> set to 0.
+To enable blocking mode, call SSL_set_blocking_mode() with I<blocking> set to 1;
+to disable it, call SSL_set_blocking_mode() with I<blocking> set to 0.
 
 To retrieve the current blocking mode, call SSL_get_blocking_mode().
 
@@ -59,7 +59,7 @@ OpenSSL 3.2.
 
 =head1 COPYRIGHT
 
-Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
 
 Licensed under the Apache License 2.0 (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy

diff --git a/doc/man3/SSL_set_initial_peer_addr.pod b/doc/man3/SSL_set_initial_peer_addr.pod
index 0e30e573f449be21ff08975c34683c79df75c0c3..6ebe7bead46d025f1ddfc400a2a0521b668f8ba6 100644 (file)
--- a/doc/man3/SSL_set_initial_peer_addr.pod
+++ b/doc/man3/SSL_set_initial_peer_addr.pod
@@ -15,7 +15,7 @@ SSL_set_initial_peer_addr - set the initial peer address for a QUIC connection
 SSL_set_initial_peer_addr() sets the initial destination peer address to be used
 for the purposes of establishing a QUIC connection in client mode. This function
 can be used only on a QUIC connection SSL object, and can be used only before a
-connection attempt is first made. B<addr> must point to a B<BIO_ADDR>
+connection attempt is first made. I<addr> must point to a B<BIO_ADDR>
 representing a UDP destination address of the server to connect to.
 
 Where a QUIC connection object is provided with a write BIO which supports the
@@ -47,7 +47,7 @@ The SSL_set_initial_peer_addr() function was added in OpenSSL 3.2.
 
 =head1 COPYRIGHT
 
-Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
 
 Licensed under the Apache License 2.0 (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy

diff --git a/doc/man3/SSL_tick.pod b/doc/man3/SSL_tick.pod
index f1350bff4728f82e5a9d67635d1b46898d0c7df7..a0a43ecb66ef44231f0df6987de3432777094835 100644 (file)
--- a/doc/man3/SSL_tick.pod
+++ b/doc/man3/SSL_tick.pod
@@ -88,7 +88,7 @@ The SSL_tick() function was added in OpenSSL 3.2.
 
 =head1 COPYRIGHT
 
-Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
 
 Licensed under the Apache License 2.0 (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy