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/SHA256_Init.pod | |
parent | c87a4dd7a728288da943cb4e2e51150df5dfd1b8 (diff) | |
download | openssl-new-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/SHA256_Init.pod')
-rw-r--r-- | doc/man3/SHA256_Init.pod | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/man3/SHA256_Init.pod b/doc/man3/SHA256_Init.pod index 22c72aa884..3d647c381b 100644 --- a/doc/man3/SHA256_Init.pod +++ b/doc/man3/SHA256_Init.pod @@ -17,9 +17,9 @@ SHA512_Final - Secure Hash Algorithm unsigned char *SHA384(const unsigned char *data, size_t count, unsigned char *md_buf); unsigned char *SHA512(const unsigned char *data, size_t count, unsigned char *md_buf); -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 functions have 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)>: int SHA1_Init(SHA_CTX *c); int SHA1_Update(SHA_CTX *c, const void *data, size_t len); |