X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/c07a80fdfe3926b5eb0585b674aa5d1f57b32ade..0fa134633c25c81f88c755a1df2a0e565cac3868:/installman diff --git a/installman b/installman index 13cb75f..c736a9e 100755 --- a/installman +++ b/installman @@ -1,116 +1,209 @@ -#!./perl -BEGIN { @INC = ('lib') } +#!./perl -w +BEGIN { @INC = qw(lib) } +use strict; use Config; use Getopt::Long; use File::Find; +use File::Copy; use File::Path qw(mkpath); -require Cwd; +use ExtUtils::Packlist; +use Pod::Man; +use subs qw(unlink chmod rename link); +use vars qw($packlist); -umask 022; +if ($Config{d_umask}) { + umask(022); # umasks like 077 aren't that useful for installations +} + +$ENV{SHELL} = 'sh' if $^O eq 'os2'; -$ver = $]; -$release = substr($ver,0,3); # Not used presently. -$patchlevel = substr($ver,3,2); +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{'PATCHLEVEL'}) don't match\n" - if $patchlevel != $Config{'PATCHLEVEL'}; + "and patchlevel of config.sh ($Config{'PERL_VERSION'}) don't match\n" + if $patchlevel != $Config{'PERL_VERSION'}; -$usage = +my $usage = "Usage: installman --man1dir=/usr/wherever --man1ext=1 - --man3dir=/usr/wherever --man3ext=3 - --notify --help + --man3dir=/usr/wherever --man3ext=3 + --batchlimit=40 + --notify --verbose --silent --help Defaults are: man1dir = $Config{'installman1dir'}; man1ext = $Config{'man1ext'}; man3dir = $Config{'installman3dir'}; man3ext = $Config{'man3ext'}; - --notify (or -n) just lists commands that would be executed.\n"; + --notify (or -n) just lists commands that would be executed. + --verbose (or -V) report all progress. + --silent (or -S) be silent. Only report errors.\n"; -GetOptions( qw( man1dir=s man1ext=s man3dir=s man3ext=s notify n help)) +my %opts; +GetOptions( \%opts, + 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 $opt_help; - -# These are written funny to avoid -w typo warnings. -$man1dir = defined($opt_man1dir) ? $opt_man1dir : $Config{'installman1dir'}; -$man1ext = defined($opt_man1ext) ? $opt_man1ext : $Config{'man1ext'}; -$man3dir = defined($opt_man3dir) ? $opt_man3dir : $Config{'installman3dir'}; -$man3ext = defined($opt_man3ext) ? $opt_man3ext : $Config{'man3ext'}; +die $usage if $opts{help}; -$notify = $opt_notify || $opt_n; +$opts{man1dir} = "$opts{destdir}$Config{'installman1dir'}" + unless defined($opts{man1dir}); +$opts{man1ext} = $Config{'man1ext'} + unless defined($opts{man1ext}); +$opts{man3dir} = "$opts{destdir}$Config{'installman3dir'}" + unless defined($opts{man3dir}); +$opts{man3ext} = $Config{'man3ext'} + unless defined($opts{man3ext}); +$opts{silent} ||= $opts{S}; +$opts{notify} ||= $opts{n}; +$opts{verbose} ||= $opts{V} || $opts{notify}; #Sanity checks --x "./perl" || warn "./perl not found! Have you run make?\n"; --d $Config{'installprivlib'} +-x "./perl$Config{exe_ext}" + or warn "./perl$Config{exe_ext} not found! Have you run make?\n"; +-d "$opts{destdir}$Config{'installprivlib'}" || warn "Perl library directory $Config{'installprivlib'} not found. Have you run make install?. (Installing anyway.)\n"; --x 't/TEST' || warn "WARNING: You've never run 'make test'!!!", +-x "t/perl$Config{exe_ext}" || warn "WARNING: You've never run 'make test'!!!", " (Installing anyway.)\n"; +$packlist = ExtUtils::Packlist->new("$opts{destdir}$Config{installarchlib}/.packlist"); + + # Install the main pod pages. -runpod2man('pod', $man1dir, $man1ext); +pod2man('pod', $opts{man1dir}, $opts{man1ext}); # Install the pods for library modules. -runpod2man('lib', $man3dir, $man3ext); +pod2man('lib', $opts{man3dir}, $opts{man3ext}); -sub runpod2man { - my($poddir, $mandir, $manext) = @_; - my($builddir) = Cwd::getcwd(); +# 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 () { + 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 '') { - print STDERR "Skipping installation of $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; } - 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. - -x "../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.) - $pod2man = "../perl -I ../lib ../pod/pod2man --section=$manext --official"; - - mkpath($mandir, 1, 0777); # 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. - @modpods = (); - find(\&lsmodpods, '.'); - foreach $mod (@modpods) { - $manpage = $mod; + 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 { + 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 (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 =~ 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 () + { + ++$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. $manpage =~ s#\.p(m|od)$##; - $manpage =~ s#/#::#g; + if ($^O eq 'os2' || $^O eq 'amigaos' || $^O eq 'uwin' || $^O eq 'cygwin') { + $manpage =~ s#/#.#g; + } + else { + $manpage =~ s#/#::#g; + } + $tmp = "${mandir}/${manpage}.tmp"; $manpage = "${mandir}/${manpage}.${manext}"; - &cmd("$pod2man $mod > $manpage"); - if (-z $manpage) { - print STDERR "unlink $manpage\n"; - unless ($notify) { - unlink($manpage) || warn "cannot unlink $manpage: $!"; - } - } + push @to_process, [$mod, $tmp, $manpage]; } - chdir "$builddir" || die "Unable to cd back to $builddir directory!\n$!\n"; -} -sub lsmodpods { - my $dir = $File::Find::dir; - my $name = $File::Find::name; - if (-f $_) { - $name =~ s#^\./##; - push(@modpods, $name) if ($name =~ /\.p(m|od)$/); + my $parser = Pod::Man->new( section => $manext, + official=> 1, + center => 'Perl Programmers Reference Guide' + ); + foreach my $page (@to_process) { + my($pod, $tmp, $manpage) = @$page; + + 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); + } } } -print STDERR " Installation complete\n"; +$packlist->write() unless $opts{notify}; +print " Installation complete\n" if $opts{verbose}; exit 0; @@ -118,39 +211,67 @@ exit 0; ############################################################################### # Utility subroutines from installperl -sub cmd { - local($cmd) = @_; - print STDERR " $cmd\n"; - unless ($notify) { - if ($Config{d_fork}) { - fork ? wait : exec $cmd; # Allow user to ^C out of command. - } - else { - system $cmd; - } - warn "Command failed!!\n" if $?; +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 $? != 0; + return $cnt; } sub link { - local($from,$to) = @_; + my($from,$to) = @_; + my($success) = 0; + + print " ln $from $to\n" if $opts{verbose}; + 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; +} - print STDERR " ln $from $to\n"; - link($from,$to) || warn "Couldn't link $from to $to: $!\n" unless $notify; +sub rename { + my($from,$to) = @_; + if (-f $to and not unlink($to)) { + my($i); + for ($i = 1; $i < 50; $i++) { + last if CORE::rename($to, "$to.$i"); + } + warn("Cannot rename to `$to.$i': $!"), return 0 + if $i >= 50; # Give up! + } + link($from,$to) || return 0; + unlink($from); } sub chmod { - local($mode,$name) = @_; + my($mode,$name) = @_; - printf STDERR " chmod %o %s\n", $mode, $name; - chmod($mode,$name) || warn sprintf("Couldn't chmod %o %s: $!\n",$mode,$name) - unless $notify; + 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 { - local($p1, $p2) = @_; - local($dev1, $ino1, $dev2, $ino2); + my($p1, $p2) = @_; + my($dev1, $ino1, $dev2, $ino2); if ($p1 ne $p2) { ($dev1, $ino1) = stat($p1);