diff options
author | Matt Caswell <matt@openssl.org> | 2016-04-04 17:00:04 +0100 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2016-04-13 08:52:33 +0100 |
commit | cbf6959fe8ff51730a397ea426075d547ec5d7a8 (patch) | |
tree | eef161225ca88ad3d6471c81c942dc6c7f3a26df /doc/crypto | |
parent | 6d4fb1d59e61aacefa25edc4fe5acfe1ac93f743 (diff) |
Deprecate CONF_modules_free() and make it a no-op
CONF_modules_free() 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/crypto')
-rw-r--r-- | doc/crypto/CONF_modules_free.pod | 17 | ||||
-rw-r--r-- | doc/crypto/OPENSSL_config.pod | 6 |
2 files changed, 15 insertions, 8 deletions
diff --git a/doc/crypto/CONF_modules_free.pod b/doc/crypto/CONF_modules_free.pod index 37a7b16000..12e594dace 100644 --- a/doc/crypto/CONF_modules_free.pod +++ b/doc/crypto/CONF_modules_free.pod @@ -9,10 +9,15 @@ #include <openssl/conf.h> - void CONF_modules_free(void); void CONF_modules_finish(void); void CONF_modules_unload(int all); +Deprecated: + + #if OPENSSL_API_COMPAT < 0x10100000L + # define CONF_modules_free() + #endif + =head1 DESCRIPTION CONF_modules_free() closes down and frees up all memory allocated by all @@ -27,8 +32,10 @@ B<all> is B<1> all modules, including builtin modules will be unloaded. =head1 NOTES -Normally applications will only call CONF_modules_free() at application to -tidy up any configuration performed. +Normally in versions of OpenSSL prior to 1.1.0 applications will only call +CONF_modules_free() at application to tidy up any configuration performed. From +1.1.0 CONF_modules_free() is deprecated an no explicit CONF cleanup as required +at all. For more information see L<OPENSSL_init_crypto(3)>. =head1 RETURN VALUE @@ -39,4 +46,8 @@ None of the functions return a value. L<conf(5)>, L<OPENSSL_config(3)>, L<CONF_modules_load_file(3)> +=head1 HISTORY + +CONF_modules_free() was deprecated in OpenSSL 1.1.0. + =cut diff --git a/doc/crypto/OPENSSL_config.pod b/doc/crypto/OPENSSL_config.pod index 4c82566097..77061a00ce 100644 --- a/doc/crypto/OPENSSL_config.pod +++ b/doc/crypto/OPENSSL_config.pod @@ -23,9 +23,6 @@ Multiple calls have no effect. OPENSSL_no_config() disables configuration. If called before OPENSSL_config() no configuration takes place. -Applications should free up configuration at application closedown by calling -CONF_modules_free(). - If the application is built with B<OPENSSL_LOAD_CONF> defined, then a call to OpenSSL_add_all_algorithms() will implicitly call OPENSSL_config() first. @@ -57,8 +54,7 @@ Neither OPENSSL_config() nor OPENSSL_no_config() return a value. =head1 SEE ALSO L<conf(5)>, -L<CONF_modules_load_file(3)>, -L<CONF_modules_free(3)> +L<CONF_modules_load_file(3)> =head1 HISTORY |