pod/checkpods.PL

   1 #!/usr/local/bin/perl
   2
   3 use Config;
   4 use File::Basename qw(&basename &dirname);
   5
   6 # List explicitly here the variables you want Configure to
   7 # generate.  Metaconfig only looks for shell variables, so you
   8 # have to mention them as if they were shell variables, not
   9 # %Config entries.  Thus you write
  10 #  $startperl
  11 # to ensure Configure will look for $Config{startperl}.
  12
  13 # This forces PL files to create target in same directory as PL file.
  14 # This is so that make depend always knows where to find PL derivatives.
  15 chdir dirname($0);
  16 $file = basename($0, '.PL');
  17 $file .= '.com' if $^O eq 'VMS';
  18
  19 open OUT,">$file" or die "Can't create $file: $!";
  20
  21 print "Extracting $file (with variable substitutions)\n";
  22
  23 # In this section, perl variables will be expanded during extraction.
  24 # You can use $Config{...} to use Configure variables.
  25
  26 print OUT <<"!GROK!THIS!";
  27 $Config{startperl}
  28     eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
  29         if \$running_under_some_shell;
  30 !GROK!THIS!
  31
  32 # In the following, perl variables are not expanded during extraction.
  33
  34 print OUT <<'!NO!SUBS!';
  35 # From roderick@gate.netThu Sep  5 17:19:30 1996
  36 # Date: Thu, 05 Sep 1996 00:11:22 -0400
  37 # From: Roderick Schertler <roderick@gate.net>
  38 # To: perl5-porters@africa.nicoh.com
  39 # Subject: POD lines with only spaces
  40 #
  41 # There are some places in the documentation where a POD directive is
  42 # ignored because the line before it contains whitespace (and so the
  43 # directive doesn't start a paragraph).  This patch adds a way to check
  44 # for these to the pod Makefile (though it isn't made part of the build
  45 # process, which would be a good idea), and fixes those places where the
  46 # problem currently exists.
  47 #
  48 #  Version 1.00  Original.
  49 #  Version 1.01  Andy Dougherty <doughera@lafcol.lafayette.edu>
  50 #    Trivial modifications to output format for easier auto-parsing
  51 #    Broke it out as a separate function to avoid nasty
  52 #       Make/Shell/Perl quoting problems, and also to make it easier
  53 #       to grow.  Someone will probably want to rewrite in terms of
  54 #       some sort of Pod::Checker module.  Or something.  Consider this
  55 #       a placeholder for the future.
  56 $exit = $last_blank = 0;
  57 while (<>) {
  58     chop;
  59     if (/^(=\S+)/ && $last_blank) {
  60         printf "%s: line %5d, Non-empty line preceeding directive %s\n",
  61                 $ARGV, $., $1;
  62         $exit = 1;
  63     }
  64     $last_blank = /^\s+$/;
  65     if (eof) {
  66         close(ARGV);
  67         $last_blank = 0;
  68     }
  69 }
  70 exit $exit
  71 !NO!SUBS!
  72
  73 close OUT or die "Can't close $file: $!";
  74 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
  75 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';