diff options
| author | Paul Yang <yang.yang@baishancloud.com> | 2019-02-26 13:51:02 +0800 |
|---|---|---|
| committer | Dr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> | 2019-04-15 12:26:49 +0200 |
| commit | a345fa370e6acd1293e7370a85266e87dc7ebc38 (patch) | |
| tree | 00aca9788a38773e0930211e952bec1d5d817964 /util | |
| parent | d090fc0019b8ef04bcae8c7eafe98950a9694fc8 (diff) | |
Add section order check in util/find-doc-nits
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>
(cherry picked from commit cc838ee2d66f7295bf7a7e6695aab1080d6791e9)
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
(Merged from https://github.com/openssl/openssl/pull/8736)
Diffstat (limited to 'util')
| -rwxr-xr-x | util/find-doc-nits | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/util/find-doc-nits b/util/find-doc-nits index 860bb9958b..deae76ce0f 100755 --- a/util/find-doc-nits +++ b/util/find-doc-nits @@ -137,6 +137,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; @@ -150,6 +162,8 @@ sub check() close POD; } + &check_example_location($filename, $contents) if $filename =~ m|man3/|; + my $id = "${filename}:1:"; &name_synopsis($id, $filename, $contents) |