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 | |
| parent | 17f5c1d9bab0127260ec212c55fc7193fea099a5 (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)
(cherry picked from commit 3dbf82438004b31258627f324841476c4f586c19)
97 files changed, 330 insertions, 308 deletions
diff --git a/doc/man3/BF_encrypt.pod b/doc/man3/BF_encrypt.pod index b4a335076d..b6df43efc2 100644 --- a/doc/man3/BF_encrypt.pod +++ b/doc/man3/BF_encrypt.pod @@ -9,9 +9,9 @@ BF_cfb64_encrypt, BF_ofb64_encrypt, BF_options - Blowfish encryption #include <openssl/blowfish.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)>: void BF_set_key(BF_KEY *key, int len, const unsigned char *data); diff --git a/doc/man3/BIO_get_ex_new_index.pod b/doc/man3/BIO_get_ex_new_index.pod index 7dce548f90..f26b573350 100644 --- a/doc/man3/BIO_get_ex_new_index.pod +++ b/doc/man3/BIO_get_ex_new_index.pod @@ -43,9 +43,9 @@ X509_get_ex_new_index, X509_set_ex_data, X509_get_ex_data #define TYPE_set_app_data(TYPE *d, void *arg) #define TYPE_get_app_data(TYPE *d) -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 DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); diff --git a/doc/man3/BIO_set_callback.pod b/doc/man3/BIO_set_callback.pod index 157312bfaa..b98c0929cb 100644 --- a/doc/man3/BIO_set_callback.pod +++ b/doc/man3/BIO_set_callback.pod @@ -24,9 +24,9 @@ BIO_debug_callback_ex, BIO_callback_fn_ex, BIO_callback_fn long BIO_debug_callback_ex(BIO *bio, int oper, const char *argp, size_t len, int argi, long argl, int ret, size_t *processed); - 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)>: typedef long (*BIO_callback_fn)(BIO *b, int oper, const char *argp, int argi, long argl, long ret); diff --git a/doc/man3/BN_generate_prime.pod b/doc/man3/BN_generate_prime.pod index ef797e5971..b536bcb3b7 100644 --- a/doc/man3/BN_generate_prime.pod +++ b/doc/man3/BN_generate_prime.pod @@ -34,9 +34,9 @@ BN_is_prime, BN_is_prime_fasttest - generate primes and test for primality void *BN_GENCB_get_arg(BN_GENCB *cb); -Deprecated since OpenSSL 0.9.8, 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 0.9.8, and can be +hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value, +see L<openssl_user_macros(7)>: BIGNUM *BN_generate_prime(BIGNUM *ret, int num, int safe, BIGNUM *add, BIGNUM *rem, void (*callback)(int, int, void *), @@ -49,7 +49,9 @@ L<openssl_user_macros(7)>: void (*callback)(int, int, void *), BN_CTX *ctx, void *cb_arg, int do_trial_division); -Deprecated since OpenSSL 3.0: +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_is_prime_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx, BN_GENCB *cb); diff --git a/doc/man3/BN_rand.pod b/doc/man3/BN_rand.pod index c18d184177..a443cae357 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); diff --git a/doc/man3/CONF_modules_free.pod b/doc/man3/CONF_modules_free.pod index f47637f62b..fd22d82899 100644 --- a/doc/man3/CONF_modules_free.pod +++ b/doc/man3/CONF_modules_free.pod @@ -12,9 +12,9 @@ OpenSSL configuration cleanup functions void CONF_modules_finish(void); void CONF_modules_unload(int all); -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 functions have 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)>: void CONF_modules_free(void); diff --git a/doc/man3/DES_random_key.pod b/doc/man3/DES_random_key.pod index 775611a8ed..1f0020eae6 100644 --- a/doc/man3/DES_random_key.pod +++ b/doc/man3/DES_random_key.pod @@ -16,9 +16,9 @@ DES_fcrypt, DES_crypt - DES encryption #include <openssl/des.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)>: void DES_random_key(DES_cblock *ret); diff --git a/doc/man3/DH_generate_key.pod b/doc/man3/DH_generate_key.pod index 722dea65bd..2b14f2ad27 100644 --- a/doc/man3/DH_generate_key.pod +++ b/doc/man3/DH_generate_key.pod @@ -9,9 +9,9 @@ Diffie-Hellman key exchange #include <openssl/dh.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 DH_generate_key(DH *dh); diff --git a/doc/man3/DH_generate_parameters.pod b/doc/man3/DH_generate_parameters.pod index ff548ee0f0..bbcfe24ae6 100644 --- a/doc/man3/DH_generate_parameters.pod +++ b/doc/man3/DH_generate_parameters.pod @@ -12,9 +12,9 @@ parameters #include <openssl/dh.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 DH_generate_parameters_ex(DH *dh, int prime_len, int generator, BN_GENCB *cb); @@ -25,9 +25,9 @@ L<openssl_user_macros(7)>: int DH_check_params_ex(const DH *dh); int DH_check_pub_key_ex(const DH *dh, const BIGNUM *pub_key); -Deprecated since OpenSSL 0.9.8, 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 0.9.8, and can be +hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value, +see L<openssl_user_macros(7)>: DH *DH_generate_parameters(int prime_len, int generator, void (*callback)(int, int, void *), void *cb_arg); diff --git a/doc/man3/DH_get0_pqg.pod b/doc/man3/DH_get0_pqg.pod index 5de7bae219..2afc35c77f 100644 --- a/doc/man3/DH_get0_pqg.pod +++ b/doc/man3/DH_get0_pqg.pod @@ -12,9 +12,9 @@ DH_get_length, DH_set_length - Routines for getting and setting data in a DH obj #include <openssl/dh.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)>: void DH_get0_pqg(const DH *dh, const BIGNUM **p, const BIGNUM **q, const BIGNUM **g); diff --git a/doc/man3/DH_get_1024_160.pod b/doc/man3/DH_get_1024_160.pod index f4465930d1..af2fc8c205 100644 --- a/doc/man3/DH_get_1024_160.pod +++ b/doc/man3/DH_get_1024_160.pod @@ -39,9 +39,9 @@ BN_get_rfc3526_prime_8192 BIGNUM *BN_get_rfc3526_prime_6144(BIGNUM *bn); BIGNUM *BN_get_rfc3526_prime_8192(BIGNUM *bn); -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)>: #include <openssl/dh.h> diff --git a/doc/man3/DH_meth_new.pod b/doc/man3/DH_meth_new.pod index 48396e3bce..779a695167 100644 --- a/doc/man3/DH_meth_new.pod +++ b/doc/man3/DH_meth_new.pod @@ -14,9 +14,9 @@ DH_meth_set_generate_params - Routines to build up DH methods #include <openssl/dh.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)>: DH_METHOD *DH_meth_new(const char *name, int flags); diff --git a/doc/man3/DH_new_by_nid.pod b/doc/man3/DH_new_by_nid.pod index 163be09fed..6876e239aa 100644 --- a/ |