diff options
author | Joshua Lock <jlock@vmware.com> | 2019-04-09 14:53:58 +0100 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2019-04-12 15:49:47 +0200 |
commit | 95f92d57755a9bfc83135a585da69d497f7293d9 (patch) | |
tree | 9c5e7cbc055ff5fba4b250485d1c905a96ee1fa8 | |
parent | fd367b4ce37d8f8353deb93fd7677ca636881d81 (diff) |
Make check_example_location() in find-doc-nits generic
Change to check_section_location(), a generic function to ensure that
section SECTION appears before section BEFORE in the man pages.
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/8729)
-rwxr-xr-x | util/find-doc-nits | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/util/find-doc-nits b/util/find-doc-nits index 5d5c2d05b2..1957eeb7a1 100755 --- a/util/find-doc-nits +++ b/util/find-doc-nits @@ -1,5 +1,5 @@ #! /usr/bin/env perl -# Copyright 2002-2018 The OpenSSL Project Authors. All Rights Reserved. +# Copyright 2002-2019 The OpenSSL Project Authors. All Rights Reserved. # # Licensed under the Apache License 2.0 (the "License"). You may not use # this file except in compliance with the License. You can obtain a copy @@ -142,16 +142,18 @@ sub name_synopsis() } } -# Check if EXAMPLES is located after RETURN VALUES section. -sub check_example_location() +# Check if SECTION is located before BEFORE +sub check_section_location() { my $filename = shift; my $contents = shift; + my $section = shift; + my $before = 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; + return unless $contents =~ /=head1 $section/ + and $contents =~ /=head1 $before/; + print "$filename: $section should be placed before $before section\n" + if $contents =~ /=head1 $before.*=head1 $section/ms; } sub check() @@ -167,7 +169,8 @@ sub check() close POD; } - &check_example_location($filename, $contents) if $filename =~ m|man3/|; + # Check if EXAMPLES is located after RETURN VALUES section. + &check_section_location($filename, $contents, "RETURN VALUES", "EXAMPLES") if $filename =~ m|man3/|; my $id = "${filename}:1:"; |