X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/f0512cd0c387bfff77236db8b14da13dd8ece381..f413f3d204974fd3193ffecf439cce9dc8f32ed1:/installman

diff --git a/installman b/installman
index 6ae801d..7665047 100755
--- a/installman
+++ b/installman
@@ -1,20 +1,23 @@
 #!./perl -w
-BEGIN { @INC = ('lib') }
+BEGIN {
+    @INC = qw(lib);
+
+    # This needs to be at BEGIN time, before any use of Config
+    require './install_lib.pl';
+}
 use strict;
-use Config;
+
 use Getopt::Long;
 use File::Find;
 use File::Copy;
 use File::Path qw(mkpath);
 use ExtUtils::Packlist;
-use subs qw(unlink chmod rename link);
-use vars qw($packlist @modpods);
-require Cwd;
+use Pod::Man;
+use vars qw($Is_VMS $Is_W32 $Is_OS2 $Is_Cygwin $Is_Darwin $Is_NetWare
+	    %opts $packlist);
 
 $ENV{SHELL} = 'sh' if $^O eq 'os2';
 
-my $ver = $Config{version};     # Not used presently.
-my $release = substr($],0,3);   # Not used presently.
 my $patchlevel = substr($],3,2);
 die "Patchlevel of perl ($patchlevel)",
     "and patchlevel of config.sh ($Config{'PERL_VERSION'}) don't match\n"
@@ -23,6 +26,7 @@ die "Patchlevel of perl ($patchlevel)",
 my $usage =
 "Usage:  installman --man1dir=/usr/wherever --man1ext=1
                    --man3dir=/usr/wherever --man3ext=3
+		   --batchlimit=40
 	           --notify --verbose --silent --help
 	Defaults are:
 	man1dir = $Config{'installman1dir'};
@@ -33,121 +37,134 @@ my $usage =
         --verbose (or -V) report all progress.
         --silent  (or -S) be silent. Only report errors.\n";
 
-my %opts;
 GetOptions( \%opts,
-            qw( man1dir=s man1ext=s man3dir=s man3ext=s
-                notify n help silent S verbose V)) 
+            qw( man1dir=s man1ext=s man3dir=s man3ext=s batchlimit=i
+                destdir:s notify n help silent S verbose V))
 	|| die $usage;
 die $usage if $opts{help};
+$opts{destdir} //= '';
 
-$opts{man1dir} = $Config{'installman1dir'}
-    unless defined($opts{man1dir}); 
-$opts{man1ext} = $Config{'man1ext'}
-    unless defined($opts{man1ext}); 
-$opts{man3dir} = $Config{'installman3dir'}
-    unless defined($opts{man3dir}); 
-$opts{man3ext} = $Config{'man3ext'}
-    unless defined($opts{man3ext}); 
+foreach my $pre (qw(man1 man3)) {
+    $opts{"${pre}dir"} //= $opts{destdir} . $Config{"install${pre}dir"};
+    $opts{"${pre}ext"} //= $Config{"${pre}ext"};
+}
 $opts{silent} ||= $opts{S};
-$opts{verbose} ||= $opts{V};
-
 $opts{notify} ||= $opts{n};
+$opts{verbose} ||= $opts{V} || $opts{notify};
 
 #Sanity checks
 
--x  "./perl$Config{exe_ext}" 
+-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");
+
+# manpages not to be installed
+my %do_not_install = map { ($_ => 1) } qw(
+    Pod/Functions.pm
+    XS/APItest.pm
+);
 
 # Install the main pod pages.
-runpod2man('pod', $opts{man1dir}, $opts{man1ext});
+pod2man('pod', $opts{man1dir}, $opts{man1ext});
 
 # Install the pods for library modules.
-runpod2man('lib', $opts{man3dir}, $opts{man3ext});
+pod2man('lib', $opts{man3dir}, $opts{man3ext});
 
 # Install the pods embedded in the installed scripts
-runpod2man('utils', $opts{man1dir}, $opts{man1ext}, 'c2ph');
-runpod2man('utils', $opts{man1dir}, $opts{man1ext}, 'h2ph');
-runpod2man('utils', $opts{man1dir}, $opts{man1ext}, 'h2xs');
-runpod2man('utils', $opts{man1dir}, $opts{man1ext}, 'perlcc');
-runpod2man('utils', $opts{man1dir}, $opts{man1ext}, 'perldoc');
-runpod2man('utils', $opts{man1dir}, $opts{man1ext}, 'perlbug');
-runpod2man('utils', $opts{man1dir}, $opts{man1ext}, 'pl2pm');
-runpod2man('utils', $opts{man1dir}, $opts{man1ext}, 'splain');
-runpod2man('utils', $opts{man1dir}, $opts{man1ext}, 'dprofpp');
-runpod2man('x2p', $opts{man1dir}, $opts{man1ext}, 's2p');
-runpod2man('x2p', $opts{man1dir}, $opts{man1ext}, 'a2p.pod');
-runpod2man('x2p', $opts{man1dir}, $opts{man1ext}, 'find2perl');
-runpod2man('pod', $opts{man1dir}, $opts{man1ext}, 'pod2man');
-runpod2man('pod', $opts{man1dir}, $opts{man1ext}, 'pod2html');
-runpod2man('pod', $opts{man1dir}, $opts{man1ext}, 'pod2text');
-runpod2man('pod', $opts{man1dir}, $opts{man1ext}, 'pod2usage');
-runpod2man('pod', $opts{man1dir}, $opts{man1ext}, 'podchecker');
-runpod2man('pod', $opts{man1dir}, $opts{man1ext}, 'podselect');
-
-# It would probably be better to have this page linked
-# to the c2ph man page.  Or, this one could say ".so man1/c2ph.1",
-# but then it would have to pay attention to $opts{man1dir} and $opts{man1ext}.
-runpod2man('utils', $opts{man1dir}, $opts{man1ext}, 'pstruct'); 
-
-runpod2man('lib/ExtUtils', $opts{man1dir}, $opts{man1ext}, 'xsubpp');
-
-sub runpod2man {
-    # $script is script name if we are installing a manpage embedded 
-    # in a script, undef 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();
+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*)/(\S+)|;
+    pod2man($where, $opts{man1dir}, $opts{man1ext}, $what);
+    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' };
+	}
+    }
+}
 
+sub pod2man {
+    # @script is scripts names if we are installing manpages embedded
+    # in scripts, () otherwise
+    my($poddir, $mandir, $manext, @script) = @_;
     if ($mandir eq ' ' or $mandir eq '') {
-	warn "Skipping installation of ",
-	    ($script ? "$poddir/$script man page" : "$poddir man pages"), ".\n";
+	if (@script) {
+	    warn "Skipping installation of $poddir/$_ man page.\n"
+		foreach @script;
+	} else {
+	    warn "Skipping installation of $poddir man pages.\n";
+	}
 	return;
     }
 
-    print "chdir $poddir\n" if $opts{verbose};
-    chdir $poddir || die "Unable to cd to $poddir directory!\n$!\n";
-
-    # We insist on using the current version of pod2man in case there
-    # are enhancements or changes from previous installed versions.
-    # The error message doesn't include the '..' because the user
-    # won't be aware that we've chdir to $poddir.
-    -r  "$downdir/pod/pod2man" || die "Executable pod/pod2man not found.\n";
-
-    # We want to be sure to use the current perl.  We can't rely on
-    # the installed perl because it might not be actually installed
-    # yet. (The user may have set the $install* Configure variables 
-    # to point to some temporary home, from which the executable gets
-    # installed by occult means.)
-    my $pod2man = "$downdir/perl -I $downdir/lib $downdir/pod/pod2man --section=$manext --official";
-
-    mkpath($mandir, 1, 0777) unless $opts{notify};  # In File::Path
-    # Make a list of all the .pm and .pod files in the directory.  We will
-    # always run pod2man from the lib directory and feed it the full pathname
-    # of the pod.  This might be useful for pod2man someday.
-    if ($script) {
-	@modpods = ($script);
+    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 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 = (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);
     }
-    foreach my $mod (@modpods) {
-	my $manpage = $mod;
+    my @to_process;
+    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 $do_not_install{$manpage};
+
+	# 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.
@@ -160,26 +177,28 @@ sub runpod2man {
 	}
 	$tmp = "${mandir}/${manpage}.tmp";
 	$manpage = "${mandir}/${manpage}.${manext}";
-	if (&cmd("$pod2man $mod > $tmp") == 0 && !$opts{notify} && -s $tmp) {
-	    if (rename($tmp, $manpage)) {
-		$packlist->{$manpage} = { type => 'file' };
-		next;
-	    }
-	}
-	unless ($opts{notify}) {
-	    unlink($tmp);
-	}
+	push @to_process, [$mod, $tmp, $manpage];
     }
-    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)$/);
+    foreach my $page (@to_process) {
+	my($pod, $tmp, $manpage) = @$page;
+
+        my $parser = Pod::Man->new( section => $manext,
+                                    official=> 1,
+                                    center  => 'Perl Programmers Reference Guide'
+                                  );
+	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->{$xmanpage} = { type => 'file' };
+                    next;
+                }
+            }
+            unlink($tmp);
+	}
     }
 }
 
@@ -187,61 +206,6 @@ $packlist->write() unless $opts{notify};
 print "  Installation complete\n" if $opts{verbose};
 
 exit 0;
-    
-
-###############################################################################
-# Utility subroutines from installperl
-
-sub cmd {
-    my ($cmd) = @_;
-    print "  $cmd\n" if $opts{verbose};
-    unless ($opts{notify}) {
-	if ($Config{d_fork}) {
-	    fork ? wait : exec $cmd;  # Allow user to ^C out of command.
-	}
-	else {
-	    system $cmd;
-	}
-	warn "Command failed!!\n" if $?;
-    }
-    return $? != 0;
-}
-
-sub unlink {
-    my(@names) = @_;
-    my $cnt = 0;
-
-    foreach my $name (@names) {
-	next unless -e $name;
-	chmod 0777, $name if $^O eq 'os2';
-	print "  unlink $name\n" if $opts{verbose};
-	( CORE::unlink($name) and ++$cnt 
-	    or warn "Couldn't unlink $name: $!\n" ) unless $opts{notify};
-    }
-    return $cnt;
-}
-
-sub link {
-    my($from,$to) = @_;
-    my($success) = 0;
-
-    print $opts{verbose} ? "  ln $from $to\n" : "  $to\n" unless $opts{silent};
-    eval {
-        CORE::link($from, $to)
-            ? $success++
-            : ($from =~ m#^/afs/# || $to =~ m#^/afs/#)
-              ? die "AFS"  # okay inside eval {}
-              : warn "Couldn't link $from to $to: $!\n"
-          unless $opts{notify};
-    };
-    if ($@) {
-        File::Copy::copy($from, $to)
-            ? $success++
-            : warn "Couldn't copy $from to $to: $!\n"
-          unless $opts{notify};
-    }
-    $success;
-}
 
 sub rename {
     my($from,$to) = @_;
@@ -250,31 +214,9 @@ sub rename {
 	for ($i = 1; $i < 50; $i++) {
 	    last if CORE::rename($to, "$to.$i");
 	}
-	warn("Cannot rename to `$to.$i': $!"), return 0 
+	warn("Cannot rename to `$to.$i': $!"), return 0
 	    if $i >= 50;	# Give up!
     }
     link($from,$to) || return 0;
     unlink($from);
 }
-
-sub chmod {
-    my($mode,$name) = @_;
-
-    printf "  chmod %o %s\n", $mode, $name if $opts{verbose};
-    CORE::chmod($mode,$name) || warn sprintf("Couldn't chmod %o %s: $!\n",$mode,$name)
-	unless $opts{notify};
-}
-
-sub samepath {
-    my($p1, $p2) = @_;
-    my($dev1, $ino1, $dev2, $ino2);
-
-    if ($p1 ne $p2) {
-	($dev1, $ino1) = stat($p1);
-	($dev2, $ino2) = stat($p2);
-	($dev1 == $dev2 && $ino1 == $ino2);
-    }
-    else {
-	1;
-    }
-}