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