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 /util | |
| parent | 59d0e6c8964c07d7e46c9989735cd1486250b330 (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 'util')
| -rwxr-xr-x | util/find-doc-nits | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/util/find-doc-nits b/util/find-doc-nits index eac87dedd0..30cdd77fe6 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 ) { |