diff options
| author | Rich Salz <rsalz@akamai.com> | 2019-08-15 14:26:08 -0400 |
|---|---|---|
| committer | Dr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> | 2019-08-19 00:06:39 +0200 |
| commit | cda774223d9a886ece480f304be40797bb73bcd7 (patch) | |
| tree | 7b14425497412af37bac883dce275d8560915015 /util | |
| parent | 39a117d17963d0cd4a8f3a3351c0844c325e905c (diff) | |
Use EXAMPLES not EXAMPLE for section title
And update find-doc-nits to complain if "=head1 EXAMPLE" is found.
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
(Merged from https://github.com/openssl/openssl/pull/9602)
Diffstat (limited to 'util')
| -rwxr-xr-x | util/find-doc-nits | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/util/find-doc-nits b/util/find-doc-nits index 563a6956a7..690d9405e5 100755 --- a/util/find-doc-nits +++ b/util/find-doc-nits @@ -182,9 +182,9 @@ sub check() # Check ordering of some sections in man3 if ( $filename =~ m|man3/| ) { - &check_section_location($id, $contents, "RETURN VALUES", "EXAMPLE"); + &check_section_location($id, $contents, "RETURN VALUES", "EXAMPLES"); &check_section_location($id, $contents, "SEE ALSO", "HISTORY"); - &check_section_location($id, $contents, "EXAMPLE", "SEE ALSO"); + &check_section_location($id, $contents, "EXAMPLES", "SEE ALSO"); } &name_synopsis($id, $filename, $contents) @@ -197,6 +197,8 @@ sub check() if $contents !~ /=cut\n$/; print "$id more than one cut line.\n" if $contents =~ /=cut.*=cut/ms; + print "$id EXAMPLE not EXAMPLES section.\n" + if $contents =~ /=head1 EXAMPLE[^S]/; print "$id missing copyright\n" if $contents !~ /Copyright .* The OpenSSL Project Authors/; print "$id copyright not last\n" |