From: Richard Levitte <levitte@openssl.org>
Date: Sun, 29 Sep 2019 15:10:59 +0000 (+0200)
Subject: POD: stop abusing comment
X-Git-Tag: openssl-3.0.0-alpha1~1158
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bb82531f6592f0e9af28d3502346191a465374a3;p=thirdparty%2Fopenssl.git

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)
---

diff --git a/doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod b/doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod
index 7917c4c812a..a78193c2e22 100644
--- a/doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod
+++ b/doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod
@@ -9,7 +9,7 @@ ossl_sa_TYPE_doall_arg, ossl_sa_TYPE_get, ossl_sa_TYPE_set
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include "crypto/sparse_array.h"
 
diff --git a/doc/internal/man3/ossl_param_bld_init.pod b/doc/internal/man3/ossl_param_bld_init.pod
index 5179a8d64a1..062e2c293c3 100644
--- a/doc/internal/man3/ossl_param_bld_init.pod
+++ b/doc/internal/man3/ossl_param_bld_init.pod
@@ -15,7 +15,7 @@ ossl_param_bld_push_octet_ptr
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include "internal/params_build.h"
 
diff --git a/doc/man1/openssl-cmds.pod b/doc/man1/openssl-cmds.pod
index 5c4f06e1de7..9f7d6c654d4 100644
--- a/doc/man1/openssl-cmds.pod
+++ b/doc/man1/openssl-cmds.pod
@@ -55,7 +55,7 @@ x509
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
 B<openssl> I<cmd> B<-help> | [I<-option> | I<-option> I<arg>] ... [I<arg>] ...
 
diff --git a/doc/man1/openssl-ts.pod b/doc/man1/openssl-ts.pod
index c97909d5268..2e095d4d134 100644
--- a/doc/man1/openssl-ts.pod
+++ b/doc/man1/openssl-ts.pod
@@ -623,7 +623,7 @@ You could also look at the 'test' directory for more examples.
 
 =head1 BUGS
 
-=for comment foreign manuals: procmail(1), perl(1)
+=for openssl foreign manuals: procmail(1), perl(1)
 
 =over 2
 
diff --git a/doc/man1/tsget.pod b/doc/man1/tsget.pod
index 19c689ef6c7..d006198c67a 100644
--- a/doc/man1/tsget.pod
+++ b/doc/man1/tsget.pod
@@ -185,7 +185,7 @@ example:
 
 =head1 SEE ALSO
 
-=for comment foreign manuals: WWW::Curl::Easy
+=for openssl foreign manuals: WWW::Curl::Easy
 
 L<openssl(1)>,
 L<openssl-ts(1)>,
diff --git a/doc/man3/BIO_f_base64.pod b/doc/man3/BIO_f_base64.pod
index 6ac98e953e0..69de0077f72 100644
--- a/doc/man3/BIO_f_base64.pod
+++ b/doc/man3/BIO_f_base64.pod
@@ -6,7 +6,7 @@ BIO_f_base64 - base64 BIO filter
 
 =head1 SYNOPSIS
 
-=for comment multiple includes
+=for openssl multiple includes
 
  #include <openssl/bio.h>
  #include <openssl/evp.h>
diff --git a/doc/man3/BIO_f_cipher.pod b/doc/man3/BIO_f_cipher.pod
index 6f5dc15c65f..c1f1ff8a754 100644
--- a/doc/man3/BIO_f_cipher.pod
+++ b/doc/man3/BIO_f_cipher.pod
@@ -6,7 +6,7 @@ BIO_f_cipher, BIO_set_cipher, BIO_get_cipher_status, BIO_get_cipher_ctx - cipher
 
 =head1 SYNOPSIS
 
-=for comment multiple includes
+=for openssl multiple includes
 
  #include <openssl/bio.h>
  #include <openssl/evp.h>
diff --git a/doc/man3/BIO_f_md.pod b/doc/man3/BIO_f_md.pod
index cd45730ac55..8ad694853f0 100644
--- a/doc/man3/BIO_f_md.pod
+++ b/doc/man3/BIO_f_md.pod
@@ -6,7 +6,7 @@ BIO_f_md, BIO_set_md, BIO_get_md, BIO_get_md_ctx - message digest BIO filter
 
 =head1 SYNOPSIS
 
-=for comment multiple includes
+=for openssl multiple includes
 
  #include <openssl/bio.h>
  #include <openssl/evp.h>
diff --git a/doc/man3/BIO_f_ssl.pod b/doc/man3/BIO_f_ssl.pod
index 82bb16c5ba7..6b896e2a2b1 100644
--- a/doc/man3/BIO_f_ssl.pod
+++ b/doc/man3/BIO_f_ssl.pod
@@ -11,7 +11,7 @@ BIO_ssl_shutdown - SSL BIO
 
 =head1 SYNOPSIS
 
-=for comment multiple includes
+=for openssl multiple includes
 
  #include <openssl/bio.h>
  #include <openssl/ssl.h>
diff --git a/doc/man3/BIO_get_ex_new_index.pod b/doc/man3/BIO_get_ex_new_index.pod
index 0d1fb5b64b6..60f49f7e304 100644
--- a/doc/man3/BIO_get_ex_new_index.pod
+++ b/doc/man3/BIO_get_ex_new_index.pod
@@ -17,7 +17,7 @@ RSA_get_ex_new_index, RSA_set_ex_data, RSA_get_ex_data
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include <openssl/x509.h>
 
diff --git a/doc/man3/DEFINE_STACK_OF.pod b/doc/man3/DEFINE_STACK_OF.pod
index a3e9e73f554..4dd3de843f8 100644
--- a/doc/man3/DEFINE_STACK_OF.pod
+++ b/doc/man3/DEFINE_STACK_OF.pod
@@ -14,7 +14,7 @@ sk_TYPE_dup, sk_TYPE_deep_copy, sk_TYPE_set_cmp_func, sk_TYPE_new_reserve
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include <openssl/safestack.h>
 
diff --git a/doc/man3/EVP_EncryptInit.pod b/doc/man3/EVP_EncryptInit.pod
index 0f04fe0d91f..3e668206b1b 100644
--- a/doc/man3/EVP_EncryptInit.pod
+++ b/doc/man3/EVP_EncryptInit.pod
@@ -65,7 +65,7 @@ EVP_CIPHER_do_all_ex
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include <openssl/evp.h>
 
diff --git a/doc/man3/EVP_aes.pod b/doc/man3/EVP_aes.pod
index 5a2be9add5f..1ca893a738a 100644
--- a/doc/man3/EVP_aes.pod
+++ b/doc/man3/EVP_aes.pod
@@ -51,7 +51,7 @@ EVP_aes_256_xts
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include <openssl/evp.h>
 
diff --git a/doc/man3/EVP_aria.pod b/doc/man3/EVP_aria.pod
index b686edf5c45..6471acb2495 100644
--- a/doc/man3/EVP_aria.pod
+++ b/doc/man3/EVP_aria.pod
@@ -36,7 +36,7 @@ EVP_aria_256_gcm,
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include <openssl/evp.h>
 
diff --git a/doc/man3/EVP_camellia.pod b/doc/man3/EVP_camellia.pod
index 9ea3d9a351b..4a57f79512c 100644
--- a/doc/man3/EVP_camellia.pod
+++ b/doc/man3/EVP_camellia.pod
@@ -30,7 +30,7 @@ EVP_camellia_256_ofb
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include <openssl/evp.h>
 
diff --git a/doc/man3/EVP_des.pod b/doc/man3/EVP_des.pod
index 1911ff6f8b8..d00179eacb3 100644
--- a/doc/man3/EVP_des.pod
+++ b/doc/man3/EVP_des.pod
@@ -28,7 +28,7 @@ EVP_des_ede3_wrap
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include <openssl/evp.h>
 
diff --git a/doc/man3/OPENSSL_LH_COMPFUNC.pod b/doc/man3/OPENSSL_LH_COMPFUNC.pod
index 804891d0128..412a4f8800f 100644
--- a/doc/man3/OPENSSL_LH_COMPFUNC.pod
+++ b/doc/man3/OPENSSL_LH_COMPFUNC.pod
@@ -12,7 +12,7 @@ lh_TYPE_doall, lh_TYPE_doall_arg, lh_TYPE_error - dynamic hash table
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include <openssl/lhash.h>
 
diff --git a/doc/man3/OSSL_PARAM_int.pod b/doc/man3/OSSL_PARAM_int.pod
index 991b3d1212f..8d4aa90c6d0 100644
--- a/doc/man3/OSSL_PARAM_int.pod
+++ b/doc/man3/OSSL_PARAM_int.pod
@@ -32,7 +32,7 @@ OSSL_PARAM_set_octet_ptr
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include <openssl/params.h>
 
diff --git a/doc/man3/OSSL_trace_enabled.pod b/doc/man3/OSSL_trace_enabled.pod
index 2ced3d412fb..d49a77936b1 100644
--- a/doc/man3/OSSL_trace_enabled.pod
+++ b/doc/man3/OSSL_trace_enabled.pod
@@ -12,7 +12,7 @@ OSSL_TRACE_ENABLED
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include <openssl/trace.h>
 
diff --git a/doc/man3/OSSL_trace_set_channel.pod b/doc/man3/OSSL_trace_set_channel.pod
index f214abdb40c..ad06b4c2fd9 100644
--- a/doc/man3/OSSL_trace_set_channel.pod
+++ b/doc/man3/OSSL_trace_set_channel.pod
@@ -1,6 +1,6 @@
 =pod
 
-=for comment foreign manuals: atexit(3)
+=for openssl foreign manuals: atexit(3)
 
 =head1 NAME
 
diff --git a/doc/man3/PEM_read_CMS.pod b/doc/man3/PEM_read_CMS.pod
index a18856c81b4..5cc32517534 100644
--- a/doc/man3/PEM_read_CMS.pod
+++ b/doc/man3/PEM_read_CMS.pod
@@ -40,7 +40,7 @@ PEM_write_bio_SSL_SESSION
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include <openssl/pem.h>
 
diff --git a/doc/man3/SSL_get_all_async_fds.pod b/doc/man3/SSL_get_all_async_fds.pod
index 5adfe90eb51..03cd0e88e26 100644
--- a/doc/man3/SSL_get_all_async_fds.pod
+++ b/doc/man3/SSL_get_all_async_fds.pod
@@ -9,7 +9,7 @@ SSL_get_changed_async_fds
 
 =head1 SYNOPSIS
 
-=for comment multiple includes
+=for openssl multiple includes
 
  #include <openssl/async.h>
  #include <openssl/ssl.h>
diff --git a/doc/man3/SSL_set_async_callback.pod b/doc/man3/SSL_set_async_callback.pod
index 46d29234bd8..541b743973c 100644
--- a/doc/man3/SSL_set_async_callback.pod
+++ b/doc/man3/SSL_set_async_callback.pod
@@ -12,7 +12,7 @@ SSL_async_callback_fn
 
 =head1 SYNOPSIS
 
-=for comment multiple includes
+=for openssl multiple includes
 
  #include <openssl/ssl.h>
 
diff --git a/doc/man3/X509_dup.pod b/doc/man3/X509_dup.pod
index e190100d92d..d7d84778969 100644
--- a/doc/man3/X509_dup.pod
+++ b/doc/man3/X509_dup.pod
@@ -287,7 +287,7 @@ X509_dup,
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include <openssl/asn1t.h>
 
diff --git a/doc/man3/d2i_X509.pod b/doc/man3/d2i_X509.pod
index 12baaa9c37a..62e6b245a74 100644
--- a/doc/man3/d2i_X509.pod
+++ b/doc/man3/d2i_X509.pod
@@ -387,7 +387,7 @@ i2d_X509_VAL,
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  TYPE *d2i_TYPE(TYPE **a, unsigned char **ppin, long length);
  TYPE *d2i_TYPE_bio(BIO *bp, TYPE **a);
diff --git a/doc/man7/bio.pod b/doc/man7/bio.pod
index 63380bce574..bb23e569612 100644
--- a/doc/man7/bio.pod
+++ b/doc/man7/bio.pod
@@ -6,7 +6,7 @@ bio - Basic I/O abstraction
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
  #include <openssl/bio.h>
 
diff --git a/doc/man7/ossl_store-file.pod b/doc/man7/ossl_store-file.pod
index d6ea27bedfa..d4d163eabbe 100644
--- a/doc/man7/ossl_store-file.pod
+++ b/doc/man7/ossl_store-file.pod
@@ -14,7 +14,7 @@ ossl_store-file - The store 'file' scheme loader
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
 #include <openssl/store.h>
 
diff --git a/doc/man7/ossl_store.pod b/doc/man7/ossl_store.pod
index 148ceef3eae..68503cd0929 100644
--- a/doc/man7/ossl_store.pod
+++ b/doc/man7/ossl_store.pod
@@ -6,7 +6,7 @@ ossl_store - Store retrieval functions
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
 #include <openssl/store.h>
 
diff --git a/doc/man7/provider-cipher.pod b/doc/man7/provider-cipher.pod
index 2da3aa2a84b..af97735730d 100644
--- a/doc/man7/provider-cipher.pod
+++ b/doc/man7/provider-cipher.pod
@@ -6,7 +6,7 @@ provider-cipher - The cipher library E<lt>-E<gt> provider functions
 
 =head1 SYNOPSIS
 
-=for comment multiple includes
+=for openssl multiple includes
 
  #include <openssl/core_numbers.h>
  #include <openssl/core_names.h>
diff --git a/doc/man7/provider-digest.pod b/doc/man7/provider-digest.pod
index 089c0e2082b..7ee58c2dd62 100644
--- a/doc/man7/provider-digest.pod
+++ b/doc/man7/provider-digest.pod
@@ -6,7 +6,7 @@ provider-digest - The digest library E<lt>-E<gt> provider functions
 
 =head1 SYNOPSIS
 
-=for comment multiple includes
+=for openssl multiple includes
 
  #include <openssl/core_numbers.h>
  #include <openssl/core_names.h>
diff --git a/doc/man7/provider-keyexch.pod b/doc/man7/provider-keyexch.pod
index c4cb0211858..0f7752cf8f7 100644
--- a/doc/man7/provider-keyexch.pod
+++ b/doc/man7/provider-keyexch.pod
@@ -6,7 +6,7 @@ provider-keyexch - The keyexch library E<lt>-E<gt> provider functions
 
 =head1 SYNOPSIS
 
-=for comment multiple includes
+=for openssl multiple includes
 
  #include <openssl/core_numbers.h>
  #include <openssl/core_names.h>
diff --git a/doc/man7/provider-mac.pod b/doc/man7/provider-mac.pod
index 70653e37f37..ef6837426a2 100644
--- a/doc/man7/provider-mac.pod
+++ b/doc/man7/provider-mac.pod
@@ -6,7 +6,7 @@ provider-mac - The mac library E<lt>-E<gt> provider functions
 
 =head1 SYNOPSIS
 
-=for comment multiple includes
+=for openssl multiple includes
 
  #include <openssl/core_numbers.h>
  #include <openssl/core_names.h>
diff --git a/doc/man7/provider-signature.pod b/doc/man7/provider-signature.pod
index 73d573a9f27..fa446737bbe 100644
--- a/doc/man7/provider-signature.pod
+++ b/doc/man7/provider-signature.pod
@@ -6,7 +6,7 @@ provider-signature - The signature library E<lt>-E<gt> provider functions
 
 =head1 SYNOPSIS
 
-=for comment multiple includes
+=for openssl multiple includes
 
  #include <openssl/core_numbers.h>
  #include <openssl/core_names.h>
diff --git a/doc/man7/provider.pod b/doc/man7/provider.pod
index 87a908715af..f13418d0d0b 100644
--- a/doc/man7/provider.pod
+++ b/doc/man7/provider.pod
@@ -6,7 +6,7 @@ provider - OpenSSL operation implementation providers
 
 =head1 SYNOPSIS
 
-=for comment generic
+=for openssl generic
 
 #include <openssl/provider.h>
 
@@ -123,8 +123,6 @@ The number for this operation is B<OSSL_OP_CIPHER>.
 The functions the provider can offer are described in
 L<provider-cipher(7)>
 
-=begin comment NOT AVAILABLE YET
-
 =item Message Authentication Code (MAC)
 
 In the OpenSSL libraries, the corresponding method object is
@@ -133,10 +131,6 @@ The number for this operation is B<OSSL_OP_MAC>.
 The functions the provider can offer are described in
 L<provider-mac(7)>
 
-=end comment
-
-=begin comment NOT AVAILABLE YET
-
 =item Key Derivation Function (KDF)
 
 In the OpenSSL libraries, the corresponding method object is
@@ -145,8 +139,6 @@ The number for this operation is B<OSSL_OP_KDF>.
 The functions the provider can offer are described in
 L<provider-kdf(7)>
 
-=end comment
-
 =item Key Exchange
 
 In the OpenSSL libraries, the corresponding method object is
diff --git a/util/find-doc-nits b/util/find-doc-nits
index eac87dedd0c..30cdd77fe60 100755
--- a/util/find-doc-nits
+++ b/util/find-doc-nits
@@ -444,7 +444,7 @@ sub check {
         check_section_location($id, $contents, "EXAMPLES", "SEE ALSO");
     }
 
-    unless ( $contents =~ /=for comment generic/ ) {
+    unless ( $contents =~ /=for openssl generic/ ) {
         if ( $filename =~ m|man3/| ) {
             name_synopsis($id, $filename, $contents);
             functionname_check($id, $filename, $contents);
@@ -482,7 +482,7 @@ sub check {
     err($id, "Possible version style issue")
         if $contents =~ /OpenSSL version [019]/;
 
-    if ( $contents !~ /=for comment multiple includes/ ) {
+    if ( $contents !~ /=for openssl multiple includes/ ) {
         # Look for multiple consecutive openssl #include lines
         # (non-consecutive lines are okay; see man3/MD5.pod).
         if ( $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms ) {