diff options
author | Rich Salz <rsalz@openssl.org> | 2016-05-20 20:52:46 -0400 |
---|---|---|
committer | Rich Salz <rsalz@openssl.org> | 2016-05-20 20:54:00 -0400 |
commit | 05ea606a2536590e1ef74020056665345f39efa8 (patch) | |
tree | 58dc911e8abe04becb6f1d0a876624073950d911 /util | |
parent | fcb318c64b8c3ff24ec36f99797880386bed5867 (diff) |
Doc nits cleanup, round 2
Fix some code examples, trailing whitespace
Fix TBA sections in verify, remove others.
Remove empty sections
Use Mixed Case not ALL CAPS in head2
Enhance doc-nits script.
Remove extra =cut line
Reviewed-by: Richard Levitte <levitte@openssl.org>
Diffstat (limited to 'util')
-rw-r--r-- | util/doc-nit-check.pl | 62 |
1 files changed, 41 insertions, 21 deletions
diff --git a/util/doc-nit-check.pl b/util/doc-nit-check.pl index f1a7af85ec..3cf260bd28 100644 --- a/util/doc-nit-check.pl +++ b/util/doc-nit-check.pl @@ -1,4 +1,11 @@ #! /usr/bin/env perl +# Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved. +# +# Licensed under the OpenSSL license (the "License"). You may not use +# this file except in compliance with the License. You can obtain a copy +# in the file LICENSE in the source distribution or at +# https://www.openssl.org/source/license.html + require 5.10.0; use warnings; @@ -6,10 +13,11 @@ use strict; use Pod::Checker; use File::Find; +my $temp = '/tmp/docnits.txt'; +my $OUT; + sub check() { - my $errs = 0; - my $contents = ''; { local $/ = undef; @@ -17,26 +25,38 @@ sub check() $contents = <POD>; close POD; } - if ( $contents !~ /^=pod/ ) { - print "$_ doesn't start with =pod\n"; - return 1; - } - if ( $contents !~ /=cut\n$/ ) { - print "$_ doesn't end with =cut\n"; - return 1; - } - if ( $contents !~ /Copyright .* The OpenSSL Project Authors/ ) { - print "$_ missing copyright\n"; - return 1; - } + print $OUT "$_ doesn't start with =pod\n" + if $contents !~ /^=pod/; + print $OUT "$_ doesn't end with =cut\n" + if $contents !~ /=cut\n$/; + print $OUT "$_ more than one cut line.\n" + if $contents =~ /=cut.*=cut/ms; + print $OUT "$_ missing copyright\n" + if $contents !~ /Copyright .* The OpenSSL Project Authors/; + print $OUT "$_ copyright not last\n" + if $contents =~ /head1 COPYRIGHT.*=head/ms; + print $OUT "$_ head2 in All uppercase\n" + if $contents =~ /head2.*[A-Z ]+\n/; + + podchecker($_, $OUT); +} - $errs = podchecker($_, \*STDOUT); - $errs = 1 if $errs < 0; - return $errs; +open $OUT, '>', $temp + or die "Can't open $temp, $!"; +foreach (@ARGV ? @ARGV : glob('*/*.pod')) { + &check($_); } +close $OUT; -my $errs = 0; -foreach (glob('*/*.pod')) { - $errs += &check($_); +my $count = 0; +open $OUT, '<', $temp + or die "Can't read $temp, $!"; +while ( <$OUT> ) { + next if /\(section\) in.*deprecated/; + $count++; + print; } -exit $errs; +close $OUT; +unlink $temp || warn "Can't remove $temp, $!"; + +exit $count; |