Misc fix ups to deprecate explicit de-init documentation

[openssl.git] / doc / crypto / OpenSSL_add_all_algorithms.pod

diff --git a/doc/crypto/OpenSSL_add_all_algorithms.pod b/doc/crypto/OpenSSL_add_all_algorithms.pod
index 1300fe190c79d420d82187f248be0db79fc65927..10f3b8fbabf1848749f3c382ebc494fdf72dd07c 100644 (file)
--- a/doc/crypto/OpenSSL_add_all_algorithms.pod
+++ b/doc/crypto/OpenSSL_add_all_algorithms.pod
@@ -2,22 +2,31 @@
 
 =head1 NAME
 
 
 =head1 NAME
 

-OpenSSL_add_all_algorithms() - add algorithms to internal table
+OpenSSL_add_all_algorithms, OpenSSL_add_all_ciphers, OpenSSL_add_all_digests, EVP_cleanup -
+add algorithms to internal table

 
 =head1 SYNOPSIS
 
  #include <openssl/evp.h>
 
 
 =head1 SYNOPSIS
 
  #include <openssl/evp.h>
 

+Deprecated:
+
+ # if OPENSSL_API_COMPAT < 0x10100000L

  void OpenSSL_add_all_algorithms(void);
  void OpenSSL_add_all_ciphers(void);
  void OpenSSL_add_all_digests(void);
 
  void OpenSSL_add_all_algorithms(void);
  void OpenSSL_add_all_ciphers(void);
  void OpenSSL_add_all_digests(void);
 

- void EVP_cleanup(void);
+ void EVP_cleanup(void)
+# endif

 
 =head1 DESCRIPTION
 
 OpenSSL keeps an internal table of digest algorithms and ciphers. It uses
 
 =head1 DESCRIPTION
 
 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().
+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 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.
 
 
 OpenSSL_add_all_digests() adds all digest algorithms to the table.
 


@@ -27,7 +36,8 @@ ciphers).
 OpenSSL_add_all_ciphers() adds all encryption algorithms to the table including
 password based encryption algorithms.
 
 OpenSSL_add_all_ciphers() adds all encryption algorithms to the table including
 password based encryption algorithms.
 

-EVP_cleanup() removes all ciphers and digests from the table.
+In versions prior to 1.1.0 EVP_cleanup() removed all ciphers and digests from
+the table. It no longer has any effect in OpenSSL 1.1.0.

 
 =head1 RETURN VALUES
 
 
 =head1 RETURN VALUES
 


@@ -35,7 +45,7 @@ None of the functions return a value.
 
 =head1 NOTES
 
 
 =head1 NOTES
 

-A typical application will will call OpenSSL_add_all_algorithms() initially and
+A typical application will call OpenSSL_add_all_algorithms() initially and

 EVP_cleanup() before exiting.
 
 An application does not need to add algorithms to use them explicitly, for example
 EVP_cleanup() before exiting.
 
 An application does not need to add algorithms to use them explicitly, for example


@@ -43,7 +53,7 @@ by EVP_sha1(). It just needs to add them if it (or any of the functions it calls
 needs to lookup algorithms.
 
 The cipher and digest lookup functions are used in many parts of the library. If
 needs to lookup algorithms.
 
 The cipher and digest lookup functions are used in many parts of the library. If

-the table is not initialised several functions will misbehave and complain they
+the table is not initialized several functions will misbehave and complain they

 cannot find algorithms. This includes the PEM, PKCS#12, SSL and S/MIME libraries.
 This is a common query in the OpenSSL mailing lists.
 
 cannot find algorithms. This includes the PEM, PKCS#12, SSL and S/MIME libraries.
 This is a common query in the OpenSSL mailing lists.
 


@@ -59,7 +69,13 @@ too much of a problem in practice.
 
 =head1 SEE ALSO
 
 
 =head1 SEE ALSO
 

-L<evp(3)|evp(3)>, L<EVP_DigestInit(3)|EVP_DigestInit(3)>,
-L<EVP_EncryptInit(3)|EVP_EncryptInit(3)>
+L<evp(3)>, L<EVP_DigestInit(3)>,
+L<EVP_EncryptInit(3)>
+
+=head1 HISTORY
+
+The OpenSSL_add_all_algorithms(), OpenSSL_add_all_ciphers(),
+OpenSSL_add_all_digests(), and EVP_cleanup(), functions
+were deprecated in OpenSSL 1.1.0 by OPENSSL_init_crypto().

 
 =cut
 
 =cut