This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Merge the refactoring of Pod scanning code in installman and buildtoc.
authorNicholas Clark <nick@ccl4.org>
Sat, 24 Dec 2011 09:30:20 +0000 (10:30 +0100)
committerNicholas Clark <nick@ccl4.org>
Sat, 24 Dec 2011 09:30:20 +0000 (10:30 +0100)
Porting/pod_lib.pl
installman
installperl
pod/buildtoc
utils.lst

index a87c3ee..c86993d 100644 (file)
@@ -2,6 +2,7 @@
 
 use strict;
 use Digest::MD5 'md5';
+use File::Find;
 
 # make it clearer when we haven't run to completion, as we can be quite
 # noisy when things are working ok
@@ -37,6 +38,40 @@ sub write_or_die {
     close $fh or die "Can't close $filename: $!";
 }
 
+sub pods_to_install {
+    # manpages not to be installed
+    my %do_not_install = map { ($_ => 1) }
+        qw(Pod::Functions XS::APItest XS::Typemap);
+
+    my (%done, %found);
+
+    File::Find::find({no_chdir=>1,
+                      wanted => sub {
+                          if (m!/t\z!) {
+                              ++$File::Find::prune;
+                              return;
+                          }
+
+                          # $_ is $File::Find::name when using no_chdir
+                          return unless m!\.p(?:m|od)\z! && -f $_;
+                          return if m!lib/Net/FTP/.+\.pm\z!; # Hi, Graham! :-)
+                          # Skip .pm files that have corresponding .pod files
+                          return if s!\.pm\z!.pod! && -e $_;
+                          s!\.pod\z!!;
+                          s!\Alib/!!;
+                          s!/!::!g;
+
+                          my_die("Duplicate files for $_, '$done{$_}' and '$File::Find::name'")
+                              if exists $done{$_};
+                          $done{$_} = $File::Find::name;
+
+                          return if $do_not_install{$_};
+                          return if is_duplicate_pod($File::Find::name);
+                          $found{/\A[a-z]/ ? 'PRAGMA' : 'MODULE'}{$_}
+                              = $File::Find::name;
+                      }}, 'lib');
+    return \%found;
+}
 
 my %state = (
              # Don't copy these top level READMEs
@@ -181,6 +216,8 @@ sub __prime_state {
         }
     }
     close $master or my_die("close pod/perl.pod: $!");
+    # This has to be special-cased somewhere. Turns out this is cleanest:
+    push @{$state{master}}, ['a2p', 'x2p/a2p.pod', {toc_omit => 1}];
 
     my_die("perl.pod sets flags for unknown pods: "
            . join ' ', sort keys %flag_set)
index 29d73dc..5f0a7a6 100755 (executable)
@@ -8,14 +8,13 @@ BEGIN {
 use strict;
 
 use Getopt::Long;
-use File::Find;
-use File::Path qw(mkpath);
+require File::Path;
 use ExtUtils::Packlist;
 use Pod::Man;
 use vars qw(%opts $packlist);
 
 require './Porting/pod_lib.pl';
-my $state = get_pod_metadata();
+my %man1 = (map {($_->[0], $_->[1])} @{get_pod_metadata()->{master}});
 
 $ENV{SHELL} = 'sh' if $^O eq 'os2';
 
@@ -65,46 +64,24 @@ $opts{verbose} ||= $opts{V} || $opts{notify};
 $packlist = ExtUtils::Packlist->new("$opts{destdir}$Config{installarchlib}/.packlist");
 
 # Install the main pod pages.
-pod2man({
-         map {
-             ($_->[0], $_->[1])
-         } @{$state->{master}}
-        }, $opts{man1dir}, $opts{man1ext}, 'pod');
+pod2man(\%man1, $opts{man1dir}, $opts{man1ext}, 'pod');
 
 # Install the pods for library modules.
 {
-    # manpages not to be installed
-    my %do_not_install = map { ($_ => 1) }
-        qw(Pod/Functions.pm XS/APItest.pm XS/Typemap.pm);
-
-    my %modpods;
-    File::Find::find({no_chdir=>1,
-                      wanted => sub {
-                          # $_ is $File::Find::name when using no_chdir
-                          if (-f $_ and /\.p(?:m|od)$/) {
-                              my $pod = $_;
-                              # Skip .pm files that have corresponding .pod files
-                              return if $pod =~ s/\.pm$/.pod/ && -f $pod;
-                              return if m!(?:^|/)t/!;
-                              s!^lib/!!;
-                              return if $do_not_install{$_};
-                              return if is_duplicate_pod($File::Find::name);
-                              $modpods{$_} = $File::Find::name;
-                          }
-                      }},
-                     'lib');
-
-    pod2man(\%modpods, $opts{man3dir}, $opts{man3ext}, 'lib');
+    my $found = pods_to_install();
+    pod2man($found->{$_}, $opts{man3dir}, $opts{man3ext}, 'lib')
+        foreach qw(MODULE PRAGMA);
 }
 
 # Install the pods embedded in the installed scripts
 my $has_man1dir = $opts{man1dir} ne '' && -d $opts{man1dir};
-open UTILS, "utils.lst" or die "Can't open 'utils.lst': $!";
-while (<UTILS>) {
+my $fh = open_or_die('utils.lst');
+while (<$fh>) {
     next if /^#/;
     chomp;
-    $_ = $1 if /#.*pod\s*=\s*(\S+)/;
     my ($path, $leaf) = m|^(\S*/(\S+))|;
+    # Have we already installed the manpage for this? (eg perldoc, a2p)
+    next if $man1{$leaf};
     pod2man({$leaf, $path}, $opts{man1dir}, $opts{man1ext});
     if ($has_man1dir) {
         if (my ($link) = m|#.*link\s*=\s*\S+/(\S+)|) {
@@ -112,14 +89,13 @@ while (<UTILS>) {
             my $new = "$opts{man1dir}/$link.$opts{man1ext}";
            unlink($new);
            link($old, $new);
-           my $xold = $old;
-           $xold =~ s/^\Q$opts{'destdir'}\E// if $opts{'destdir'};
-           my $xnew = $new;
-           $xnew =~ s/^\Q$opts{'destdir'}\E// if $opts{'destdir'};
-           $packlist->{$xnew} = { from => $xold, type => 'link' };
+            $old =~ s/^\Q$opts{destdir}\E// if $opts{destdir};
+            $new =~ s/^\Q$opts{destdir}\E// if $opts{destdir};
+            $packlist->{$new} = { from => $old, type => 'link' };
        }
     }
 }
+close $fh or my_die("close 'utils.lst': $!");
 
 sub pod2man {
     my($modpods, $mandir, $manext, $where) = @_;
@@ -142,23 +118,24 @@ sub pod2man {
         }
     }
 
-    mkpath($mandir, $opts{verbose}, 0777) unless $opts{notify};  # In File::Path
+    File::Path::mkpath($mandir, $opts{verbose}, 0777) unless $opts{notify};
 
     foreach my $manpage (sort keys %$modpods) {
         my $mod = $modpods->{$manpage};
 
        # Skip files without pod docs
        my $has_pod;
-       if (open T, $mod)
-       {
-           local $_;
-           while (<T>)
-           {
-                ++$has_pod and last if /^=head1\b/;
-           }
-
-           close T;
-       }
+        my $fh = open_or_die($mod);
+        while (my $line = <$fh>) {
+            if ($line =~ /^=head1\b/) {
+                ++$has_pod;
+                last;
+            }
+        }
+       close $fh or my_die("close '$mod': $!");
+        # Sadly it doesn't seem possible to re-use this handle for the call
+        # to parse_from_file() below, as Pod::Man relies on source_filename(),
+        # which Pod::Simple only sets accurately if it opens the file itself.
 
        unless ($has_pod)
        {
@@ -166,14 +143,8 @@ sub pod2man {
            next;
        }
 
-       # Convert name from  File/Basename.pm to File::Basename.3 format,
-       # if necessary.
-       $manpage =~ s#\.p(m|od)$##;
        if ($^O eq 'os2' || $^O eq 'amigaos' || $^O eq 'uwin' || $^O eq 'cygwin') {
-         $manpage =~ s#/#.#g;
-       }
-       else {
-         $manpage =~ s#/#::#g;
+            $manpage =~ s#::#.#g;
        }
         my $tmp = "${mandir}/${manpage}.tmp";
        $manpage = "${mandir}/${manpage}.${manext}";
@@ -200,8 +171,6 @@ sub pod2man {
 $packlist->write() unless $opts{notify};
 print "  Installation complete\n" if $opts{verbose};
 
-exit 0;
-
 sub rename {
     my($from,$to) = @_;
     if (-f $to and not unlink($to)) {
index a67cd6d..67e17da 100755 (executable)
@@ -116,7 +116,6 @@ my (@scripts, @tolink);
 open SCRIPTS, "utils.lst" or die "Can't open utils.lst: $!";
 while (<SCRIPTS>) {
     next if /^#/;
-    s/\s*#\s*pod\s*=.*//; # install script regardless of pod location
     next if /a2p/; # a2p is binary, to be installed separately
     chomp;
     if (/(\S*)\s*#\s*link\s*=\s*(\S*)/) {
index cf17a9a..06307c4 100644 (file)
@@ -1,9 +1,8 @@
 #!/usr/bin/perl -w
 
 use strict;
-use vars qw(%Found $Quiet);
+use vars qw($Quiet);
 use File::Spec;
-use File::Find;
 use FindBin;
 use Text::Wrap;
 use Getopt::Long;
@@ -23,28 +22,9 @@ die "$0: Usage: $0 [--quiet]\n"
 
 my $state = get_pod_metadata(0, sub { warn @_ if @_ }, 'pod/perltoc.pod');
 
-# Find all the modules
-my %done;
-find({no_chdir => 1,
-      wanted => sub {
-          if (/\.p(od|m)$/) {
-              return if m!/Pod/Functions.pm\z!; # Used only by pod itself
-              return if m!(?:^|/)t/!;
-              return if m!lib/Net/FTP/.+\.pm!; # Hi, Graham! :-)
-              return if m!XS/(?:APItest|Typemap)!;
-              return if s!pm\z!pod! && -e $_;
-              s!\.pod\z!!;
-              s!\Alib/!!;
-              s!/!::!g;
-              my_die("Duplicate files for $_, '$done{$_}' and '$File::Find::name'")
-                  if exists $done{$_};
-
-              $done{$_} = $File::Find::name;
-              $Found{/\A[a-z]/ ? 'PRAGMA' : 'MODULE'}{$_} = $File::Find::name;
-          }
-      }}, 'lib');
-
-my_die "Can't find any pods!\n" unless %done;
+my $found = pods_to_install();
+
+my_die "Can't find any pods!\n" unless %$found;
 
 # Accumulating everything into a lexical before writing to disk dates from the
 # time when this script also provided the functionality of regen/pod_rules.pl
@@ -90,10 +70,9 @@ foreach my $type (qw(PRAGMA MODULE)) {
 
 EOPOD2B
 
-    foreach my $name (sort keys %{$Found{$type}}) {
-        next if is_duplicate_pod($Found{$type}{$name});
+    foreach my $name (sort keys %{$found->{$type}}) {
         $roffitall .= "    \$libdir/$name.3 \\\n";
-        podset($name, $Found{$type}{$name});
+        podset($name, $found->{$type}{$name});
     }
 }
 
index 7dd4985..99b85be 100644 (file)
--- a/utils.lst
+++ b/utils.lst
@@ -15,7 +15,7 @@ utils/instmodsh
 utils/json_pp
 utils/libnetcfg
 utils/perlbug  # link = utils/perlthanks
-utils/perldoc   # pod = pod/perldoc.pod
+utils/perldoc
 utils/perlivp
 utils/piconv
 utils/pl2pm
@@ -31,6 +31,6 @@ utils/shasum
 utils/splain
 utils/xsubpp
 utils/zipdetails
-x2p/a2p         # pod = x2p/a2p.pod
+x2p/a2p
 x2p/find2perl
 x2p/s2p         # link = x2p/psed