From: Jason Edgecombe <jason@rampaginggeek.com>
Date: Fri, 17 Aug 2007 20:57:20 +0000 (+0000)
Subject: man-page-check-pod-20070817
X-Git-Tag: BP-openafs-windows-kdfs-ifs~555
X-Git-Url: http://git.openafs.org/?p=openafs.git;a=commitdiff_plain;h=a8172fca24f91e2b5ab10f66d62d766b7e5d46c1

man-page-check-pod-20070817


Add check-pod script to test for POD syntax errors.
---

diff --git a/doc/man-pages/README b/doc/man-pages/README
index d00c7f0..9d39703 100644
--- a/doc/man-pages/README
+++ b/doc/man-pages/README
@@ -185,6 +185,10 @@ How You Can Help
   the bug number so that I'm aware of it, as I don't always notice new
   bugs.
 
+  You can test your new POD documentation by running the check-pod script
+  in this directory.  (And check other people's documentation and find any
+  problems that have crept in.)
+
 Known Problems
 
   The current man pages have the following known deficiencies.  Please
diff --git a/doc/man-pages/check-pod b/doc/man-pages/check-pod
new file mode 100755
index 0000000..2e0b24c
--- /dev/null
+++ b/doc/man-pages/check-pod
@@ -0,0 +1,12 @@
+#!/usr/bin/perl
+#
+# Written by Jason Edgecombe based on the Test::Pod documentation.  Run
+# it to syntax-check all of the POD files.
+
+use strict;
+use Test::More;
+eval "use Test::Pod 1.00";
+
+plan skip_all => "Test::Pod 1.00 required for testing POD" if $@;
+my @poddirs = qw( pod1 pod5 pod8 );
+all_pod_files_ok( all_pod_files( @poddirs ) );