Misc fix ups to deprecate explicit de-init documentation
authorMatt Caswell <matt@openssl.org>
Wed, 6 Apr 2016 10:13:25 +0000 (11:13 +0100)
committerMatt Caswell <matt@openssl.org>
Wed, 13 Apr 2016 07:59:03 +0000 (08:59 +0100)
Documentation fix ups as a result of feedback received.

Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
doc/crypto/CONF_modules_free.pod
doc/crypto/ERR_load_crypto_strings.pod
doc/crypto/OBJ_nid2obj.pod
doc/crypto/OpenSSL_add_all_algorithms.pod
doc/crypto/RAND_cleanup.pod
doc/crypto/engine.pod
doc/crypto/err.pod
doc/crypto/rand.pod
doc/ssl/SSL_COMP_add_compression_method.pod

index 12e594d..4a8580c 100644 (file)
@@ -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
 
index 9e960d9..68c006f 100644 (file)
@@ -12,19 +12,16 @@ 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
 
 All of the following functions are deprecated from OpenSSL 1.1.0. No explicit
index 2db96a1..d777d7c 100644 (file)
@@ -34,7 +34,7 @@ functions
 Deprecated:
 
  #if OPENSSL_API_COMPAT < 0x10100000L
# define OBJ_cleanup()
void OBJ_cleanup(void)
  #endif
 
 =head1 DESCRIPTION
index 78fe12a..10f3b8f 100644 (file)
@@ -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)
-
- #  define EVP_cleanup()
+ void OpenSSL_add_all_algorithms(void);
+ void OpenSSL_add_all_ciphers(void);
+ void OpenSSL_add_all_digests(void);
+
+ 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.
index b5c43ea..fd3f81c 100644 (file)
@@ -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
index cb9308d..8d1b3df 100644 (file)
@@ -135,7 +135,7 @@ engine - ENGINE cryptographic module support
 Deprecated:
 
  #if OPENSSL_API_COMPAT < 0x10100000L
# define ENGINE_cleanup()
void ENGINE_cleanup(void)
  #endif
 
 =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
 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
 are no inherent memory leaks to worry about from the ENGINE functionality.
index 0313aa3..33cb19d 100644 (file)
@@ -49,7 +49,7 @@ Deprecated:
  #endif
 
  #if OPENSSL_API_COMPAT < 0x10100000L
# define ERR_free_strings()
void ERR_free_strings(void)
  #endif
 
 
index 7d96050..46de8f7 100644 (file)
@@ -34,7 +34,7 @@ rand - pseudo-random number generator
 Deprecated:
 
  #if OPENSSL_API_COMPAT < 0x10100000L
# define RAND_cleanup()
void RAND_cleanup(void)
  #endif
 
 =head1 DESCRIPTION
index b08a424..fe10e1b 100644 (file)
@@ -13,7 +13,7 @@ SSL_COMP_add_compression_method, SSL_COMP_free_compression_methods - handle SSL/
 Deprecated:
 
  #if OPENSSL_API_COMPAT < 0x10100000L
# define SSL_COMP_free_compression_methods()
void SSL_COMP_free_compression_methods(void)
  #endif
 
 =head1 DESCRIPTION