This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Re: [PATCH] Abstract "utility" information from installman
[perl5.git] / installman
CommitLineData
f0512cd0 1#!./perl -w
16d20bd9 2BEGIN { @INC = ('lib') }
f0512cd0 3use strict;
16d20bd9
AD
4use Config;
5use Getopt::Long;
6use File::Find;
354f3b56 7use File::Copy;
356fc125 8use File::Path qw(mkpath);
354f3b56 9use ExtUtils::Packlist;
cd8bccb5 10use subs qw(unlink chmod rename link);
f0512cd0 11use vars qw($packlist @modpods);
16d20bd9
AD
12require Cwd;
13
cd8bccb5 14$ENV{SHELL} = 'sh' if $^O eq 'os2';
16d20bd9 15
f0512cd0
DC
16my $ver = $Config{version}; # Not used presently.
17my $release = substr($],0,3); # Not used presently.
18my $patchlevel = substr($],3,2);
16d20bd9 19die "Patchlevel of perl ($patchlevel)",
cceca5ed
GS
20 "and patchlevel of config.sh ($Config{'PERL_VERSION'}) don't match\n"
21 if $patchlevel != $Config{'PERL_VERSION'};
16d20bd9 22
f0512cd0 23my $usage =
16d20bd9 24"Usage: installman --man1dir=/usr/wherever --man1ext=1
b5f05010 25 --man3dir=/usr/wherever --man3ext=3
f1745d4f 26 --batchlimit=40
eabd589f 27 --notify --verbose --silent --help
16d20bd9
AD
28 Defaults are:
29 man1dir = $Config{'installman1dir'};
30 man1ext = $Config{'man1ext'};
31 man3dir = $Config{'installman3dir'};
32 man3ext = $Config{'man3ext'};
f1745d4f 33 batchlimit is maximum number of pod files per invocation of pod2man
eabd589f
A
34 --notify (or -n) just lists commands that would be executed.
35 --verbose (or -V) report all progress.
36 --silent (or -S) be silent. Only report errors.\n";
16d20bd9 37
f0512cd0
DC
38my %opts;
39GetOptions( \%opts,
f1745d4f 40 qw( man1dir=s man1ext=s man3dir=s man3ext=s batchlimit=i
f0512cd0 41 notify n help silent S verbose V))
16d20bd9 42 || die $usage;
f0512cd0 43die $usage if $opts{help};
16d20bd9 44
f0512cd0
DC
45$opts{man1dir} = $Config{'installman1dir'}
46 unless defined($opts{man1dir});
47$opts{man1ext} = $Config{'man1ext'}
48 unless defined($opts{man1ext});
49$opts{man3dir} = $Config{'installman3dir'}
50 unless defined($opts{man3dir});
51$opts{man3ext} = $Config{'man3ext'}
52 unless defined($opts{man3ext});
f1745d4f 53$opts{batchlimit} ||= 40;
f0512cd0 54$opts{silent} ||= $opts{S};
f0512cd0 55$opts{notify} ||= $opts{n};
4ad019ef 56$opts{verbose} ||= $opts{V} || $opts{notify};
16d20bd9
AD
57
58#Sanity checks
59
cd8bccb5
PP
60-x "./perl$Config{exe_ext}"
61 or warn "./perl$Config{exe_ext} not found! Have you run make?\n";
16d20bd9
AD
62-d $Config{'installprivlib'}
63 || warn "Perl library directory $Config{'installprivlib'} not found.
64 Have you run make install?. (Installing anyway.)\n";
cd8bccb5 65-x "t/perl$Config{exe_ext}" || warn "WARNING: You've never run 'make test'!!!",
16d20bd9
AD
66 " (Installing anyway.)\n";
67
354f3b56
AB
68$packlist = ExtUtils::Packlist->new("$Config{installarchlib}/.packlist");
69
21dae8a0 70
16d20bd9 71# Install the main pod pages.
f0512cd0 72runpod2man('pod', $opts{man1dir}, $opts{man1ext});
16d20bd9
AD
73
74# Install the pods for library modules.
f0512cd0 75runpod2man('lib', $opts{man3dir}, $opts{man3ext});
16d20bd9 76
1fef88e7 77# Install the pods embedded in the installed scripts
21dae8a0
SC
78open UTILS, "utils.lst" or die "Can't open 'utils.lst': $!";
79while (<UTILS>) {
80 next if /^#/;
81 chomp;
82 $_ = $1 if /#.*pod\s*=\s*(\S+)/;
83 my ($where, $what) = m|^(.*)/(.*)|;
84 runpod2man($where, $opts{man1dir}, $opts{man1ext}, $what);
85 if (($where, $what) = /#.*link\s*=\s*(\S+)/) {
86 runpod2man($where, $opts{man1dir}, $opts{man1ext}, $what);
87 }
88}
1fef88e7 89
16d20bd9 90sub runpod2man {
f1745d4f
JH
91 # @script is scripts names if we are installing manpages embedded
92 # in scripts, () otherwise
93 my($poddir, $mandir, $manext, @script) = @_;
1fef88e7
JM
94
95 my($downdir); # can't just use .. when installing xsubpp manpage
96
97 $downdir = $poddir;
98 $downdir =~ s:[^/]+:..:g;
16d20bd9
AD
99 my($builddir) = Cwd::getcwd();
100
101 if ($mandir eq ' ' or $mandir eq '') {
f1745d4f
JH
102 if (@script) {
103 warn "Skipping installation of $poddir/$_ man page.\n"
104 foreach @script;
105 } else {
106 warn "Skipping installation of $poddir man pages.\n";
107 }
16d20bd9
AD
108 return;
109 }
110
f0512cd0 111 print "chdir $poddir\n" if $opts{verbose};
1fef88e7 112 chdir $poddir || die "Unable to cd to $poddir directory!\n$!\n";
16d20bd9
AD
113
114 # We insist on using the current version of pod2man in case there
115 # are enhancements or changes from previous installed versions.
e50aee73
AD
116 # The error message doesn't include the '..' because the user
117 # won't be aware that we've chdir to $poddir.
1fef88e7 118 -r "$downdir/pod/pod2man" || die "Executable pod/pod2man not found.\n";
e50aee73
AD
119
120 # We want to be sure to use the current perl. We can't rely on
121 # the installed perl because it might not be actually installed
122 # yet. (The user may have set the $install* Configure variables
123 # to point to some temporary home, from which the executable gets
124 # installed by occult means.)
f0512cd0 125 my $pod2man = "$downdir/perl -I $downdir/lib $downdir/pod/pod2man --section=$manext --official";
16d20bd9 126
418918ac 127 mkpath($mandir, $opts{verbose}, 0777) unless $opts{notify}; # In File::Path
16d20bd9
AD
128 # Make a list of all the .pm and .pod files in the directory. We will
129 # always run pod2man from the lib directory and feed it the full pathname
130 # of the pod. This might be useful for pod2man someday.
f1745d4f
JH
131 if (@script) {
132 @modpods = @script;
72b3d9b4
GS
133 }
134 else {
1fef88e7 135 @modpods = ();
f0512cd0 136 File::Find::find(\&lsmodpods, '.');
1fef88e7 137 }
f1745d4f 138 my @to_process;
f0512cd0
DC
139 foreach my $mod (@modpods) {
140 my $manpage = $mod;
cd8bccb5
PP
141 my $tmp;
142 # Skip .pm files that have corresponding .pod files, and Functions.pm.
143 next if (($tmp = $mod) =~ s/\.pm$/.pod/ && -f $tmp);
144 next if ($mod eq 'Pod/Functions.pm'); #### Used only by pod itself
145
16d20bd9
AD
146 # Convert name from File/Basename.pm to File::Basename.3 format,
147 # if necessary.
148 $manpage =~ s#\.p(m|od)$##;
4fabb596 149 if ($^O eq 'os2' || $^O eq 'amigaos' || $^O eq 'uwin' || $^O eq 'cygwin') {
cd8bccb5 150 $manpage =~ s#/#.#g;
72b3d9b4
GS
151 }
152 else {
cd8bccb5
PP
153 $manpage =~ s#/#::#g;
154 }
155 $tmp = "${mandir}/${manpage}.tmp";
16d20bd9 156 $manpage = "${mandir}/${manpage}.${manext}";
f1745d4f
JH
157 push @to_process, [$mod, $tmp, $manpage];
158 }
159 # Don't do all pods in same command to avoid busting command line limits
160 while (my @this_batch = splice @to_process, 0, $opts{batchlimit}) {
161 my $cmd = join " ", $pod2man, map "$$_[0] $$_[1]", @this_batch;
162 if (&cmd($cmd) == 0 && !$opts{notify}) {
163 foreach (@this_batch) {
164 my (undef, $tmp, $manpage) = @$_;
165 if (-s $tmp) {
166 if (rename($tmp, $manpage)) {
167 $packlist->{$manpage} = { type => 'file' };
168 next;
169 }
170 }
171 unless ($opts{notify}) {
172 unlink($tmp);
173 }
72b3d9b4 174 }
6d64b06f 175 }
16d20bd9
AD
176 }
177 chdir "$builddir" || die "Unable to cd back to $builddir directory!\n$!\n";
f0512cd0 178 print " chdir $builddir\n" if $opts{verbose};
16d20bd9
AD
179}
180
181sub lsmodpods {
182 my $dir = $File::Find::dir;
183 my $name = $File::Find::name;
184 if (-f $_) {
185 $name =~ s#^\./##;
186 push(@modpods, $name) if ($name =~ /\.p(m|od)$/);
187 }
188}
189
f0512cd0
DC
190$packlist->write() unless $opts{notify};
191print " Installation complete\n" if $opts{verbose};
16d20bd9
AD
192
193exit 0;
194
195
196###############################################################################
197# Utility subroutines from installperl
198
199sub cmd {
f0512cd0
DC
200 my ($cmd) = @_;
201 print " $cmd\n" if $opts{verbose};
202 unless ($opts{notify}) {
b29d8d13
PP
203 if ($Config{d_fork}) {
204 fork ? wait : exec $cmd; # Allow user to ^C out of command.
205 }
206 else {
207 system $cmd;
208 }
cb1a09d0 209 warn "Command failed!!\n" if $?;
16d20bd9 210 }
cb1a09d0 211 return $? != 0;
16d20bd9
AD
212}
213
cd8bccb5 214sub unlink {
f0512cd0 215 my(@names) = @_;
cd8bccb5
PP
216 my $cnt = 0;
217
f0512cd0 218 foreach my $name (@names) {
72b3d9b4
GS
219 next unless -e $name;
220 chmod 0777, $name if $^O eq 'os2';
f0512cd0 221 print " unlink $name\n" if $opts{verbose};
72b3d9b4 222 ( CORE::unlink($name) and ++$cnt
f0512cd0 223 or warn "Couldn't unlink $name: $!\n" ) unless $opts{notify};
cd8bccb5
PP
224 }
225 return $cnt;
226}
227
16d20bd9 228sub link {
354f3b56
AB
229 my($from,$to) = @_;
230 my($success) = 0;
16d20bd9 231
f0512cd0 232 print $opts{verbose} ? " ln $from $to\n" : " $to\n" unless $opts{silent};
354f3b56
AB
233 eval {
234 CORE::link($from, $to)
235 ? $success++
236 : ($from =~ m#^/afs/# || $to =~ m#^/afs/#)
237 ? die "AFS" # okay inside eval {}
238 : warn "Couldn't link $from to $to: $!\n"
f0512cd0 239 unless $opts{notify};
354f3b56
AB
240 };
241 if ($@) {
242 File::Copy::copy($from, $to)
243 ? $success++
244 : warn "Couldn't copy $from to $to: $!\n"
f0512cd0 245 unless $opts{notify};
354f3b56
AB
246 }
247 $success;
cd8bccb5
PP
248}
249
250sub rename {
f0512cd0 251 my($from,$to) = @_;
55a105fd 252 if (-f $to and not unlink($to)) {
72b3d9b4
GS
253 my($i);
254 for ($i = 1; $i < 50; $i++) {
255 last if CORE::rename($to, "$to.$i");
256 }
257 warn("Cannot rename to `$to.$i': $!"), return 0
258 if $i >= 50; # Give up!
cd8bccb5 259 }
55a105fd 260 link($from,$to) || return 0;
261 unlink($from);
16d20bd9
AD
262}
263
264sub chmod {
f0512cd0 265 my($mode,$name) = @_;
16d20bd9 266
f0512cd0 267 printf " chmod %o %s\n", $mode, $name if $opts{verbose};
cd8bccb5 268 CORE::chmod($mode,$name) || warn sprintf("Couldn't chmod %o %s: $!\n",$mode,$name)
f0512cd0 269 unless $opts{notify};
16d20bd9
AD
270}
271
16d20bd9 272sub samepath {
f0512cd0
DC
273 my($p1, $p2) = @_;
274 my($dev1, $ino1, $dev2, $ino2);
16d20bd9
AD
275
276 if ($p1 ne $p2) {
277 ($dev1, $ino1) = stat($p1);
278 ($dev2, $ino2) = stat($p2);
279 ($dev1 == $dev2 && $ino1 == $ino2);
280 }
281 else {
282 1;
283 }
284}