Align documentation with recommendations of Linux Documentation Project
authorGustaf Neumann <neumann@wu-wien.ac.at>
Fri, 17 Jul 2020 10:31:26 +0000 (12:31 +0200)
committerDr. Matthias St. Pierre <matthias.st.pierre@ncp-e.com>
Wed, 22 Jul 2020 07:15:00 +0000 (09:15 +0200)
commit490c87110cc1fd673604fa1b94d5538f9fd852bb
tree3edd4a289e298a405dd7785fd1b21e81e8cd55e0
parentbf19b64aaeeddd5463d911823f9e2c3c40091005
Align documentation with recommendations of Linux Documentation Project

This change applies the recommendation of the Linux Documentation Project
to the documentation files of OpenSSL. Additionally, util/find-doc-nits
was updated accordingly.

The change follows a suggestion of mspncp on https://github.com/openssl/openssl/pull/12370
and incoporates the requested changes on the pull request

Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
(Merged from https://github.com/openssl/openssl/pull/12460)
51 files changed:
doc/internal/man3/ossl_method_construct.pod
doc/man1/openssl-cmp.pod.in
doc/man1/openssl-s_client.pod.in
doc/man1/openssl-ts.pod.in
doc/man1/openssl.pod
doc/man3/ASYNC_WAIT_CTX_new.pod
doc/man3/BIO_connect.pod
doc/man3/BIO_f_ssl.pod
doc/man3/BIO_read.pod
doc/man3/BIO_s_accept.pod
doc/man3/BIO_s_bio.pod
doc/man3/BIO_socket_wait.pod
doc/man3/BN_add.pod
doc/man3/BN_generate_prime.pod
doc/man3/BN_mod_mul_montgomery.pod
doc/man3/BN_set_bit.pod
doc/man3/DTLSv1_listen.pod
doc/man3/ERR_new.pod
doc/man3/EVP_PKEY_gen.pod
doc/man3/OPENSSL_init_crypto.pod
doc/man3/OPENSSL_init_ssl.pod
doc/man3/OSSL_CMP_CTX_new.pod
doc/man3/OSSL_CRMF_MSG_get0_tmpl.pod
doc/man3/RAND_load_file.pod
doc/man3/RSA_blinding_on.pod
doc/man3/SSL_CTX_dane_enable.pod
doc/man3/SSL_CTX_set_alpn_select_cb.pod
doc/man3/SSL_CTX_set_info_callback.pod
doc/man3/SSL_CTX_set_max_cert_list.pod
doc/man3/SSL_CTX_set_mode.pod
doc/man3/SSL_CTX_set_options.pod
doc/man3/SSL_CTX_set_read_ahead.pod
doc/man3/SSL_CTX_set_srp_password.pod
doc/man3/SSL_accept.pod
doc/man3/SSL_alloc_buffers.pod
doc/man3/SSL_connect.pod
doc/man3/SSL_do_handshake.pod
doc/man3/SSL_get_error.pod
doc/man3/SSL_read.pod
doc/man3/SSL_set1_host.pod
doc/man3/SSL_set_async_callback.pod
doc/man3/SSL_set_bio.pod
doc/man3/SSL_set_fd.pod
doc/man3/SSL_shutdown.pod
doc/man3/SSL_state_string.pod
doc/man3/SSL_want.pod
doc/man3/SSL_write.pod
doc/man3/X509_STORE_CTX_get_error.pod
doc/man3/X509_check_host.pod
doc/man5/x509v3_config.pod
util/find-doc-nits