1#!/usr/bin/perl 2# 3# Check all POD documents for POD formatting errors. 4# 5# The canonical version of this file is maintained in the rra-c-util package, 6# which can be found at <http://www.eyrie.org/~eagle/software/rra-c-util/>. 7# 8# Written by Russ Allbery <eagle@eyrie.org> 9# Copyright 2012, 2013, 2014 10# The Board of Trustees of the Leland Stanford Junior University 11# 12# Permission is hereby granted, free of charge, to any person obtaining a 13# copy of this software and associated documentation files (the "Software"), 14# to deal in the Software without restriction, including without limitation 15# the rights to use, copy, modify, merge, publish, distribute, sublicense, 16# and/or sell copies of the Software, and to permit persons to whom the 17# Software is furnished to do so, subject to the following conditions: 18# 19# The above copyright notice and this permission notice shall be included in 20# all copies or substantial portions of the Software. 21# 22# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 23# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 24# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 25# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 26# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 27# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 28# DEALINGS IN THE SOFTWARE. 29 30use 5.006; 31use strict; 32use warnings; 33 34use lib 't/lib'; 35 36use Test::More; 37use Test::RRA qw(skip_unless_automated use_prereq); 38 39# Skip this test for normal user installs, although pod2man may still fail. 40skip_unless_automated('POD syntax tests'); 41 42# Load prerequisite modules. 43use_prereq('Test::Pod'); 44 45# Check all POD in the Perl distribution. Add the examples directory if it 46# exists. Also add any files in usr/bin or usr/sbin, which are widely used in 47# Stanford-internal packages. 48my @files = all_pod_files(); 49if (-d 'examples') { 50 push(@files, all_pod_files('examples')); 51} 52for my $dir (qw(usr/bin usr/sbin)) { 53 if (-d $dir) { 54 push(@files, glob("$dir/*")); 55 } 56} 57 58# We now have a list of all files to check, so output a plan and run the 59# tests. We can't use all_pod_files_ok because it refuses to check non-Perl 60# files and Stanford-internal packages have a lot of shell scripts with POD 61# documentation. 62plan tests => scalar(@files); 63for my $file (@files) { 64 pod_file_ok($file); 65} 66