Commit 1722496f authored by Rich Salz's avatar Rich Salz
Browse files

Remove doc of non-existent functions 

Fix test for "documenting private functions"
And add -p flag to doc-nits recipe
Mark when things were deprecated, if doc'd as such

Reviewed-by: default avatarMatt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/3624)
parent 6dad1efe

Configurations/unix-Makefile.tmpl

+1 −1
Changes for Configurations/unix-Makefile.tmpl: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -602,7 +602,7 @@ generate: generate_apps generate_crypto_bn generate_crypto_objects \ 
          generate_crypto_conf generate_crypto_asn1



doc-nits:

	(cd $(SRCDIR); $(PERL) util/find-doc-nits -n ) >doc-nits

	(cd $(SRCDIR); $(PERL) util/find-doc-nits -n -p ) >doc-nits

	if [ -s doc-nits ] ; then cat doc-nits; rm doc-nits ; exit 1; fi



# Test coverage is a good idea for the future

doc/man3/BIO_new.pod

+3 −4
Changes for doc/man3/BIO_new.pod: 3 added lines, 4 removed lines.
Original line number Diff line number Diff line
@@ -2,15 +2,14 @@ 


=head1 NAME



BIO_new, BIO_up_ref, BIO_free, BIO_vfree, BIO_free_all,

BIO_set - BIO allocation and freeing functions

BIO_new, BIO_up_ref, BIO_free, BIO_vfree, BIO_free_all

- BIO allocation and freeing functions



=head1 SYNOPSIS



 #include <openssl/bio.h>



 BIO *  BIO_new(const BIO_METHOD *type);

 int  BIO_set(BIO *a, const BIO_METHOD *type);

 int    BIO_up_ref(BIO *a);

 int    BIO_free(BIO *a);

 void   BIO_vfree(BIO *a);
@@ -38,7 +37,7 @@ If B<a> is NULL nothing is done. 


BIO_new() returns a newly created BIO or NULL if the call fails.



BIO_set(), BIO_up_ref() and BIO_free() return 1 for success and 0 for failure.

BIO_up_ref() and BIO_free() return 1 for success and 0 for failure.



BIO_free_all() and BIO_vfree() do not return values.

doc/man3/ENGINE_add.pod

+11 −25
Changes for doc/man3/ENGINE_add.pod: 11 added lines, 25 removed lines.
Original line number Diff line number Diff line
@@ -2,10 +2,10 @@ 


=head1 NAME



ENGINE_get_DH, ENGINE_get_DSA, ENGINE_get_ECDH, ENGINE_get_ECDSA,

ENGINE_get_DH, ENGINE_get_DSA,

ENGINE_by_id, ENGINE_get_cipher_engine, ENGINE_get_default_DH,

ENGINE_get_default_DSA, ENGINE_get_default_ECDH,

ENGINE_get_default_ECDSA, ENGINE_get_default_RAND,

ENGINE_get_default_DSA,

ENGINE_get_default_RAND,

ENGINE_get_default_RSA, ENGINE_get_digest_engine, ENGINE_get_first,

ENGINE_get_last, ENGINE_get_next, ENGINE_get_prev, ENGINE_new,

ENGINE_get_ciphers, ENGINE_get_ctrl_function, ENGINE_get_digests,
@@ -17,15 +17,15 @@ ENGINE_get_name, ENGINE_get_cmd_defns, ENGINE_get_cipher, 
ENGINE_get_digest, ENGINE_add, ENGINE_cmd_is_executable,

ENGINE_ctrl, ENGINE_ctrl_cmd, ENGINE_ctrl_cmd_string,

ENGINE_finish, ENGINE_free, ENGINE_get_flags, ENGINE_init,

ENGINE_register_DH, ENGINE_register_DSA, ENGINE_register_ECDH,

ENGINE_register_ECDSA, ENGINE_register_RAND, ENGINE_register_RSA,

ENGINE_register_DH, ENGINE_register_DSA,

ENGINE_register_RAND, ENGINE_register_RSA,

ENGINE_register_all_complete, ENGINE_register_ciphers,

ENGINE_register_complete, ENGINE_register_digests, ENGINE_remove,

ENGINE_set_DH, ENGINE_set_DSA, ENGINE_set_ECDH, ENGINE_set_ECDSA,

ENGINE_set_DH, ENGINE_set_DSA,

ENGINE_set_RAND, ENGINE_set_RSA, ENGINE_set_ciphers,

ENGINE_set_cmd_defns, ENGINE_set_ctrl_function, ENGINE_set_default,

ENGINE_set_default_DH, ENGINE_set_default_DSA, ENGINE_set_default_ECDH,

ENGINE_set_default_ECDSA, ENGINE_set_default_RAND, ENGINE_set_default_RSA,

ENGINE_set_default_DH, ENGINE_set_default_DSA,

ENGINE_set_default_RAND, ENGINE_set_default_RSA,

ENGINE_set_default_ciphers, ENGINE_set_default_digests,

ENGINE_set_default_string, ENGINE_set_destroy_function,

ENGINE_set_digests, ENGINE_set_finish_function, ENGINE_set_flags,
@@ -33,11 +33,11 @@ ENGINE_set_id, ENGINE_set_init_function, ENGINE_set_load_privkey_function, 
ENGINE_set_load_pubkey_function, ENGINE_set_name, ENGINE_up_ref,

ENGINE_get_table_flags, ENGINE_cleanup,

ENGINE_load_builtin_engines, ENGINE_register_all_DH,

ENGINE_register_all_DSA, ENGINE_register_all_ECDH,

ENGINE_register_all_ECDSA, ENGINE_register_all_RAND,

ENGINE_register_all_DSA,

ENGINE_register_all_RAND,

ENGINE_register_all_RSA, ENGINE_register_all_ciphers,

ENGINE_register_all_digests, ENGINE_set_table_flags, ENGINE_unregister_DH,

ENGINE_unregister_DSA, ENGINE_unregister_ECDH, ENGINE_unregister_ECDSA,

ENGINE_unregister_DSA,

ENGINE_unregister_RAND, ENGINE_unregister_RSA, ENGINE_unregister_ciphers,

ENGINE_unregister_digests

- ENGINE cryptographic module support
@@ -63,8 +63,6 @@ ENGINE_unregister_digests 


 ENGINE *ENGINE_get_default_RSA(void);

 ENGINE *ENGINE_get_default_DSA(void);

 ENGINE *ENGINE_get_default_ECDH(void);

 ENGINE *ENGINE_get_default_ECDSA(void);

 ENGINE *ENGINE_get_default_DH(void);

 ENGINE *ENGINE_get_default_RAND(void);

 ENGINE *ENGINE_get_cipher_engine(int nid);
@@ -72,8 +70,6 @@ ENGINE_unregister_digests 


 int ENGINE_set_default_RSA(ENGINE *e);

 int ENGINE_set_default_DSA(ENGINE *e);

 int ENGINE_set_default_ECDH(ENGINE *e);

 int ENGINE_set_default_ECDSA(ENGINE *e);

 int ENGINE_set_default_DH(ENGINE *e);

 int ENGINE_set_default_RAND(ENGINE *e);

 int ENGINE_set_default_ciphers(ENGINE *e);
@@ -91,12 +87,6 @@ ENGINE_unregister_digests 
 int ENGINE_register_DSA(ENGINE *e);

 void ENGINE_unregister_DSA(ENGINE *e);

 void ENGINE_register_all_DSA(void);

 int ENGINE_register_ECDH(ENGINE *e);

 void ENGINE_unregister_ECDH(ENGINE *e);

 void ENGINE_register_all_ECDH(void);

 int ENGINE_register_ECDSA(ENGINE *e);

 void ENGINE_unregister_ECDSA(ENGINE *e);

 void ENGINE_register_all_ECDSA(void);

 int ENGINE_register_DH(ENGINE *e);

 void ENGINE_unregister_DH(ENGINE *e);

 void ENGINE_register_all_DH(void);
@@ -127,8 +117,6 @@ ENGINE_unregister_digests 
 int ENGINE_set_name(ENGINE *e, const char *name);

 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);

 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);

 int ENGINE_set_ECDH(ENGINE *e, const ECDH_METHOD *dh_meth);

 int ENGINE_set_ECDSA(ENGINE *e, const ECDSA_METHOD *dh_meth);

 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);

 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);

 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f);
@@ -146,8 +134,6 @@ ENGINE_unregister_digests 
 const char *ENGINE_get_name(const ENGINE *e);

 const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);

 const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);

 const ECDH_METHOD *ENGINE_get_ECDH(const ENGINE *e);

 const ECDSA_METHOD *ENGINE_get_ECDSA(const ENGINE *e);

 const DH_METHOD *ENGINE_get_DH(const ENGINE *e);

 const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);

 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e);

doc/man3/EVP_PKEY_CTX_ctrl.pod

+3 −3
Changes for doc/man3/EVP_PKEY_CTX_ctrl.pod: 3 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ 


EVP_PKEY_CTX_ctrl, EVP_PKEY_CTX_ctrl_str,

EVP_PKEY_CTX_set_signature_md, EVP_PKEY_CTX_set_rsa_padding,

EVP_PKEY_CTX_set_rsa_pss_saltlen, EVP_PKEY_CTX_set_rsa_rsa_keygen_bits,

EVP_PKEY_CTX_set_rsa_pss_saltlen, EVP_PKEY_CTX_set_rsa_keygen_bits,

EVP_PKEY_CTX_set_rsa_keygen_pubexp, EVP_PKEY_CTX_set_dsa_paramgen_bits,

EVP_PKEY_CTX_set_dh_paramgen_prime_len,

EVP_PKEY_CTX_set_dh_paramgen_generator,
@@ -26,7 +26,7 @@ EVP_PKEY_CTX_set_ec_param_enc - algorithm specific control operations 


 int EVP_PKEY_CTX_set_rsa_padding(EVP_PKEY_CTX *ctx, int pad);

 int EVP_PKEY_CTX_set_rsa_pss_saltlen(EVP_PKEY_CTX *ctx, int len);

 int EVP_PKEY_CTX_set_rsa_rsa_keygen_bits(EVP_PKEY_CTX *ctx, int mbits);

 int EVP_PKEY_CTX_set_rsa_keygen_bits(EVP_PKEY_CTX *ctx, int mbits);

 int EVP_PKEY_CTX_set_rsa_keygen_pubexp(EVP_PKEY_CTX *ctx, BIGNUM *pubexp);



 #include <openssl/dsa.h>
@@ -93,7 +93,7 @@ to be automatically determined based on the B<PSS> block structure. If this 
macro is not called maximum salt length is used when signing and auto detection

when verifying is used by default.



The EVP_PKEY_CTX_set_rsa_rsa_keygen_bits() macro sets the RSA key length for

The EVP_PKEY_CTX_set_rsa_keygen_bits() macro sets the RSA key length for

RSA key generation to B<bits>. If not specified 1024 bits is used.



The EVP_PKEY_CTX_set_rsa_keygen_pubexp() macro sets the public exponent value

doc/man3/OPENSSL_init_crypto.pod

+5 −5
Changes for doc/man3/OPENSSL_init_crypto.pod: 5 added lines, 5 removed lines.
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 


=head1 NAME



OPENSSL_init_new, OPENSSL_INIT_set_config_appname, OPENSSL_INIT_free,

OPENSSL_INIT_new, OPENSSL_INIT_set_config_appname, OPENSSL_INIT_free,

OPENSSL_init_crypto, OPENSSL_cleanup,

OPENSSL_atexit, OPENSSL_thread_stop - OpenSSL

initialisation and deinitialisation functions
@@ -16,7 +16,7 @@ initialisation and deinitialisation functions 
 int OPENSSL_atexit(void (*handler)(void));

 void OPENSSL_thread_stop(void);



 OPENSSL_INIT_SETTINGS *OPENSSL_init_new(void);

 OPENSSL_INIT_SETTINGS *OPENSSL_INIT_new(void);

 int OPENSSL_INIT_set_config_appname(OPENSSL_INIT_SETTINGS *init,

                                     const char* name);

 void OPENSSL_INIT_free(OPENSSL_INIT_SETTINGS *init);
@@ -96,7 +96,7 @@ B<OPENSSL_INIT_ADD_ALL_DIGESTS> will be ignored. 


With this option an OpenSSL configuration file will be automatically loaded and

used by calling OPENSSL_config(). This is not a default option.

See the description of OPENSSL_init_new(), below.

See the description of OPENSSL_INIT_new(), below.



=item OPENSSL_INIT_NO_LOAD_CONFIG
@@ -192,7 +192,7 @@ described in the NOTES section below. 
The B<OPENSSL_INIT_LOAD_CONFIG> flag will load a default configuration

file.  To specify a different file, an B<OPENSSL_INIT_SETTINGS> must

be created and used. The routines

OPENSSL_init_new() and OPENSSL_INIT_set_config_appname() can be used to

OPENSSL_INIT_new() and OPENSSL_INIT_set_config_appname() can be used to

allocate the object and set the application name, and then the

object can be released with OPENSSL_INIT_free() when done.
@@ -230,7 +230,7 @@ L<OPENSSL_init_ssl(3)> 
=head1 HISTORY



The OPENSSL_init_crypto(), OPENSSL_cleanup(), OPENSSL_atexit(),

OPENSSL_thread_stop(), OPENSSL_init_new(), OPENSSL_INIT_set_config_appname()

OPENSSL_thread_stop(), OPENSSL_INIT_new(), OPENSSL_INIT_set_config_appname()

and OPENSSL_INIT_free() functions were added in OpenSSL 1.1.0.



=head1 COPYRIGHT