POD: stop abusing comment
authorRichard Levitte <levitte@openssl.org>
Sun, 29 Sep 2019 15:10:59 +0000 (17:10 +0200)
committerRichard Levitte <levitte@openssl.org>
Fri, 11 Oct 2019 13:30:57 +0000 (15:30 +0200)
commitbb82531f6592f0e9af28d3502346191a465374a3
tree325118a87bacbf708d64ffc252eb8efb8cea260c
parent59d0e6c8964c07d7e46c9989735cd1486250b330
POD: stop abusing comment

OpenSSL uses some POD directives masquerading as 'comment'
('=for comment' etc).  This is abusive and confusing.  Instead, we use
our own keyword.

    =for openssl whatever

    =begin openssl

    whatever

    =end openssl

(we have never used the multiline form, but might start one day)

Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10048)
35 files changed:
doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod
doc/internal/man3/ossl_param_bld_init.pod
doc/man1/openssl-cmds.pod
doc/man1/openssl-ts.pod
doc/man1/tsget.pod
doc/man3/BIO_f_base64.pod
doc/man3/BIO_f_cipher.pod
doc/man3/BIO_f_md.pod
doc/man3/BIO_f_ssl.pod
doc/man3/BIO_get_ex_new_index.pod
doc/man3/DEFINE_STACK_OF.pod
doc/man3/EVP_EncryptInit.pod
doc/man3/EVP_aes.pod
doc/man3/EVP_aria.pod
doc/man3/EVP_camellia.pod
doc/man3/EVP_des.pod
doc/man3/OPENSSL_LH_COMPFUNC.pod
doc/man3/OSSL_PARAM_int.pod
doc/man3/OSSL_trace_enabled.pod
doc/man3/OSSL_trace_set_channel.pod
doc/man3/PEM_read_CMS.pod
doc/man3/SSL_get_all_async_fds.pod
doc/man3/SSL_set_async_callback.pod
doc/man3/X509_dup.pod
doc/man3/d2i_X509.pod
doc/man7/bio.pod
doc/man7/ossl_store-file.pod
doc/man7/ossl_store.pod
doc/man7/provider-cipher.pod
doc/man7/provider-digest.pod
doc/man7/provider-keyexch.pod
doc/man7/provider-mac.pod
doc/man7/provider-signature.pod
doc/man7/provider.pod
util/find-doc-nits