Misc fix ups to deprecate explicit de-init documentation
[openssl.git] / doc / crypto / ERR_load_crypto_strings.pod
index 88678d90205aea35011588800b73967e19ebe7be..68c006fd3c3dda0eb4dce0b87479cdb2ffba02bb 100644 (file)
@@ -7,26 +7,33 @@ load and free error strings
 
 =head1 SYNOPSIS
 
+Deprecated:
+
  #include <openssl/err.h>
 
+ #if OPENSSL_API_COMPAT < 0x10100000L
  void ERR_load_crypto_strings(void);
  void ERR_free_strings(void);
+ #endif
 
  #include <openssl/ssl.h>
 
+ #if OPENSSL_API_COMPAT < 0x10100000L
  void SSL_load_error_strings(void);
-
+ #endif
 =head1 DESCRIPTION
 
+All of the following functions are deprecated from OpenSSL 1.1.0. No explicit
+initialisation or de-initialisation is necessary. See L<OPENSSL_init_crypto(3)>
+and L<OPENSSL_init_ssl(3)>.
+
 ERR_load_crypto_strings() registers the error strings for all
 B<libcrypto> functions. SSL_load_error_strings() does the same,
 but also registers the B<libssl> error strings.
 
-One of these functions should be called before generating
-textual error messages. However, this is not required when memory
-usage is an issue.
-
-ERR_free_strings() frees all previously loaded error strings.
+In versions of OpenSSL prior to 1.1.0 ERR_free_strings() freed all previously
+loaded error strings. However from OpenSSL 1.1.0 it does nothing.
 
 =head1 RETURN VALUES