xref: /freebsd/contrib/pam-krb5/tests/docs/pod-t (revision 4b15965daa99044daf184221b7c283bf7f2d7e66)
1#!/usr/bin/perl
2#
3# Check all POD documents in the tree, except for any embedded Perl module
4# distribution, for POD formatting errors.
5#
6# The canonical version of this file is maintained in the rra-c-util package,
7# which can be found at <https://www.eyrie.org/~eagle/software/rra-c-util/>.
8#
9# Written by Russ Allbery <eagle@eyrie.org>
10# Copyright 2016, 2019, 2021 Russ Allbery <eagle@eyrie.org>
11# Copyright 2012-2014
12#     The Board of Trustees of the Leland Stanford Junior University
13#
14# Permission is hereby granted, free of charge, to any person obtaining a
15# copy of this software and associated documentation files (the "Software"),
16# to deal in the Software without restriction, including without limitation
17# the rights to use, copy, modify, merge, publish, distribute, sublicense,
18# and/or sell copies of the Software, and to permit persons to whom the
19# Software is furnished to do so, subject to the following conditions:
20#
21# The above copyright notice and this permission notice shall be included in
22# all copies or substantial portions of the Software.
23#
24# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
27# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30# DEALINGS IN THE SOFTWARE.
31#
32# SPDX-License-Identifier: MIT
33
34use 5.010;
35use strict;
36use warnings;
37
38use lib "$ENV{C_TAP_SOURCE}/tap/perl";
39
40use Test::RRA qw(skip_unless_automated use_prereq);
41use Test::RRA::Automake qw(automake_setup perl_dirs);
42
43use Test::More;
44
45# Skip this test for normal user installs, since we normally pre-generate all
46# of the documentation and the end user doesn't care.
47skip_unless_automated('POD syntax tests');
48
49# Load prerequisite modules.
50use_prereq('Test::Pod');
51
52# Set up Automake testing.
53automake_setup();
54
55# Run the tests.
56all_pod_files_ok(perl_dirs());
57