summaryrefslogtreecommitdiffstats
path: root/doc/man3/DSA_generate_key.pod
diff options
context:
space:
mode:
authorMatt Caswell <matt@openssl.org>2021-12-02 11:33:49 +0000
committerMatt Caswell <matt@openssl.org>2021-12-06 11:23:34 +0000
commit3dbf82438004b31258627f324841476c4f586c19 (patch)
tree7a78a660e58a6277ae78f2872552d09491774d23 /doc/man3/DSA_generate_key.pod
parentc87a4dd7a728288da943cb4e2e51150df5dfd1b8 (diff)
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/DSA_generate_key.pod')
-rw-r--r--doc/man3/DSA_generate_key.pod6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/man3/DSA_generate_key.pod b/doc/man3/DSA_generate_key.pod
index 65cc29ddda..c8f123be00 100644
--- a/doc/man3/DSA_generate_key.pod
+++ b/doc/man3/DSA_generate_key.pod
@@ -8,9 +8,9 @@ DSA_generate_key - generate DSA key pair
#include <openssl/dsa.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)>:
+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 DSA_generate_key(DSA *a);