From: Pauli <paul.dale@oracle.com>
Date: Thu, 25 Jun 2020 01:30:13 +0000 (+1000)
Subject: doc: deprecate ENGINE documentation
X-Git-Tag: openssl-3.0.0-alpha5~25
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4222682dae2efde296ba43a98673b55d0ce55d7e;p=thirdparty%2Fopenssl.git

doc: deprecate ENGINE documentation

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

diff --git a/doc/man3/ENGINE_add.pod b/doc/man3/ENGINE_add.pod
index 1d07f5df83b..f2c112dcd80 100644
--- a/doc/man3/ENGINE_add.pod
+++ b/doc/man3/ENGINE_add.pod
@@ -46,6 +46,10 @@ ENGINE_unregister_digests
 
  #include <openssl/engine.h>
 
+Deprecated since OpenSSL 3.0, can be hidden entirely by defining
+B<OPENSSL_API_COMPAT> with a suitable version value, see
+L<openssl_user_macros(7)>:
+
  ENGINE *ENGINE_get_first(void);
  ENGINE *ENGINE_get_last(void);
  ENGINE *ENGINE_get_next(ENGINE *e);
@@ -162,6 +166,9 @@ L<openssl_user_macros(7)>:
 
 =head1 DESCRIPTION
 
+All of the functions described on this page are deprecated.
+Applications should instead use the provider APIs.
+
 These functions create, manipulate, and use cryptographic modules in the
 form of B<ENGINE> objects. These objects act as containers for
 implementations of cryptographic algorithms, and support a
@@ -651,6 +658,8 @@ L<RAND_bytes(3)>, L<config(5)>
 
 =head1 HISTORY
 
+All of these functions were deprecated in OpenSSL 3.0.
+
 ENGINE_cleanup() was deprecated in OpenSSL 1.1.0 by the automatic cleanup
 done by OPENSSL_cleanup()
 and should not be used.