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/missingmacro.txt | |
parent | 51583cb8f464b49d2ea33b2be027274ac0d4b1a0 (diff) | |
download | openssl-b5283535d52002f892ef17c890a3e1840640a60b.zip openssl-b5283535d52002f892ef17c890a3e1840640a60b.tar.gz openssl-b5283535d52002f892ef17c890a3e1840640a60b.tar.bz2 |
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/missingmacro.txt')
-rw-r--r-- | util/missingmacro.txt | 217 |
1 files changed, 217 insertions, 0 deletions
diff --git a/util/missingmacro.txt b/util/missingmacro.txt new file mode 100644 index 0000000..ef429c6 --- /dev/null +++ b/util/missingmacro.txt @@ -0,0 +1,217 @@ +# A list of macros that are known to be missing documentation as used by the +# find-doc-nits -v option. The list is as of commit 355b419698. +BIO_get_flags +BIO_set_retry_special +BIO_set_retry_read +BIO_set_retry_write +BIO_clear_retry_flags +BIO_get_retry_flags +BIO_CB_return +BIO_cb_pre +BIO_cb_post +BIO_set_app_data +BIO_get_app_data +BIO_set_conn_mode +BIO_dup_state +BIO_buffer_get_num_lines +BIO_buffer_peek +BIO_ctrl_dgram_connect +BIO_ctrl_set_connected +BIO_dgram_recv_timedout +BIO_dgram_send_timedout +BIO_dgram_get_peer +BIO_dgram_set_peer +BIO_dgram_get_mtu_overhead +BIO_sock_cleanup +ossl_bio__attr__ +BN_prime_checks_for_size +BN_GF2m_sub +BN_GF2m_cmp +BUF_strdup +BUF_strndup +BUF_memdup +BUF_strlcpy +BUF_strlcat +BUF_strnlen +COMP_zlib_cleanup +NCONF_get_number +OSSL_CORE_MAKE_FUNC +OPENSSL_MALLOC_MAX_NELEMS +CRYPTO_cleanup_all_ex_data +CRYPTO_num_locks +CRYPTO_set_locking_callback +CRYPTO_get_locking_callback +CRYPTO_set_add_lock_callback +CRYPTO_get_add_lock_callback +CRYPTO_THREADID_set_numeric +CRYPTO_THREADID_set_pointer +CRYPTO_THREADID_set_callback +CRYPTO_THREADID_get_callback +CRYPTO_THREADID_current +CRYPTO_THREADID_cmp +CRYPTO_THREADID_cpy +CRYPTO_THREADID_hash +CRYPTO_set_id_callback +CRYPTO_get_id_callback +CRYPTO_thread_id +CRYPTO_set_dynlock_create_callback +CRYPTO_set_dynlock_lock_callback +CRYPTO_set_dynlock_destroy_callback +CRYPTO_get_dynlock_create_callback +CRYPTO_get_dynlock_lock_callback +CRYPTO_get_dynlock_destroy_callback +OpenSSLDie +OPENSSL_assert +DSA_is_prime +OPENSSL_GLOBAL_REF +ECParameters_dup +ENGINE_load_openssl +ENGINE_load_dynamic +ENGINE_load_padlock +ENGINE_load_capi +ENGINE_load_afalg +ENGINE_load_cryptodev +ENGINE_load_rdrand +EVP_MD_nid +EVP_MD_name +EVP_CIPHER_name +EVP_ENCODE_LENGTH +EVP_DECODE_LENGTH +BIO_set_md_ctx +EVP_add_cipher_alias +EVP_add_digest_alias +EVP_delete_cipher_alias +EVP_delete_digest_alias +EVP_MD_CTX_create +EVP_MD_CTX_init +EVP_MD_CTX_destroy +EVP_CIPHER_CTX_init +EVP_CIPHER_CTX_cleanup +OPENSSL_add_all_algorithms_conf +OPENSSL_add_all_algorithms_noconf +LHASH_HASH_FN +LHASH_COMP_FN +LHASH_DOALL_ARG_FN +LHASH_OF +DEFINE_LHASH_OF +int_implement_lhash_doall +OBJ_create_and_add_object +OBJ_bsearch +OBJ_bsearch_ex +PEM_read_bio_OCSP_REQUEST +PEM_read_bio_OCSP_RESPONSE +PEM_write_bio_OCSP_REQUEST +PEM_write_bio_OCSP_RESPONSE +ASN1_BIT_STRING_digest +OCSP_CERTSTATUS_dup +OPENSSL_VERSION_PREREQ +OPENSSL_MSTR_HELPER +OPENSSL_MSTR +OSSL_PARAM_DEFN +OSSL_PARAM_int +OSSL_PARAM_uint +OSSL_PARAM_long +OSSL_PARAM_ulong +OSSL_PARAM_int32 +OSSL_PARAM_uint32 +OSSL_PARAM_int64 +OSSL_PARAM_uint64 +OSSL_PARAM_size_t +OSSL_PARAM_double +OSSL_PARAM_SIZED_int +OSSL_PARAM_SIZED_uint +OSSL_PARAM_SIZED_long +OSSL_PARAM_SIZED_ulong +OSSL_PARAM_SIZED_int32 +OSSL_PARAM_SIZED_uint32 +OSSL_PARAM_SIZED_int64 +OSSL_PARAM_SIZED_uint64 +OSSL_PARAM_SIZED_size_t +OSSL_PARAM_SIZED_double +PKCS7_get_signed_attributes +PKCS7_get_attributes +PKCS7_type_is_signed +PKCS7_type_is_encrypted +PKCS7_type_is_enveloped +PKCS7_type_is_signedAndEnveloped +PKCS7_type_is_data +PKCS7_type_is_digest +PKCS7_set_detached +PKCS7_get_detached +PKCS7_is_detached +RSA_set_app_data +RSA_get_app_data +STACK_OF +SKM_DEFINE_STACK_OF +U64 +SSL_set_mtu +DTLS_set_link_mtu +DTLS_get_link_min_mtu +SSL_CTX_set_cert_flags +SSL_set_cert_flags +SSL_CTX_clear_cert_flags +SSL_clear_cert_flags +SSL_set_app_data +SSL_get_app_data +SSL_SESSION_set_app_data +SSL_SESSION_get_app_data +SSL_CTX_get_app_data +SSL_CTX_set_app_data +SSLeay_add_ssl_algorithms +DTLSv1_get_timeout +DTLSv1_handle_timeout +SSL_num_renegotiations +SSL_clear_num_renegotiations +SSL_total_renegotiations +SSL_CTX_set_dh_auto +SSL_set_dh_auto +SSL_get0_certificate_types +SSL_CTX_set1_client_certificate_types +SSL_set1_client_certificate_types +SSL_get0_raw_cipherlist +SSL_get0_ec_point_formats +SSL_CTX_need_tmp_RSA +SSL_CTX_set_tmp_rsa +SSL_need_tmp_RSA +SSL_set_tmp_rsa +SSL_CTX_set_tmp_rsa_callback +SSL_set_tmp_rsa_callback +SSL_get_ex_new_index +SSL_SESSION_get_ex_new_index +SSL_CTX_get_ex_new_index +SSL_CTX_set_default_read_ahead +SSL_cache_hit +TLS1_get_version +TLS1_get_client_version +SSL_set_tlsext_debug_callback +SSL_set_tlsext_debug_arg +SSL_get_tlsext_status_exts +SSL_set_tlsext_status_exts +SSL_get_tlsext_status_ids +SSL_set_tlsext_status_ids +SSL_CTX_get_tlsext_ticket_keys +SSL_CTX_set_tlsext_ticket_keys +OSSL_TRACE_CANCEL +OSSL_TRACE_ENABLED +OSSL_TRACEV +OSSL_TRACE +OSSL_TRACE3 +OSSL_TRACE4 +OSSL_TRACE5 +OSSL_TRACE6 +OSSL_TRACE7 +OSSL_TRACE8 +UI_set_app_data +UI_get_app_data +X509_extract_key +X509_REQ_extract_key +X509_name_cmp +X509_STORE_CTX_set_app_data +X509_STORE_CTX_get_app_data +X509_LOOKUP_load_file +X509_LOOKUP_add_dir +X509V3_conf_err +X509V3_set_ctx_test +X509V3_set_ctx_nodb +EXT_BITSTRING +EXT_IA5STRING |