summaryrefslogtreecommitdiffstats
path: root/doc/internal
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2019-09-29 17:10:59 +0200
committerRichard Levitte <levitte@openssl.org>2019-10-11 15:30:57 +0200
commitbb82531f6592f0e9af28d3502346191a465374a3 (patch)
tree325118a87bacbf708d64ffc252eb8efb8cea260c /doc/internal
parent59d0e6c8964c07d7e46c9989735cd1486250b330 (diff)
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/internal')
-rw-r--r--doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod2
-rw-r--r--doc/internal/man3/ossl_param_bld_init.pod2
2 files changed, 2 insertions, 2 deletions
diff --git a/doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod b/doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod
index 7917c4c812..a78193c2e2 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 5179a8d64a..062e2c293c 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"