diff options
author | Richard Levitte <levitte@openssl.org> | 2019-09-29 17:10:59 +0200 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2019-10-11 15:30:57 +0200 |
commit | bb82531f6592f0e9af28d3502346191a465374a3 (patch) | |
tree | 325118a87bacbf708d64ffc252eb8efb8cea260c /doc/man7 | |
parent | Add a test for EVP_Digest[Sign|Verify]* with a BIO MD (diff) | |
download | openssl-bb82531f6592f0e9af28d3502346191a465374a3.tar.xz openssl-bb82531f6592f0e9af28d3502346191a465374a3.zip |
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)
Diffstat (limited to 'doc/man7')
-rw-r--r-- | doc/man7/bio.pod | 2 | ||||
-rw-r--r-- | doc/man7/ossl_store-file.pod | 2 | ||||
-rw-r--r-- | doc/man7/ossl_store.pod | 2 | ||||
-rw-r--r-- | doc/man7/provider-cipher.pod | 2 | ||||
-rw-r--r-- | doc/man7/provider-digest.pod | 2 | ||||
-rw-r--r-- | doc/man7/provider-keyexch.pod | 2 | ||||
-rw-r--r-- | doc/man7/provider-mac.pod | 2 | ||||
-rw-r--r-- | doc/man7/provider-signature.pod | 2 | ||||
-rw-r--r-- | doc/man7/provider.pod | 10 |
9 files changed, 9 insertions, 17 deletions
diff --git a/doc/man7/bio.pod b/doc/man7/bio.pod index 63380bce57..bb23e56961 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 d6ea27bedf..d4d163eabb 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 148ceef3ea..68503cd092 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 2da3aa2a84..af97735730 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 089c0e2082..7ee58c2dd6 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 c4cb021185..0f7752cf8f 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 70653e37f3..ef6837426a 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 73d573a9f2..fa446737bb 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 87a908715a..f13418d0d0 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 |