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