Commit a345fa37 authored by Paul Yang's avatar Paul Yang Committed by Dr. Matthias St. Pierre
Browse files

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: default avatarRichard Levitte <levitte@openssl.org>

(cherry picked from commit cc838ee2d66f7295bf7a7e6695aab1080d6791e9)

Reviewed-by: default avatarMatt Caswell <matt@openssl.org>
Reviewed-by: default avatarMatthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
(Merged from https://github.com/openssl/openssl/pull/8736)
parent d090fc00

util/find-doc-nits

+14 −0
Original line number Diff line number Diff line
@@ -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)