man-page-check-pod-20070817

Add check-pod script to test for POD syntax errors.
This commit is contained in:
Jason Edgecombe 2007-08-17 20:57:20 +00:00 committed by Russ Allbery
parent 25ace7c2c7
commit a8172fca24
2 changed files with 16 additions and 0 deletions

View File

@ -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

12
doc/man-pages/check-pod Executable file
View File

@ -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 ) );