Commit 1d5099de authored by Matt Caswell's avatar Matt Caswell
Browse files

Misc fix ups to deprecate explicit de-init documentation



Documentation fix ups as a result of feedback received.

Reviewed-by: default avatarTim Hudson <tjh@openssl.org>
Reviewed-by: default avatarRichard Levitte <levitte@openssl.org>
parent 6457615a
Loading
Loading
Loading
Loading
+4 −4
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@
Deprecated:

 #if OPENSSL_API_COMPAT < 0x10100000L
 # define CONF_modules_free()
 void CONF_modules_free(void)
 #endif

=head1 DESCRIPTION
@@ -33,9 +33,9 @@ B<all> is B<1> all modules, including builtin modules will be unloaded.
=head1 NOTES

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)>.
CONF_modules_free() at application exit to tidy up any configuration performed.
From 1.1.0 CONF_modules_free() is deprecated and no explicit CONF cleanup is
required at all. For more information see L<OPENSSL_init_crypto(3)>.

=head1 RETURN VALUE

+4 −7
Original line number Diff line number Diff line
@@ -12,17 +12,14 @@ Deprecated:
 #include <openssl/err.h>

 #if OPENSSL_API_COMPAT < 0x10100000L
 # define ERR_load_crypto_strings() \
     OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
 # define ERR_free_strings()
 void ERR_load_crypto_strings(void);
 void ERR_free_strings(void);
 #endif

 #include <openssl/ssl.h>

 #if OPENSSL_API_COMPAT < 0x10100000L
 # define SSL_load_error_strings() \
     OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS \
                     | OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
 void SSL_load_error_strings(void);
 #endif
 
=head1 DESCRIPTION
+1 −1
Original line number Diff line number Diff line
@@ -34,7 +34,7 @@ functions
Deprecated:

 #if OPENSSL_API_COMPAT < 0x10100000L
 # define OBJ_cleanup()
 void OBJ_cleanup(void)
 #endif

=head1 DESCRIPTION
+7 −27
Original line number Diff line number Diff line
@@ -12,31 +12,11 @@ add algorithms to internal table
Deprecated:

 # if OPENSSL_API_COMPAT < 0x10100000L
 #  define OPENSSL_add_all_algorithms_conf() \
     OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS \
                         | OPENSSL_INIT_ADD_ALL_DIGESTS \
                         | 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
 #   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)
 void OpenSSL_add_all_algorithms(void);
 void OpenSSL_add_all_ciphers(void);
 void OpenSSL_add_all_digests(void);

 #  define EVP_cleanup()
 void EVP_cleanup(void)
# endif

=head1 DESCRIPTION
@@ -44,8 +24,8 @@ Deprecated:
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
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
de-initialisation is required. See L<OPENSSL_init_crypto(3)> for further
this table. From OpenSSL 1.1.0 they are deprecated. No explicit initialisation
or de-initialisation is required. See L<OPENSSL_init_crypto(3)> for further
information.

OpenSSL_add_all_digests() adds all digest algorithms to the table.
+1 −1
Original line number Diff line number Diff line
@@ -9,7 +9,7 @@ RAND_cleanup - erase the PRNG state
 #include <openssl/rand.h>

 #if OPENSSL_API_COMPAT < 0x10100000L
 # define RAND_cleanup()
 void RAND_cleanup(void)
 #endif

=head1 DESCRIPTION
Loading