openssl/util/doc-nit-check.pl
Rich Salz 1bc74519a2 Fix nits in pod files.
Add doc-nit-check to help find future issues.
Make podchecker be almost clean.
Remove trailing whitespace.
Tab expansion

Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-20 08:11:46 -04:00

43 lines
805 B
Perl

#! /usr/bin/env perl
require 5.10.0;
use warnings;
use strict;
use Pod::Checker;
use File::Find;
sub check()
{
my $errs = 0;
my $contents = '';
{
local $/ = undef;
open POD, $_ or die "Couldn't open $_, $!";
$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;
}
$errs = podchecker($_, \*STDOUT);
$errs = 1 if $errs < 0;
return $errs;
}
my $errs = 0;
foreach (glob('*/*.pod')) {
$errs += &check($_);
}
exit $errs;