From: Dr. David von Oheimb Date: Fri, 3 Dec 2021 10:34:23 +0000 (+0100) Subject: OSSL_HTTP_open(): clarify doc of 'server' arg and its use of BIO_new_connect() X-Git-Tag: openssl-3.2.0-alpha1~3252 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=119f8145c3bde29aae5d5b18c44d1663df975ef5;p=thirdparty%2Fopenssl.git OSSL_HTTP_open(): clarify doc of 'server' arg and its use of BIO_new_connect() Reviewed-by: Paul Dale Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/17186) --- diff --git a/doc/man3/OSSL_HTTP_transfer.pod b/doc/man3/OSSL_HTTP_transfer.pod index b0ca3944486..7fcd71dbe03 100644 --- a/doc/man3/OSSL_HTTP_transfer.pod +++ b/doc/man3/OSSL_HTTP_transfer.pod @@ -56,9 +56,10 @@ OSSL_HTTP_open() initiates an HTTP session using the I argument if not NULL, else by connecting to a given I optionally via a I. Typically the OpenSSL build supports sockets and the I parameter is NULL. -In this case I must be NULL as well, and the -library creates a network BIO internally for connecting to the given I -and the optionally given I, defaulting to 80 for HTTP or 443 for HTTPS. +In this case I must be NULL as well and the I must be non-NULL. +The function creates a network BIO internally using L +for connecting to the given server and the optionally given I, +defaulting to 80 for HTTP or 443 for HTTPS. Then this internal BIO is used for setting up a connection and for exchanging one or more request and response. If I is given and I is NULL then this I is used instead. @@ -255,7 +256,7 @@ OSSL_HTTP_close() returns 0 if anything went wrong while disconnecting, else 1. =head1 SEE ALSO -L, L +L, L, L, L, L