diff options
author | Matt Caswell <matt@openssl.org> | 2021-12-02 11:33:49 +0000 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2021-12-06 11:23:34 +0000 |
commit | 3dbf82438004b31258627f324841476c4f586c19 (patch) | |
tree | 7a78a660e58a6277ae78f2872552d09491774d23 /doc/man3/EVP_EncryptInit.pod | |
parent | c87a4dd7a728288da943cb4e2e51150df5dfd1b8 (diff) | |
download | openssl-3dbf82438004b31258627f324841476c4f586c19.tar.gz |
Clarify the deprecation warnings in the docs
There was recently an instance where a user was confused by the
deprecation warnings in the docs. They believed the warning applied to
the immediately preceding function declarations, when it fact it applied
to the following function declarations.
https://mta.openssl.org/pipermail/openssl-users/2021-December/014665.html
We clarify the wording to make it clear that the warning applies to the
following functions.
Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/17180)
Diffstat (limited to 'doc/man3/EVP_EncryptInit.pod')
-rw-r--r-- | doc/man3/EVP_EncryptInit.pod | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/man3/EVP_EncryptInit.pod b/doc/man3/EVP_EncryptInit.pod index d37c60ba89..7f9c44b107 100644 --- a/doc/man3/EVP_EncryptInit.pod +++ b/doc/man3/EVP_EncryptInit.pod @@ -229,15 +229,15 @@ EVP_CIPHER_CTX_mode #define EVP_CIPHER_CTX_type EVP_CIPHER_CTX_get_type #define EVP_CIPHER_CTX_mode EVP_CIPHER_CTX_get_mode -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)>: +The following function has been deprecated since OpenSSL 3.0, and can be +hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value, +see L<openssl_user_macros(7)>: const EVP_CIPHER *EVP_CIPHER_CTX_cipher(const EVP_CIPHER_CTX *ctx); -Deprecated since OpenSSL 1.1.0, can be hidden entirely by defining -B<OPENSSL_API_COMPAT> with a suitable version value, see -L<openssl_user_macros(7)>: +The following function has been deprecated since OpenSSL 1.1.0, and can be +hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value, +see L<openssl_user_macros(7)>: int EVP_CIPHER_CTX_flags(const EVP_CIPHER_CTX *ctx); |