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