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:24:21 +0000 |
commit | ba22047c890b704ae31f8f97f028ca28c8916346 (patch) | |
tree | 5026e5fec11d534dc3528c5e1c12c857e259317b /doc/man3/BN_rand.pod | |
parent | 17f5c1d9bab0127260ec212c55fc7193fea099a5 (diff) | |
download | openssl-ba22047c890b704ae31f8f97f028ca28c8916346.zip openssl-ba22047c890b704ae31f8f97f028ca28c8916346.tar.gz openssl-ba22047c890b704ae31f8f97f028ca28c8916346.tar.bz2 |
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)
(cherry picked from commit 3dbf82438004b31258627f324841476c4f586c19)
Diffstat (limited to 'doc/man3/BN_rand.pod')
-rw-r--r-- | doc/man3/BN_rand.pod | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/man3/BN_rand.pod b/doc/man3/BN_rand.pod index c18d184..a443cae 100644 --- a/doc/man3/BN_rand.pod +++ b/doc/man3/BN_rand.pod @@ -27,9 +27,9 @@ BN_pseudo_rand_range BN_CTX *ctx); int BN_priv_rand_range(BIGNUM *rnd, const BIGNUM *range); -Deprecated since OpenSSL 3.0, can be hidden entirely by defining -OPENSSL_API_COMPAT with a suitable version value, see -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 BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom); int BN_pseudo_rand_range(BIGNUM *rnd, const BIGNUM *range); |