]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
QUIC Front End I/O API: Remove __owur from man pages
authorHugo Landau <hlandau@openssl.org>
Fri, 6 Jan 2023 11:50:55 +0000 (11:50 +0000)
committerHugo Landau <hlandau@openssl.org>
Fri, 13 Jan 2023 13:20:35 +0000 (13:20 +0000)
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/19703)

doc/man3/BIO_get_rpoll_descriptor.pod
doc/man3/SSL_get_error.pod
doc/man3/SSL_get_rpoll_descriptor.pod
doc/man3/SSL_get_tick_timeout.pod
doc/man3/SSL_set_blocking_mode.pod
doc/man3/SSL_set_initial_peer_addr.pod

index 0aa1fd9369a7020cc478d3d18324b19d46be1e03..36d6b64ff58ef49297189bba99e34a981683c028 100644 (file)
@@ -20,8 +20,8 @@ can be used to determine when a BIO object can next be read or written
      } value;
  } BIO_POLL_DESCRIPTOR;
 
__owur int BIO_get_rpoll_descriptor(BIO *b, BIO_POLL_DESCRIPTOR *desc);
__owur int BIO_get_wpoll_descriptor(BIO *b, BIO_POLL_DESCRIPTOR *desc);
+ int BIO_get_rpoll_descriptor(BIO *b, BIO_POLL_DESCRIPTOR *desc);
+ int BIO_get_wpoll_descriptor(BIO *b, BIO_POLL_DESCRIPTOR *desc);
 
 =head1 DESCRIPTION
 
index efc4e60de2a7ca8fe72bd041bb92a4cbd41f4e87..a91acd9836721d422e1624c1d062512a099eac43 100644 (file)
@@ -88,9 +88,9 @@ B<SSL_ERROR_WANT_WRITE> have different but largely compatible semantics. Since
 QUIC implements its own flow control and uses UDP datagrams, backpressure
 conditions in terms of the underlying BIO providing network I/O are not directly
 relevant to the circumstances in which these errors are produced. In particular,
-B<SSL_ERROR_WANT_WRITE> indicates that the internal send buffer for a given QUIC
-stream has been filled. Likewise, B<SSL_ERROR_WANT_READ> indicates that the
-internal receive buffer for a given QUIC stream is empty.
+B<SSL_ERROR_WANT_WRITE> indicates that the OpenSSL internal send buffer for a
+given QUIC stream has been filled. Likewise, B<SSL_ERROR_WANT_READ> indicates
+that the OpenSSL internal receive buffer for a given QUIC stream is empty.
 
 It is safe to call SSL_read() or SSL_read_ex() when more data is available
 even when the call that set this error was an SSL_write() or SSL_write_ex().
index 3f0b1f16c4cf9a3a5761f6da010515f6c4f8a7e5..62378576f0c81ecc72de84fd292f03db6a6712b7 100644 (file)
@@ -10,10 +10,10 @@ network I/O can be performed
 
  #include <openssl/ssl.h>
 
__owur int SSL_get_rpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc);
__owur int SSL_get_wpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc);
__owur int SSL_want_net_read(SSL *s);
__owur int SSL_want_net_write(SSL *s);
+ int SSL_get_rpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc);
+ int SSL_get_wpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc);
+ int SSL_want_net_read(SSL *s);
+ int SSL_want_net_write(SSL *s);
 
 =head1 DESCRIPTION
 
index 5cab7a54744abce93953c468064cd8e4ae74f216..e944620bed542954178459b4b6bef368433e0edd 100644 (file)
@@ -8,7 +8,7 @@ SSL_get_tick_timeout - determine when an SSL object next needs to be ticked
 
  #include <openssl/ssl.h>
 
__owur int SSL_get_tick_timeout(SSL *s, struct timeval *tv);
+ int SSL_get_tick_timeout(SSL *s, struct timeval *tv);
 
 =head1 DESCRIPTION
 
index 7a14613e6a15c55a59327ca17fa9a78e9d01ace2..98a195143eac0b8ce16600fe8e0f079f634c5001 100644 (file)
@@ -9,8 +9,8 @@ QUIC SSL object
 
  #include <openssl/ssl.h>
 
__owur int SSL_set_blocking_mode(SSL *s, int blocking);
__owur int SSL_get_blocking_mode(SSL *s);
+ int SSL_set_blocking_mode(SSL *s, int blocking);
+ int SSL_get_blocking_mode(SSL *s);
 
 =head1 DESCRIPTION
 
index 6ebe7bead46d025f1ddfc400a2a0521b668f8ba6..acb4ef22c05d99d5b83ba9a65bf484cc73749e8f 100644 (file)
@@ -8,7 +8,7 @@ SSL_set_initial_peer_addr - set the initial peer address for a QUIC connection
 
  #include <openssl/ssl.h>
 
__owur int SSL_set_initial_peer_addr(SSL *s, const BIO_ADDR *addr);
+ int SSL_set_initial_peer_addr(SSL *s, const BIO_ADDR *addr);
 
 =head1 DESCRIPTION