From: Pauli <paul.dale@oracle.com>
Date: Tue, 14 Jul 2020 00:25:38 +0000 (+1000)
Subject: doc: document that the engine initialisation options are deprecated.
X-Git-Tag: openssl-3.0.0-alpha5~16
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=2d71c9468a338adaa5c78b9d4a1382ff8f106143;p=thirdparty%2Fopenssl.git

doc: document that the engine initialisation options are deprecated.

They can't be removed yet for API compatibility reasons.

Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/12226)
---

diff --git a/doc/man3/OPENSSL_init_crypto.pod b/doc/man3/OPENSSL_init_crypto.pod
index 8a8f4615e5f..7e7b1ef69c4 100644
--- a/doc/man3/OPENSSL_init_crypto.pod
+++ b/doc/man3/OPENSSL_init_crypto.pod
@@ -122,43 +122,51 @@ sub-library (see L<ASYNC_start_job(3)>). This is a default option.
 =item OPENSSL_INIT_ENGINE_RDRAND
 
 With this option the library will automatically load and initialise the
-RDRAND engine (if available). This not a default option.
+RDRAND engine (if available). This not a default option and is deprecated
+in OpenSSL 3.0.
 
 =item OPENSSL_INIT_ENGINE_DYNAMIC
 
 With this option the library will automatically load and initialise the
-dynamic engine. This not a default option.
+dynamic engine. This not a default option and is deprecated
+in OpenSSL 3.0.
 
 =item OPENSSL_INIT_ENGINE_OPENSSL
 
 With this option the library will automatically load and initialise the
-openssl engine. This not a default option.
+openssl engine. This not a default option and is deprecated
+in OpenSSL 3.0.
 
 =item OPENSSL_INIT_ENGINE_CRYPTODEV
 
 With this option the library will automatically load and initialise the
-cryptodev engine (if available). This not a default option.
+cryptodev engine (if available). This not a default option and is deprecated
+in OpenSSL 3.0.
 
 =item OPENSSL_INIT_ENGINE_CAPI
 
 With this option the library will automatically load and initialise the
-CAPI engine (if available). This not a default option.
+CAPI engine (if available). This not a default option and is deprecated
+in OpenSSL 3.0.
 
 =item OPENSSL_INIT_ENGINE_PADLOCK
 
 With this option the library will automatically load and initialise the
-padlock engine (if available). This not a default option.
+padlock engine (if available). This not a default option and is deprecated
+in OpenSSL 3.0.
 
 =item OPENSSL_INIT_ENGINE_AFALG
 
 With this option the library will automatically load and initialise the
-AFALG engine. This not a default option.
+AFALG engine. This not a default option and is deprecated
+in OpenSSL 3.0.
 
 =item OPENSSL_INIT_ENGINE_ALL_BUILTIN
 
 With this option the library will automatically load and initialise all the
 built in engines listed above with the exception of the openssl and afalg
-engines. This not a default option.
+engines. This not a default option and is deprecated
+in OpenSSL 3.0.
 
 =item OPENSSL_INIT_ATFORK
 
diff --git a/include/openssl/crypto.h b/include/openssl/crypto.h
index 33296b6ada1..abd3a68cd49 100644
--- a/include/openssl/crypto.h
+++ b/include/openssl/crypto.h
@@ -434,7 +434,6 @@ int CRYPTO_memcmp(const void * in_a, const void * in_b, size_t len);
     | OPENSSL_INIT_ENGINE_CRYPTODEV | OPENSSL_INIT_ENGINE_CAPI | \
     OPENSSL_INIT_ENGINE_PADLOCK)
 
-
 /* Library initialisation functions */
 void OPENSSL_cleanup(void);
 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);