From 9f3c076b6d5b265d026ff7ed763d406a7e5a2170 Mon Sep 17 00:00:00 2001
From: Rich Salz <rsalz@akamai.com>
Date: Fri, 11 Oct 2019 11:52:12 -0400
Subject: [PATCH] Replace '=for comment ifdef' with '=for openssl'

Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10151)
---
 doc/man1/openssl-ca.pod        |  2 +-
 doc/man1/openssl-ciphers.pod   |  2 +-
 doc/man1/openssl-cms.pod       |  2 +-
 doc/man1/openssl-crl.pod       |  2 +-
 doc/man1/openssl-dhparam.pod   |  2 +-
 doc/man1/openssl-dsa.pod       |  2 +-
 doc/man1/openssl-ec.pod        |  2 +-
 doc/man1/openssl-ecparam.pod   |  2 +-
 doc/man1/openssl-enc.pod       |  2 +-
 doc/man1/openssl-gendsa.pod    |  2 +-
 doc/man1/openssl-genpkey.pod   |  2 +-
 doc/man1/openssl-genrsa.pod    |  2 +-
 doc/man1/openssl-ocsp.pod      |  2 +-
 doc/man1/openssl-passwd.pod    |  2 +-
 doc/man1/openssl-pkcs12.pod    |  2 +-
 doc/man1/openssl-pkcs7.pod     |  2 +-
 doc/man1/openssl-pkcs8.pod     |  2 +-
 doc/man1/openssl-pkey.pod      |  2 +-
 doc/man1/openssl-pkeyparam.pod |  2 +-
 doc/man1/openssl-pkeyutl.pod   |  2 +-
 doc/man1/openssl-rand.pod      |  2 +-
 doc/man1/openssl-req.pod       |  2 +-
 doc/man1/openssl-rsa.pod       |  2 +-
 doc/man1/openssl-rsautl.pod    |  2 +-
 doc/man1/openssl-s_client.pod  | 10 +++++-----
 doc/man1/openssl-s_server.pod  | 10 +++++-----
 doc/man1/openssl-s_time.pod    |  2 +-
 doc/man1/openssl-smime.pod     |  2 +-
 doc/man1/openssl-speed.pod     |  2 +-
 doc/man1/openssl-spkac.pod     |  2 +-
 doc/man1/openssl-srp.pod       |  2 +-
 doc/man1/openssl-ts.pod        |  2 +-
 doc/man1/openssl-verify.pod    |  2 +-
 doc/man1/openssl-x509.pod      |  2 +-
 util/find-doc-nits             |  2 +-
 35 files changed, 43 insertions(+), 43 deletions(-)

diff --git a/doc/man1/openssl-ca.pod b/doc/man1/openssl-ca.pod
index 6f6580cb54..e51e5dda6f 100644
--- a/doc/man1/openssl-ca.pod
+++ b/doc/man1/openssl-ca.pod
@@ -59,7 +59,7 @@ B<openssl> B<ca>
 [B<-sm2-id> I<string>]
 [B<-sm2-hex-id> I<hex-string>]
 
-=for comment ifdef engine sm2-id sm2-hex-id
+=for openssl ifdef engine sm2-id sm2-hex-id
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-ciphers.pod b/doc/man1/openssl-ciphers.pod
index e0fd549b96..ed8e1a95a5 100644
--- a/doc/man1/openssl-ciphers.pod
+++ b/doc/man1/openssl-ciphers.pod
@@ -24,7 +24,7 @@ B<openssl> B<ciphers>
 [B<-ciphersuites> I<val>]
 [I<cipherlist>]
 
-=for comment ifdef ssl3 tls1 tls1_1 tls1_2 tls1_3 psk srp
+=for openssl ifdef ssl3 tls1 tls1_1 tls1_2 tls1_3 psk srp
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-cms.pod b/doc/man1/openssl-cms.pod
index 40ffd0fdde..507490498c 100644
--- a/doc/man1/openssl-cms.pod
+++ b/doc/man1/openssl-cms.pod
@@ -103,7 +103,7 @@ B<openssl> B<cms>
 [B<-subject> I<subj>]
 [I<cert.pem> ...]
 
-=for comment ifdef des-wrap engine
+=for openssl ifdef des-wrap engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-crl.pod b/doc/man1/openssl-crl.pod
index 1dcf6b0bb1..fa29d4b0c4 100644
--- a/doc/man1/openssl-crl.pod
+++ b/doc/man1/openssl-crl.pod
@@ -22,7 +22,7 @@ B<openssl> B<crl>
 [B<-CAfile> I<file>]
 [B<-CApath> I<dir>]
 
-=for comment ifdef hash_old
+=for openssl ifdef hash_old
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-dhparam.pod b/doc/man1/openssl-dhparam.pod
index 01eab5cc91..c7929e8126 100644
--- a/doc/man1/openssl-dhparam.pod
+++ b/doc/man1/openssl-dhparam.pod
@@ -25,7 +25,7 @@ B<openssl dhparam>
 [B<-engine> I<id>]
 [I<numbits>]
 
-=for comment ifdef dsaparam engine
+=for openssl ifdef dsaparam engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-dsa.pod b/doc/man1/openssl-dsa.pod
index 14a95284f1..ef219adaed 100644
--- a/doc/man1/openssl-dsa.pod
+++ b/doc/man1/openssl-dsa.pod
@@ -33,7 +33,7 @@ B<openssl> B<dsa>
 [B<-pubout>]
 [B<-engine> I<id>]
 
-=for comment ifdef pvk-string pvk-weak pvk-none engine
+=for openssl ifdef pvk-string pvk-weak pvk-none engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-ec.pod b/doc/man1/openssl-ec.pod
index 82a33bbe24..d0d54bcb0b 100644
--- a/doc/man1/openssl-ec.pod
+++ b/doc/man1/openssl-ec.pod
@@ -28,7 +28,7 @@ B<openssl> B<ec>
 [B<-check>]
 [B<-engine> I<id>]
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-ecparam.pod b/doc/man1/openssl-ecparam.pod
index 46c0af7f58..e52d1833e1 100644
--- a/doc/man1/openssl-ecparam.pod
+++ b/doc/man1/openssl-ecparam.pod
@@ -27,7 +27,7 @@ B<openssl ecparam>
 [B<-genkey>]
 [B<-engine> I<id>]
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-enc.pod b/doc/man1/openssl-enc.pod
index 327356da1c..99486ee152 100644
--- a/doc/man1/openssl-enc.pod
+++ b/doc/man1/openssl-enc.pod
@@ -39,7 +39,7 @@ B<openssl> B<enc>|I<cipher>
 [B<-writerand> I<file>]
 [B<-engine> I<id>]
 
-=for comment ifdef z engine
+=for openssl ifdef z engine
 
 B<openssl> I<cipher> [B<...>]
 
diff --git a/doc/man1/openssl-gendsa.pod b/doc/man1/openssl-gendsa.pod
index 8fc91cf64c..62fc25089e 100644
--- a/doc/man1/openssl-gendsa.pod
+++ b/doc/man1/openssl-gendsa.pod
@@ -27,7 +27,7 @@ B<openssl> B<gendsa>
 [B<-verbose>]
 [I<paramfile>]
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-genpkey.pod b/doc/man1/openssl-genpkey.pod
index 3fd6bef091..3c2ff77f73 100644
--- a/doc/man1/openssl-genpkey.pod
+++ b/doc/man1/openssl-genpkey.pod
@@ -19,7 +19,7 @@ B<openssl> B<genpkey>
 [B<-genparam>]
 [B<-text>]
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-genrsa.pod b/doc/man1/openssl-genrsa.pod
index 27ca9f7402..2b3c5c303f 100644
--- a/doc/man1/openssl-genrsa.pod
+++ b/doc/man1/openssl-genrsa.pod
@@ -30,7 +30,7 @@ B<openssl> B<genrsa>
 [B<-verbose>]
 [B<numbits>]
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-ocsp.pod b/doc/man1/openssl-ocsp.pod
index 7f6c31fe94..5e75e6af53 100644
--- a/doc/man1/openssl-ocsp.pod
+++ b/doc/man1/openssl-ocsp.pod
@@ -90,7 +90,7 @@ B<openssl> B<ocsp>
 [B<-rcid> I<digest>]
 [B<-I<digest>>]
 
-=for comment ifdef multi
+=for openssl ifdef multi
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-passwd.pod b/doc/man1/openssl-passwd.pod
index 27a5c1bf61..c1daac17ab 100644
--- a/doc/man1/openssl-passwd.pod
+++ b/doc/man1/openssl-passwd.pod
@@ -24,7 +24,7 @@ B<openssl passwd>
 [B<-writerand> I<file>]
 {I<password>}
 
-=for comment ifdef crypt
+=for openssl ifdef crypt
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-pkcs12.pod b/doc/man1/openssl-pkcs12.pod
index af044d5da1..412438285f 100644
--- a/doc/man1/openssl-pkcs12.pod
+++ b/doc/man1/openssl-pkcs12.pod
@@ -44,7 +44,7 @@ B<openssl> B<pkcs12>
 [B<-no-CApath>]
 [B<-CSP> I<name>]
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-pkcs7.pod b/doc/man1/openssl-pkcs7.pod
index b21feeea5f..b11973f206 100644
--- a/doc/man1/openssl-pkcs7.pod
+++ b/doc/man1/openssl-pkcs7.pod
@@ -17,7 +17,7 @@ B<openssl> B<pkcs7>
 [B<-noout>]
 [B<-engine> I<id>]
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-pkcs8.pod b/doc/man1/openssl-pkcs8.pod
index 7015ab9fa3..01c13487b6 100644
--- a/doc/man1/openssl-pkcs8.pod
+++ b/doc/man1/openssl-pkcs8.pod
@@ -30,7 +30,7 @@ B<openssl> B<pkcs8>
 [B<-scrypt_r> I<r>]
 [B<-scrypt_p> I<p>]
 
-=for comment ifdef engine scrypt scrypt_N scrypt_r scrypt_p
+=for openssl ifdef engine scrypt scrypt_N scrypt_r scrypt_p
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-pkey.pod b/doc/man1/openssl-pkey.pod
index 66ec9d17c3..0290ee2662 100644
--- a/doc/man1/openssl-pkey.pod
+++ b/doc/man1/openssl-pkey.pod
@@ -25,7 +25,7 @@ B<openssl> B<pkey>
 [B<-check>]
 [B<-pubcheck>]
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-pkeyparam.pod b/doc/man1/openssl-pkeyparam.pod
index 9b69c7bbf7..36ff7f5245 100644
--- a/doc/man1/openssl-pkeyparam.pod
+++ b/doc/man1/openssl-pkeyparam.pod
@@ -15,7 +15,7 @@ B<openssl> B<pkeyparam>
 [B<-engine> I<id>]
 [B<-check>]
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-pkeyutl.pod b/doc/man1/openssl-pkeyutl.pod
index b614b4af37..6ad2306421 100644
--- a/doc/man1/openssl-pkeyutl.pod
+++ b/doc/man1/openssl-pkeyutl.pod
@@ -38,7 +38,7 @@ B<openssl> B<pkeyutl>
 [B<-engine> I<id>]
 [B<-engine_impl>]
 
-=for comment ifdef engine engine_impl
+=for openssl ifdef engine engine_impl
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-rand.pod b/doc/man1/openssl-rand.pod
index 6ce3326efd..f63859e304 100644
--- a/doc/man1/openssl-rand.pod
+++ b/doc/man1/openssl-rand.pod
@@ -15,7 +15,7 @@ B<openssl rand>
 [B<-hex>]
 I<num>
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-req.pod b/doc/man1/openssl-req.pod
index 13126734a4..13f6257492 100644
--- a/doc/man1/openssl-req.pod
+++ b/doc/man1/openssl-req.pod
@@ -51,7 +51,7 @@ B<openssl> B<req>
 [B<-sm2-id> I<string>]
 [B<-sm2-hex-id> I<hex-string>]
 
-=for comment ifdef engine keygen_engine sm2-id sm2-hex-id
+=for openssl ifdef engine keygen_engine sm2-id sm2-hex-id
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-rsa.pod b/doc/man1/openssl-rsa.pod
index 61a3f267e5..ed6505c138 100644
--- a/doc/man1/openssl-rsa.pod
+++ b/doc/man1/openssl-rsa.pod
@@ -36,7 +36,7 @@ B<openssl> B<rsa>
 [B<-RSAPublicKey_out>]
 [B<-engine> I<id>]
 
-=for comment ifdef pvk-strong pvk-weak pvk-none engine
+=for openssl ifdef pvk-strong pvk-weak pvk-none engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-rsautl.pod b/doc/man1/openssl-rsautl.pod
index 0774b92797..508237364c 100644
--- a/doc/man1/openssl-rsautl.pod
+++ b/doc/man1/openssl-rsautl.pod
@@ -26,7 +26,7 @@ B<openssl> B<rsautl>
 [B<-hexdump>]
 [B<-asn1parse>]
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-s_client.pod b/doc/man1/openssl-s_client.pod
index 598e6836bc..b7021cdf9a 100644
--- a/doc/man1/openssl-s_client.pod
+++ b/doc/man1/openssl-s_client.pod
@@ -139,15 +139,15 @@ B<openssl> B<s_client>
 [B<-enable_pha>]
 [I<host>:I<port>]
 
-=for comment ifdef engine ssl_client_engine ct noct ctlogfile
+=for openssl ifdef engine ssl_client_engine ct noct ctlogfile
 
-=for comment ifdef ssl3 unix 4 6 use_srtp status trace wdebug nextprotoneg
+=for openssl ifdef ssl3 unix 4 6 use_srtp status trace wdebug nextprotoneg
 
-=for comment ifdef ssl3 tls1 tls1_1 tls1_2 tls1_3 dtls mtu dtls1 dtls1_2
+=for openssl ifdef ssl3 tls1 tls1_1 tls1_2 tls1_3 dtls mtu dtls1 dtls1_2
 
-=for comment ifdef sctp_label_bug sctp
+=for openssl ifdef sctp_label_bug sctp
 
-=for comment ifdef srpuser srppass srp_lateuser srp_moregroups srp_strength
+=for openssl ifdef srpuser srppass srp_lateuser srp_moregroups srp_strength
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-s_server.pod b/doc/man1/openssl-s_server.pod
index 4c44db820a..d035f5e4fd 100644
--- a/doc/man1/openssl-s_server.pod
+++ b/doc/man1/openssl-s_server.pod
@@ -185,15 +185,15 @@ B<openssl> B<s_server>
 [B<-no_anti_replay>]
 [B<-http_server_binmode>]
 
-=for comment ifdef unix 4 6 unlink no_dhe nextprotoneg use_srtp engine
+=for openssl ifdef unix 4 6 unlink no_dhe nextprotoneg use_srtp engine
 
-=for comment ifdef status status_verbose status_timeout status_url status_file
+=for openssl ifdef status status_verbose status_timeout status_url status_file
 
-=for comment ifdef psk_hint srpvfile srpuserseed sctp sctp_label_bug
+=for openssl ifdef psk_hint srpvfile srpuserseed sctp sctp_label_bug
 
-=for comment ifdef sctp sctp_label_bug trace mtu timeout listen
+=for openssl ifdef sctp sctp_label_bug trace mtu timeout listen
 
-=for comment ifdef ssl3 tls1 tls1_1 tls1_2 tls1_3 dtls mtu dtls1 dtls1_2
+=for openssl ifdef ssl3 tls1 tls1_1 tls1_2 tls1_3 dtls mtu dtls1 dtls1_2
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-s_time.pod b/doc/man1/openssl-s_time.pod
index edeeb87b69..4af9e84a60 100644
--- a/doc/man1/openssl-s_time.pod
+++ b/doc/man1/openssl-s_time.pod
@@ -30,7 +30,7 @@ B<openssl> B<s_time>
 [B<-cipher> I<cipherlist>]
 [B<-ciphersuites> I<val>]
 
-=for comment ifdef ssl3 tls1 tls1_1 tls1_2 tls1_3
+=for openssl ifdef ssl3 tls1 tls1_1 tls1_2 tls1_3
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-smime.pod b/doc/man1/openssl-smime.pod
index 50fabe3fb1..b8cb7cd635 100644
--- a/doc/man1/openssl-smime.pod
+++ b/doc/man1/openssl-smime.pod
@@ -70,7 +70,7 @@ B<openssl> B<smime>
 [B<-md> I<digest>]
 I<cert.pem> ...
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-speed.pod b/doc/man1/openssl-speed.pod
index fd78872996..d227b0235c 100644
--- a/doc/man1/openssl-speed.pod
+++ b/doc/man1/openssl-speed.pod
@@ -21,7 +21,7 @@ B<openssl speed>
 [B<-bytes> I<num>]
 [I<algorithm> ...]
 
-=for comment ifdef cmac multi async_jobs engine
+=for openssl ifdef cmac multi async_jobs engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-spkac.pod b/doc/man1/openssl-spkac.pod
index 0f26986f92..8de83444c7 100644
--- a/doc/man1/openssl-spkac.pod
+++ b/doc/man1/openssl-spkac.pod
@@ -21,7 +21,7 @@ B<openssl> B<spkac>
 [B<-verify>]
 [B<-engine> I<id>]
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-srp.pod b/doc/man1/openssl-srp.pod
index d25867a36b..9096499750 100644
--- a/doc/man1/openssl-srp.pod
+++ b/doc/man1/openssl-srp.pod
@@ -22,7 +22,7 @@ B<openssl srp>
 [B<-passout> I<arg>]
 [I<user> ...]
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-ts.pod b/doc/man1/openssl-ts.pod
index 2e095d4d13..1f7a0b7341 100644
--- a/doc/man1/openssl-ts.pod
+++ b/doc/man1/openssl-ts.pod
@@ -82,7 +82,7 @@ I<verify options:>
 [B<-verify_name> I<name>]
 [B<-x509_strict>]
 
-=for comment ifdef engine
+=for openssl ifdef engine
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-verify.pod b/doc/man1/openssl-verify.pod
index d795afca5d..63277949e1 100644
--- a/doc/man1/openssl-verify.pod
+++ b/doc/man1/openssl-verify.pod
@@ -54,7 +54,7 @@ B<openssl> B<verify>
 [B<-->]
 [I<certificate> ...]
 
-=for comment ifdef engine sm2-id sm2-hex-id
+=for openssl ifdef engine sm2-id sm2-hex-id
 
 =head1 DESCRIPTION
 
diff --git a/doc/man1/openssl-x509.pod b/doc/man1/openssl-x509.pod
index b4d41df3b2..731cb61344 100644
--- a/doc/man1/openssl-x509.pod
+++ b/doc/man1/openssl-x509.pod
@@ -68,7 +68,7 @@ B<openssl> B<x509>
 [B<-engine> I<id>]
 [B<-preserve_dates>]
 
-=for comment ifdef engine subject_hash_old issuer_hash_old
+=for openssl ifdef engine subject_hash_old issuer_hash_old
 
 =head1 DESCRIPTION
 
diff --git a/util/find-doc-nits b/util/find-doc-nits
index 30cdd77fe6..576eac2cb7 100755
--- a/util/find-doc-nits
+++ b/util/find-doc-nits
@@ -789,7 +789,7 @@ sub checkflags {
     while ( <CFH> ) {
         chop;
         last if /DESCRIPTION/;
-        if ( /=for comment ifdef (.*)/ ) {
+        if ( /=for openssl ifdef (.*)/ ) {
             foreach my $f ( split / /, $1 ) {
                 $localskips{$f} = 1;
             }
-- 
2.25.1