diff options
| author | Matt Caswell <matt@openssl.org> | 2016-02-10 13:59:15 +0000 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2016-02-10 17:40:59 +0000 |
| commit | 0fc32b0718ec210e03b6d8623d4819ed04615a1b (patch) | |
| tree | 9491a02a740d05b415790bcfeb16eb65f6a06267 /doc | |
| parent | 8bd8221be80708825ddb9771d4c9fff67860119b (diff) | |
The new init functions can now fail so shouldn't be void
The new init functions can fail if the library has already been stopped. We
should be able to indicate failure with a 0 return value.
Reviewed-by: Rich Salz <rsalz@openssl.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/crypto/OPENSSL_init_crypto.pod | 6 | ||||
| -rw-r--r-- | doc/ssl/OPENSSL_init_ssl.pod | 6 |
2 files changed, 8 insertions, 4 deletions
diff --git a/doc/crypto/OPENSSL_init_crypto.pod b/doc/crypto/OPENSSL_init_crypto.pod index 11bc1c7f7b..67c84913cd 100644 --- a/doc/crypto/OPENSSL_init_crypto.pod +++ b/doc/crypto/OPENSSL_init_crypto.pod @@ -11,7 +11,7 @@ initialisation and deinitialisation functions #include <openssl/crypto.h> void OPENSSL_cleanup(void); - void OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings); + int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings); int OPENSSL_atexit(void (*handler)(void)); void OPENSSL_thread_stop(void); @@ -206,8 +206,8 @@ using static linking should also call OPENSSL_thread_stop(). =head1 RETURN VALUES -The function OPENSSL_atexit() returns 1 on success or 0 on -error. +The functions OPENSSL_init_crypto and OPENSSL_atexit() returns 1 on success or +0 on error. =head1 SEE ALSO diff --git a/doc/ssl/OPENSSL_init_ssl.pod b/doc/ssl/OPENSSL_init_ssl.pod index d9246a53c1..113e93f94e 100644 --- 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> - 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 @@ -63,6 +63,10 @@ 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. +=head1 RETURN VALUES + +The function OPENSSL_init_ssl() returns 1 on success or 0 on error. + =head1 SEE ALSO L<OPENSSL_init_crypto(3)> |