tests/docs/pod-spelling-t

   1 #!/usr/bin/perl
   2 #
   3 # Checks all POD files in the tree for spelling errors using Test::Spelling.
   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 2016, 2019 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
  33 use 5.008;
  34 use strict;
  35 use warnings;
  36
  37 use lib "$ENV{C_TAP_SOURCE}/tap/perl";
  38
  39 use Test::RRA qw(skip_unless_author use_prereq);
  40 use Test::RRA::Automake qw(automake_setup perl_dirs);
  41
  42 use Test::More;
  43
  44 # Only run this test for the module author since the required stopwords are
  45 # too sensitive to the exact spell-checking program and dictionary.
  46 skip_unless_author('Spelling tests');
  47
  48 # Load prerequisite modules.
  49 use_prereq('Test::Spelling');
  50
  51 # Set up Automake testing.
  52 automake_setup();
  53
  54 # Run the tests.
  55 all_pod_files_spelling_ok(perl_dirs());