mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2025-03-19 19:50:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add section order check in util/find-doc-nits

Browse Source 
This patch checks if the EXAMPLES section in a pod file is placed
before the RETURN VALUES section.

Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/8338)
This commit is contained in:
Paul Yang 2019-02-26 13:51:02 +08:00
parent 4564e77ae9
commit cc838ee2d6
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
util/find-doc-nits
View File

@ -142,6 +142,18 @@ sub name_synopsis()
}
}
# Check if EXAMPLES is located after RETURN VALUES section.
sub check_example_location()
{
my $filename = shift;
my $contents = shift;
return unless $contents =~ /=head1 RETURN VALUES/
and $contents =~ /=head1 EXAMPLES/;
print "$filename: RETURN VAULES should be placed before EXAMPLES section\n"
if $contents =~ /=head1 EXAMPLES.*=head1 RETURN VALUES/ms;
}
sub check()
{
my $filename = shift;
@ -155,6 +167,8 @@ sub check()
close POD;
}
&check_example_location($filename, $contents) if $filename =~ m|man3/|;
my $id = "${filename}:1:";
&name_synopsis($id, $filename, $contents)