Commit be80b21d authored by Richard Levitte's avatar Richard Levitte
Browse files

Docs: better deprecation text 



Expand the text on deprecation to be more descriptive and to refer
back to openssl_user_macros(7).

Incidently, this required a small change in util/find-doc-nits, to
have it skip over any line that isn't part of a block (i.e. that
hasn't been indented with at least one space.  That makes it skip over
deprecation text.

Reviewed-by: default avatarMatthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
(Merged from https://github.com/openssl/openssl/pull/7745)
parent 7b4a3515

doc/man3/BN_generate_prime.pod

+3 −3
Original line number Diff line number Diff line
@@ -33,9 +33,10 @@ for primality 


 void *BN_GENCB_get_arg(BN_GENCB *cb);



Deprecated:

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)>:



 #if OPENSSL_API_COMPAT < 0x00908000L

 BIGNUM *BN_generate_prime(BIGNUM *ret, int num, int safe, BIGNUM *add,

                           BIGNUM *rem, void (*callback)(int, int, void *),

                           void *cb_arg);
@@ -46,7 +47,6 @@ Deprecated: 
 int BN_is_prime_fasttest(const BIGNUM *a, int checks,

                          void (*callback)(int, int, void *), BN_CTX *ctx,

                          void *cb_arg, int do_trial_division);

 #endif



=head1 DESCRIPTION

doc/man3/CONF_modules_free.pod

+3 −3
Original line number Diff line number Diff line
@@ -12,11 +12,11 @@ OpenSSL configuration cleanup functions 
 void CONF_modules_finish(void);

 void CONF_modules_unload(int all);



Deprecated:

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)>:



 #if OPENSSL_API_COMPAT < 0x10100000L

 void CONF_modules_free(void)

 #endif



=head1 DESCRIPTION

doc/man3/DH_generate_parameters.pod

+3 −3
Original line number Diff line number Diff line
@@ -21,12 +21,12 @@ parameters 
 int DH_check_params_ex(const DH *dh);

 int DH_check_pub_key_ex(const DH *dh, const BIGNUM *pub_key);



Deprecated:

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)>:



 #if OPENSSL_API_COMPAT < 0x00908000L

 DH *DH_generate_parameters(int prime_len, int generator,

                            void (*callback)(int, int, void *), void *cb_arg);

 #endif



=head1 DESCRIPTION

doc/man3/DSA_generate_parameters.pod

+3 −3
Original line number Diff line number Diff line
@@ -13,13 +13,13 @@ DSA_generate_parameters_ex, DSA_generate_parameters - generate DSA parameters 
                                int *counter_ret, unsigned long *h_ret,

                                BN_GENCB *cb);



Deprecated:

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)>:



 #if OPENSSL_API_COMPAT < 0x00908000L

 DSA *DSA_generate_parameters(int bits, unsigned char *seed, int seed_len,

                              int *counter_ret, unsigned long *h_ret,

                              void (*callback)(int, int, void *), void *cb_arg);

 #endif



=head1 DESCRIPTION

doc/man3/ENGINE_add.pod

+3 −3
Original line number Diff line number Diff line
@@ -154,11 +154,11 @@ ENGINE_unregister_digests 
 EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,

                                  UI_METHOD *ui_method, void *callback_data);



Deprecated:

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)>:



 #if OPENSSL_API_COMPAT < 0x10100000L

 void ENGINE_cleanup(void)

 #endif



=head1 DESCRIPTION