From ec48bbc81291befca5dc640d952a2748db547782 Mon Sep 17 00:00:00 2001 From: Jason Edgecombe Date: Sat, 18 Aug 2007 02:42:35 +0000 Subject: [PATCH] DEVEL15-man-page-check-pod-20070817 Add check-pod script to test for POD syntax errors. (cherry picked from commit a8172fca24f91e2b5ab10f66d62d766b7e5d46c1) --- doc/man-pages/README | 4 ++++ doc/man-pages/check-pod | 12 ++++++++++++ 2 files changed, 16 insertions(+) create mode 100755 doc/man-pages/check-pod diff --git a/doc/man-pages/README b/doc/man-pages/README index 8c95486..bbe7ffa 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 ) ); -- 1.9.4