This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
$#a>>=1 relies on malloc wrap to avoid the segfault, so need to
[perl5.git] / installman
index 63b781d..c736a9e 100755 (executable)
@@ -9,8 +9,7 @@ use File::Path qw(mkpath);
 use ExtUtils::Packlist;
 use Pod::Man;
 use subs qw(unlink chmod rename link);
-use vars qw($packlist @modpods);
-require Cwd;
+use vars qw($packlist);
 
 if ($Config{d_umask}) {
     umask(022); # umasks like 077 aren't that useful for installations
@@ -42,15 +41,15 @@ my $usage =
 my %opts;
 GetOptions( \%opts,
             qw( man1dir=s man1ext=s man3dir=s man3ext=s batchlimit=i
-                notify n help silent S verbose V)) 
+                destdir:s notify n help silent S verbose V)) 
        || die $usage;
 die $usage if $opts{help};
 
-$opts{man1dir} = $Config{'installman1dir'}
+$opts{man1dir} = "$opts{destdir}$Config{'installman1dir'}"
     unless defined($opts{man1dir}); 
 $opts{man1ext} = $Config{'man1ext'}
     unless defined($opts{man1ext}); 
-$opts{man3dir} = $Config{'installman3dir'}
+$opts{man3dir} = "$opts{destdir}$Config{'installman3dir'}"
     unless defined($opts{man3dir}); 
 $opts{man3ext} = $Config{'man3ext'}
     unless defined($opts{man3ext}); 
@@ -62,13 +61,13 @@ $opts{verbose} ||= $opts{V} || $opts{notify};
 
 -x  "./perl$Config{exe_ext}" 
   or warn "./perl$Config{exe_ext} not found!  Have you run make?\n";
--d  $Config{'installprivlib'}
+-d  "$opts{destdir}$Config{'installprivlib'}"
        || warn "Perl library directory $Config{'installprivlib'} not found.
                Have you run make install?.  (Installing anyway.)\n";
 -x "t/perl$Config{exe_ext}"            || warn "WARNING: You've never run 'make test'!!!",
        "  (Installing anyway.)\n";
 
-$packlist = ExtUtils::Packlist->new("$Config{installarchlib}/.packlist");
+$packlist = ExtUtils::Packlist->new("$opts{destdir}$Config{installarchlib}/.packlist");
 
 
 # Install the main pod pages.
@@ -78,18 +77,26 @@ pod2man('pod', $opts{man1dir}, $opts{man1ext});
 pod2man('lib', $opts{man3dir}, $opts{man3ext});
 
 # 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>) {
     next if /^#/;
     chomp;
     $_ = $1 if /#.*pod\s*=\s*(\S+)/;
-    my ($where, $what) = m|^(.*?)/(\S+)|;
+    my ($where, $what) = m|^(\S*)/(\S+)|;
     pod2man($where, $opts{man1dir}, $opts{man1ext}, $what);
-    if (my ($where2, $what2) = m|#.*link\s*=\s*(\S+)/(\S+)|) {
-       my $old = "$opts{man1dir}/$what.$opts{man1ext}";
-       my $new = "$opts{man1dir}/$what2.$opts{man1ext}";
-       unlink($new);
-        link($old, $new);
+    if ($has_man1dir) {
+       if (my ($where2, $what2) = m|#.*link\s*=\s*(\S+)/(\S+)|) {
+           my $old = "$opts{man1dir}/$what.$opts{man1ext}";
+           my $new = "$opts{man1dir}/$what2.$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' };
+       }
     }
 }
 
@@ -97,13 +104,6 @@ sub pod2man {
     # @script is scripts names if we are installing manpages embedded 
     # in scripts, () otherwise
     my($poddir, $mandir, $manext, @script) = @_;
-
-    my($downdir); # can't just use .. when installing xsubpp manpage
-
-    $downdir = $poddir;
-    $downdir =~ s:[^/]+:..:g;
-    my($builddir) = Cwd::getcwd();
-
     if ($mandir eq ' ' or $mandir eq '') {
        if (@script) {
            warn "Skipping installation of $poddir/$_ man page.\n"
@@ -114,27 +114,57 @@ sub pod2man {
        return;
     }
 
-    print "chdir $poddir\n" if $opts{verbose};
-    chdir $poddir || die "Unable to cd to $poddir directory!\n$!\n";
+    print "installing from $poddir\n" if $opts{verbose};
 
     mkpath($mandir, $opts{verbose}, 0777) unless $opts{notify};  # In File::Path
-    # Make a list of all the .pm and .pod files in the directory.  We will
-    # always run from the lib directory and use the full pathname
-    # of the pod.
+    # Make a list of all the .pm and .pod files in the directory.  We avoid
+    # chdir because we are running with @INC = '../lib', and modules may wish
+    # to dynamically require Carp::Heavy or other diagnostics warnings.
+    # Hash the names of files we find, keys are names relative to perl build
+    # dir ('.'), values are names relative to $poddir.
+    my %modpods;
     if (@script) {
-       @modpods = @script;
+       %modpods = (map {+"$poddir/$_", $_} @script);
     }
     else {
-       @modpods = ();
-       File::Find::find(\&lsmodpods, '.');
+       File::Find::find({no_chdir=>1,
+                          wanted => sub {
+                              # $_ is $File::Find::name when using no_chdir
+                              if (-f $_ and /\.p(?:m|od)$/) {
+                                  my $fullname = $_;
+                                  s!^\Q$poddir\E/!!;
+                                  $modpods{$fullname} = $_;
+                              }
+                          }},
+                         $poddir);
     }
     my @to_process;
-    foreach my $mod (@modpods) {
-       my $manpage = $mod;
+    foreach my $mod (sort keys %modpods) {
+        my $manpage = $modpods{$mod};
        my $tmp;
        # Skip .pm files that have corresponding .pod files, and Functions.pm.
        next if (($tmp = $mod) =~ s/\.pm$/.pod/ && -f $tmp);
-       next if ($mod eq 'Pod/Functions.pm');   #### Used only by pod itself
+       next if $mod =~ m:/t/:; # no pods from test directories 
+       next if ($manpage eq 'Pod/Functions.pm'); #### Used only by pod itself
+
+       # Skip files without pod docs
+       my $has_pod;
+       if (open T, $mod)
+       {
+           local $_;
+           while (<T>)
+           {
+               ++$has_pod and last if /^=(?:head\d+|item|pod)\b/;
+           }
+
+           close T;
+       }
+
+       unless ($has_pod)
+       {
+           warn "no documentation in $mod\n";
+           next;
+       }
 
        # Convert name from  File/Basename.pm to File::Basename.3 format,
        # if necessary.
@@ -157,28 +187,19 @@ sub pod2man {
     foreach my $page (@to_process) {
        my($pod, $tmp, $manpage) = @$page;
 
-        print "  $manpage\n";
+       my $xmanpage = $manpage;
+       $xmanpage =~ s/^\Q$opts{'destdir'}\E// if $opts{'destdir'};
+        print "  $xmanpage\n";
        if (!$opts{notify} && $parser->parse_from_file($pod, $tmp)) {
             if (-s $tmp) {
                 if (rename($tmp, $manpage)) {
-                    $packlist->{$manpage} = { type => 'file' };
+                    $packlist->{$xmanpage} = { type => 'file' };
                     next;
                 }
             }
             unlink($tmp);
        }
     }
-    chdir "$builddir" || die "Unable to cd back to $builddir directory!\n$!\n";
-    print "  chdir $builddir\n" if $opts{verbose};
-}
-
-sub lsmodpods {
-    my $dir  = $File::Find::dir;
-    my $name = $File::Find::name;
-    if (-f $_) {
-        $name =~ s#^\./##;
-       push(@modpods, $name) if ($name =~ /\.p(m|od)$/);
-    }
 }
 
 $packlist->write() unless $opts{notify};