GH721: Duplicated flags in doc

[openssl.git] / doc / ssl / OPENSSL_init_ssl.pod

diff --git a/doc/ssl/OPENSSL_init_ssl.pod b/doc/ssl/OPENSSL_init_ssl.pod
index d9246a53c1dd6fae26adfe221b8ea29cbdb73c23..110a282490608f4846d74a73ce1f9ebab10b528a 100644 (file)
--- a/doc/ssl/OPENSSL_init_ssl.pod
+++ b/doc/ssl/OPENSSL_init_ssl.pod
@@ -8,7 +8,7 @@ OPENSSL_init_ssl - OpenSSL (libssl and libcrypto) initialisation
 
  #include <openssl/ssl.h>
 
 
  #include <openssl/ssl.h>
 

- void OPENSSL_init_ssl(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);
+ int OPENSSL_init_ssl(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);

 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 


@@ -22,7 +22,7 @@ As of version 1.1.0 OpenSSL will automatically allocate all resources that it
 needs so no explicit initialisation is required. Similarly it will also
 automatically deinitialise as required.
 
 needs so no explicit initialisation is required. Similarly it will also
 automatically deinitialise as required.
 

-However, there way be situations when explicit initialisation is desirable or
+However, there may be situations when explicit initialisation is desirable or

 needed, for example when some non-default initialisation is required. The
 function OPENSSL_init_ssl() can be used for this purpose. Calling
 this function will explicitly initialise BOTH libcrypto and libssl. To
 needed, for example when some non-default initialisation is required. The
 function OPENSSL_init_ssl() can be used for this purpose. Calling
 this function will explicitly initialise BOTH libcrypto and libssl. To


@@ -57,11 +57,12 @@ B<OPENSSL_INIT_LOAD_SSL_STRINGS> will be ignored.
 
 =back
 
 
 =back
 

-The B<settings> parameter specifies optional settings values to an option.
-Currently no such settings are available for libssl specific options. However
-these settings will also be passed internally to a call to
-L<OPENSSL_init_crypto(3)>, so this parameter can also be used to
-provide libcrypto settings values.
+OPENSSL_init_ssl() takes a B<settings> parameter which can be used to
+set parameter values.  See L<OPENSSL_init_crypto(3)> for details.
+
+=head1 RETURN VALUES
+
+The function OPENSSL_init_ssl() returns 1 on success or 0 on error.

 
 =head1 SEE ALSO
 
 
 =head1 SEE ALSO