From 1bc74519a2a57ef8e67484ca92890fa94d3dd66f Mon Sep 17 00:00:00 2001
From: Rich Salz <rsalz@openssl.org>
Date: Fri, 20 May 2016 08:11:46 -0400
Subject: 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>
---
 util/doc-nit-check.pl | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 util/doc-nit-check.pl

(limited to 'util')

diff --git a/util/doc-nit-check.pl b/util/doc-nit-check.pl
new file mode 100644
index 0000000000..f1a7af85ec
--- /dev/null
+++ b/util/doc-nit-check.pl
@@ -0,0 +1,42 @@
+#! /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;
-- 
cgit v1.2.3