Do not have duplicate section heads
authorRich Salz <rsalz@akamai.com>
Fri, 16 Aug 2019 12:34:16 +0000 (08:34 -0400)
committerPauli <paul.dale@oracle.com>
Mon, 26 Aug 2019 21:08:11 +0000 (07:08 +1000)
commit485d336137f2afa62e378bc39dcfa37dcfb222da
treea09e160c8cdc4378fb3d13a9c47989813d131904
parent6d745d740d37d680ff696486218b650512bbbbc6
Do not have duplicate section heads

Change find-doc-nits to complain if a section header is repeated,
within a parent header (i.e., duplicate =head2 within a =head1).
In almost all cases, we just remove the duplicate header, as
it was a "continuation" of the =head1 that was already in affect.
In some cases, just remove "=head1 NOTES", possibly moving text
around, because the "NOTES" were really important parts of the
DESCRIPTION section.

No =headX sections should end with a period.
All =head1 labels should be in all uppercase.
No sub-head (=head2, etc) should be in all uppercase.
Update find-doc-nits to reject the above.

Fixup an internal POD link

Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Paul Yang <kaishen.yy@antfin.com>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/9631)
20 files changed:
doc/man1/openssl-ciphers.pod
doc/man1/openssl-cms.pod
doc/man1/openssl-ocsp.pod
doc/man1/openssl-pkcs8.pod
doc/man1/openssl-pkeyutl.pod
doc/man3/CMS_compress.pod
doc/man3/CMS_encrypt.pod
doc/man3/CRYPTO_THREAD_run_once.pod
doc/man3/EVP_EncryptInit.pod
doc/man3/OSSL_trace_set_channel.pod
doc/man3/PKCS12_newpass.pod
doc/man3/PKCS7_encrypt.pod
doc/man3/PKCS7_sign.pod
doc/man3/SSL_CTX_set_options.pod
doc/man3/SSL_CTX_use_psk_identity_hint.pod
doc/man3/SSL_shutdown.pod
doc/man5/x509v3_config.pod
doc/man7/RAND_DRBG.pod
doc/man7/provider.pod
util/find-doc-nits