Misc fix ups to deprecate explicit de-init documentation

Documentation fix ups as a result of feedback received.

Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
This commit is contained in:
Matt Caswell
2016-04-06 11:13:25 +01:00
parent 6457615ac8
commit 1d5099dec6
9 changed files with 21 additions and 44 deletions

View File

@@ -15,7 +15,7 @@
Deprecated: Deprecated:
#if OPENSSL_API_COMPAT < 0x10100000L #if OPENSSL_API_COMPAT < 0x10100000L
# define CONF_modules_free() void CONF_modules_free(void)
#endif #endif
=head1 DESCRIPTION =head1 DESCRIPTION
@@ -33,9 +33,9 @@ B<all> is B<1> all modules, including builtin modules will be unloaded.
=head1 NOTES =head1 NOTES
Normally in versions of OpenSSL prior to 1.1.0 applications will only call 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 CONF_modules_free() at application exit to tidy up any configuration performed.
1.1.0 CONF_modules_free() is deprecated an no explicit CONF cleanup as required From 1.1.0 CONF_modules_free() is deprecated and no explicit CONF cleanup is
at all. For more information see L<OPENSSL_init_crypto(3)>. required at all. For more information see L<OPENSSL_init_crypto(3)>.
=head1 RETURN VALUE =head1 RETURN VALUE

View File

@@ -12,19 +12,16 @@ Deprecated:
#include <openssl/err.h> #include <openssl/err.h>
#if OPENSSL_API_COMPAT < 0x10100000L #if OPENSSL_API_COMPAT < 0x10100000L
# define ERR_load_crypto_strings() \ void ERR_load_crypto_strings(void);
OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL) void ERR_free_strings(void);
# define ERR_free_strings()
#endif #endif
#include <openssl/ssl.h> #include <openssl/ssl.h>
#if OPENSSL_API_COMPAT < 0x10100000L #if OPENSSL_API_COMPAT < 0x10100000L
# define SSL_load_error_strings() \ void SSL_load_error_strings(void);
OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS \
| OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
#endif #endif
=head1 DESCRIPTION =head1 DESCRIPTION
All of the following functions are deprecated from OpenSSL 1.1.0. No explicit All of the following functions are deprecated from OpenSSL 1.1.0. No explicit

View File

@@ -34,7 +34,7 @@ functions
Deprecated: Deprecated:
#if OPENSSL_API_COMPAT < 0x10100000L #if OPENSSL_API_COMPAT < 0x10100000L
# define OBJ_cleanup() void OBJ_cleanup(void)
#endif #endif
=head1 DESCRIPTION =head1 DESCRIPTION

View File

@@ -12,31 +12,11 @@ add algorithms to internal table
Deprecated: Deprecated:
# if OPENSSL_API_COMPAT < 0x10100000L # if OPENSSL_API_COMPAT < 0x10100000L
# define OPENSSL_add_all_algorithms_conf() \ void OpenSSL_add_all_algorithms(void);
OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS \ void OpenSSL_add_all_ciphers(void);
| OPENSSL_INIT_ADD_ALL_DIGESTS \ void OpenSSL_add_all_digests(void);
| OPENSSL_INIT_LOAD_CONFIG, NULL)
# define OPENSSL_add_all_algorithms_noconf() \
OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS \
| OPENSSL_INIT_ADD_ALL_DIGESTS, NULL)
# ifdef OPENSSL_LOAD_CONF void EVP_cleanup(void)
# define OpenSSL_add_all_algorithms() \
OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS \
| OPENSSL_INIT_ADD_ALL_DIGESTS \
| OPENSSL_INIT_LOAD_CONFIG, NULL)
# else
# define OpenSSL_add_all_algorithms() \
OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS \
| OPENSSL_INIT_ADD_ALL_DIGESTS, NULL)
# endif
# define OpenSSL_add_all_ciphers() \
OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS, NULL)
# define OpenSSL_add_all_digests() \
OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_DIGESTS, NULL)
# define EVP_cleanup()
# endif # endif
=head1 DESCRIPTION =head1 DESCRIPTION
@@ -44,8 +24,8 @@ Deprecated:
OpenSSL keeps an internal table of digest algorithms and ciphers. It uses OpenSSL keeps an internal table of digest algorithms and ciphers. It uses
this table to lookup ciphers via functions such as EVP_get_cipher_byname(). In this table to lookup ciphers via functions such as EVP_get_cipher_byname(). In
OpenSSL versions prior to 1.1.0 these functions initialised and de-initialised OpenSSL versions prior to 1.1.0 these functions initialised and de-initialised
this table. From OpenSSL 1.1.0 are deprecated. No explicit initialisation or this table. From OpenSSL 1.1.0 they are deprecated. No explicit initialisation
de-initialisation is required. See L<OPENSSL_init_crypto(3)> for further or de-initialisation is required. See L<OPENSSL_init_crypto(3)> for further
information. information.
OpenSSL_add_all_digests() adds all digest algorithms to the table. OpenSSL_add_all_digests() adds all digest algorithms to the table.

View File

@@ -9,7 +9,7 @@ RAND_cleanup - erase the PRNG state
#include <openssl/rand.h> #include <openssl/rand.h>
#if OPENSSL_API_COMPAT < 0x10100000L #if OPENSSL_API_COMPAT < 0x10100000L
# define RAND_cleanup() void RAND_cleanup(void)
#endif #endif
=head1 DESCRIPTION =head1 DESCRIPTION

View File

@@ -135,7 +135,7 @@ engine - ENGINE cryptographic module support
Deprecated: Deprecated:
#if OPENSSL_API_COMPAT < 0x10100000L #if OPENSSL_API_COMPAT < 0x10100000L
# define ENGINE_cleanup() void ENGINE_cleanup(void)
#endif #endif
=head1 DESCRIPTION =head1 DESCRIPTION
@@ -304,7 +304,7 @@ dynamically allocated and populated with these implementations and linked
into OpenSSL's internal linked list. At this point it is important to into OpenSSL's internal linked list. At this point it is important to
mention an important API function; mention an important API function;
ENGINE_cleanup() void ENGINE_cleanup(void)
If no ENGINE API functions are called at all in an application, then there If no ENGINE API functions are called at all in an application, then there
are no inherent memory leaks to worry about from the ENGINE functionality. are no inherent memory leaks to worry about from the ENGINE functionality.

View File

@@ -49,7 +49,7 @@ Deprecated:
#endif #endif
#if OPENSSL_API_COMPAT < 0x10100000L #if OPENSSL_API_COMPAT < 0x10100000L
# define ERR_free_strings() void ERR_free_strings(void)
#endif #endif

View File

@@ -34,7 +34,7 @@ rand - pseudo-random number generator
Deprecated: Deprecated:
#if OPENSSL_API_COMPAT < 0x10100000L #if OPENSSL_API_COMPAT < 0x10100000L
# define RAND_cleanup() void RAND_cleanup(void)
#endif #endif
=head1 DESCRIPTION =head1 DESCRIPTION

View File

@@ -13,7 +13,7 @@ SSL_COMP_add_compression_method, SSL_COMP_free_compression_methods - handle SSL/
Deprecated: Deprecated:
#if OPENSSL_API_COMPAT < 0x10100000L #if OPENSSL_API_COMPAT < 0x10100000L
# define SSL_COMP_free_compression_methods() void SSL_COMP_free_compression_methods(void)
#endif #endif
=head1 DESCRIPTION =head1 DESCRIPTION