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 # This test is disabled unless RRA_MAINTAINER_TESTS is set, since spelling
   5 # dictionaries vary too much between environments.
   6 #
   7 # The canonical version of this file is maintained in the rra-c-util package,
   8 # which can be found at <http://www.eyrie.org/~eagle/software/rra-c-util/>.
   9 #
  10 # Written by Russ Allbery <eagle@eyrie.org>
  11 # Copyright 2012, 2013
  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 use 5.006;
  33 use strict;
  34 use warnings;
  35
  36 use lib "$ENV{SOURCE}/tap/perl";
  37
  38 use Test::More;
  39 use Test::RRA qw(skip_unless_maintainer use_prereq);
  40 use Test::RRA::Automake qw(automake_setup perl_dirs);
  41
  42 # Only run this test for the maintainer.
  43 skip_unless_maintainer('Spelling tests');
  44
  45 # Load prerequisite modules.
  46 use_prereq('Test::Spelling');
  47
  48 # Set up Automake testing.
  49 automake_setup();
  50
  51 # Run the tests.
  52 all_pod_files_spelling_ok(perl_dirs());