Updates for auto init/deinit review comments

[openssl.git] / doc / crypto / OPENSSL_INIT_crypto_library_start.pod

diff --git a/doc/crypto/OPENSSL_INIT_crypto_library_start.pod b/doc/crypto/OPENSSL_INIT_crypto_library_start.pod
index bea0e62f935ddee28aafb2be14c7a33044ebd9a6..16f95fe604769fa9bb7bb7770563e38545d4d15c 100644 (file)
--- a/doc/crypto/OPENSSL_INIT_crypto_library_start.pod
+++ b/doc/crypto/OPENSSL_INIT_crypto_library_start.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
 
 =head1 NAME
 

-OPENSSL_INIT_library_stop, OPENSSL_INIT_crypto_library_start,
+OPENSSL_INIT_crypto_library_start, OPENSSL_INIT_library_stop,

 OPENSSL_INIT_register_stop_handler, OPENSSL_INIT_thread_stop - OpenSSL
 initialisation and deinitialisation functions
 
 OPENSSL_INIT_register_stop_handler, OPENSSL_INIT_thread_stop - OpenSSL
 initialisation and deinitialisation functions
 


@@ -32,10 +32,12 @@ However, there way be situations when explicit initialisation is desirable or
 needed, for example when some non-default initialisation is required. The
 function OPENSSL_INIT_crypto_library_start() can be used for this purpose for
 libcrypto (see also L<OPENSSL_INIT_ssl_library_start(3)> for the libssl
 needed, for example when some non-default initialisation is required. The
 function OPENSSL_INIT_crypto_library_start() can be used for this purpose for
 libcrypto (see also L<OPENSSL_INIT_ssl_library_start(3)> for the libssl

-equivalent). In order to perform non-default initialisation it MUST be called
-prior to any other calls of this function. As numerous internal OpenSSL
-functions also call this, this usually means you should call it prior to ANY
-other OpenSSL function calls.
+equivalent).
+
+Numerous internal OpenSSL functions call OPENSSL_INIT_crypto_library_start().
+Therefore, in order to perform non-default initialisation,
+OPENSSL_INIT_crypto_library_start() MUST be called by application code prior to
+any other OpenSSL function calls.

 
 The B<opts> parameter specifies which aspects of libcrypto should be
 initialised. Valid options are:
 
 The B<opts> parameter specifies which aspects of libcrypto should be
 initialised. Valid options are:


@@ -166,8 +168,7 @@ configuration file is assumed. For example
      { OPENSSL_INIT_SET_CONF_FILENAME, .value.type_string = "myconf.cnf" },
      { OPENSSL_INIT_SET_END, .value.type_int = 0 }
  };
      { OPENSSL_INIT_SET_CONF_FILENAME, .value.type_string = "myconf.cnf" },
      { OPENSSL_INIT_SET_END, .value.type_int = 0 }
  };

- OPENSSL_INIT_crypto_library_start(OPENSSL_INIT_LOAD_CONFIG,
-                                   (const OPENSSL_INIT_SETTINGS *)&settings);
+ OPENSSL_INIT_crypto_library_start(OPENSSL_INIT_LOAD_CONFIG, settings);

 
 The B<settings> parameter must be an array of OPENSSL_INIT_SETTINGS values
 terminated with an OPENSSL_INIT_SET_END entry.
 
 The B<settings> parameter must be an array of OPENSSL_INIT_SETTINGS values
 terminated with an OPENSSL_INIT_SET_END entry.


@@ -221,6 +222,6 @@ L<OPENSSL_INIT_ssl_library_start(3)>
 
 The OPENSSL_INIT_library_stop, OPENSSL_INIT_crypto_library_start,
 OPENSSL_INIT_register_stop_handler and OPENSSL_INIT_thread_stop functions were
 
 The OPENSSL_INIT_library_stop, OPENSSL_INIT_crypto_library_start,
 OPENSSL_INIT_register_stop_handler and OPENSSL_INIT_thread_stop functions were

-first added in OpenSSL 1.1.0.
+added in OpenSSL 1.1.0.

 
 =cut
 
 =cut