diff options
| author | Matt Caswell <matt@openssl.org> | 2019-06-06 12:12:49 +0100 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2019-06-12 10:12:14 +0100 |
| commit | b5283535d52002f892ef17c890a3e1840640a60b (patch) | |
| tree | 9980c32d1efb9bb99b25a36d8482b2f9da6c0740 /util/missingssl.txt | |
| parent | 51583cb8f464b49d2ea33b2be027274ac0d4b1a0 (diff) | |
Make find-doc-nits check for newly added undocumented symbols
We create lists of undocumented functions and macros as they are now so
that find-doc-nits can check for newly introduced functions/macros that
are undocumented.
This works in a similar way to the -u and -d options to find-doc-nits.
These count undocumented symbols and print a detailed list of undocumented
symbols repsectively. This commit adds the -v and -e options to restrict
the count/detailed list to newly added undocumented symbols only.
There is also a new -s option that does the same as -e except that it
produces no output if there are no newly undocumented symbols.
We also amend "make doc-nits" to add the -s option which should cause
travis to fail if a PR adds undocumented symbols.
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9094)
Diffstat (limited to 'util/missingssl.txt')
| -rw-r--r-- | util/missingssl.txt | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/util/missingssl.txt b/util/missingssl.txt new file mode 100644 index 0000000000..07ba2b3763 --- /dev/null +++ b/util/missingssl.txt @@ -0,0 +1,46 @@ +# A list of libssl functions that are known to be missing documentation as +# used by the find-doc-nits -v option. The list is as of commit 355b419698. +ERR_load_SSL_strings +SRP_Calc_A_param +SSL_COMP_get_name +SSL_COMP_set0_compression_methods +SSL_CONF_CTX_finish +SSL_CTX_SRP_CTX_free +SSL_CTX_SRP_CTX_init +SSL_CTX_get0_certificate +SSL_CTX_get0_ctlog_store +SSL_CTX_get0_privatekey +SSL_CTX_get_ssl_method +SSL_CTX_set0_ctlog_store +SSL_CTX_set_client_cert_engine +SSL_CTX_set_cookie_generate_cb +SSL_CTX_set_cookie_verify_cb +SSL_CTX_set_not_resumable_session_callback +SSL_CTX_set_purpose +SSL_CTX_set_trust +SSL_SRP_CTX_free +SSL_SRP_CTX_init +SSL_add_dir_cert_subjects_to_stack +SSL_add_file_cert_subjects_to_stack +SSL_add_ssl_module +SSL_certs_clear +SSL_copy_session_id +SSL_dup_CA_list +SSL_get0_dane +SSL_get_certificate +SSL_get_current_compression +SSL_get_current_expansion +SSL_get_finished +SSL_get_peer_finished +SSL_get_privatekey +SSL_set_SSL_CTX +SSL_set_debug +SSL_set_not_resumable_session_callback +SSL_set_purpose +SSL_set_session_secret_cb +SSL_set_session_ticket_ext +SSL_set_session_ticket_ext_cb +SSL_set_trust +SSL_srp_server_param_with_username +SSL_test_functions +SSL_trace |