diff options
| author | Matt Caswell <matt@openssl.org> | 2016-04-04 14:43:58 +0200 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2016-04-13 09:52:33 +0200 |
| commit | 6827cb3610fee4ec8cc120cc6b5bf88b04884ae7 (patch) | |
| tree | 1c2bec63a701723843db0e541fe037432336469d /doc | |
| parent | Deprecate COMP_zlib_cleanup() and make it a no-op (diff) | |
| download | openssl-6827cb3610fee4ec8cc120cc6b5bf88b04884ae7.tar.xz openssl-6827cb3610fee4ec8cc120cc6b5bf88b04884ae7.zip | |
Deprecate ERR_free_strings() and make it a no-op
ERR_free_strings() should not be called expicitly - we should leave
auto-deinit to clean this up instead.
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/crypto/ERR_load_crypto_strings.pod | 26 | ||||
| -rw-r--r-- | doc/crypto/err.pod | 6 |
2 files changed, 23 insertions, 9 deletions
diff --git a/doc/crypto/ERR_load_crypto_strings.pod b/doc/crypto/ERR_load_crypto_strings.pod index 88678d9020..9e960d94c9 100644 --- a/doc/crypto/ERR_load_crypto_strings.pod +++ b/doc/crypto/ERR_load_crypto_strings.pod @@ -7,26 +7,36 @@ load and free error strings =head1 SYNOPSIS +Deprecated: + #include <openssl/err.h> - void ERR_load_crypto_strings(void); - void ERR_free_strings(void); + #if OPENSSL_API_COMPAT < 0x10100000L + # define ERR_load_crypto_strings() \ + OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL) + # define ERR_free_strings() + #endif #include <openssl/ssl.h> - void SSL_load_error_strings(void); + #if OPENSSL_API_COMPAT < 0x10100000L + # define SSL_load_error_strings() \ + OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS \ + | OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL) + #endif =head1 DESCRIPTION +All of the following functions are deprecated from OpenSSL 1.1.0. No explicit +initialisation or de-initialisation is necessary. See L<OPENSSL_init_crypto(3)> +and L<OPENSSL_init_ssl(3)>. + ERR_load_crypto_strings() registers the error strings for all B<libcrypto> functions. SSL_load_error_strings() does the same, but also registers the B<libssl> error strings. -One of these functions should be called before generating -textual error messages. However, this is not required when memory -usage is an issue. - -ERR_free_strings() frees all previously loaded error strings. +In versions of OpenSSL prior to 1.1.0 ERR_free_strings() freed all previously +loaded error strings. However from OpenSSL 1.1.0 it does nothing. =head1 RETURN VALUES diff --git a/doc/crypto/err.pod b/doc/crypto/err.pod index 6847f2153c..0313aa38b8 100644 --- a/doc/crypto/err.pod +++ b/doc/crypto/err.pod @@ -33,7 +33,6 @@ err - error codes void ERR_print_errors_fp(FILE *fp); void ERR_load_crypto_strings(void); - void ERR_free_strings(void); void ERR_put_error(int lib, int func, int reason, const char *file, int line); @@ -49,6 +48,11 @@ Deprecated: void ERR_remove_state(unsigned long pid); #endif + #if OPENSSL_API_COMPAT < 0x10100000L + # define ERR_free_strings() + #endif + + =head1 DESCRIPTION When a call to the OpenSSL library fails, this is usually signaled |