This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Debian patch that skips podless modules
[perl5.git] / installman
CommitLineData
f0512cd0 1#!./perl -w
e8fcf3b9 2BEGIN { @INC = qw(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;
a2743834 10use Pod::Man;
cd8bccb5 11use subs qw(unlink chmod rename link);
b48e406f 12use vars qw($packlist);
16d20bd9 13
791b4ad3
A
14if ($Config{d_umask}) {
15 umask(022); # umasks like 077 aren't that useful for installations
16}
17
cd8bccb5 18$ENV{SHELL} = 'sh' if $^O eq 'os2';
16d20bd9 19
f0512cd0
DC
20my $ver = $Config{version}; # Not used presently.
21my $release = substr($],0,3); # Not used presently.
22my $patchlevel = substr($],3,2);
16d20bd9 23die "Patchlevel of perl ($patchlevel)",
cceca5ed
GS
24 "and patchlevel of config.sh ($Config{'PERL_VERSION'}) don't match\n"
25 if $patchlevel != $Config{'PERL_VERSION'};
16d20bd9 26
f0512cd0 27my $usage =
16d20bd9 28"Usage: installman --man1dir=/usr/wherever --man1ext=1
b5f05010 29 --man3dir=/usr/wherever --man3ext=3
f1745d4f 30 --batchlimit=40
eabd589f 31 --notify --verbose --silent --help
16d20bd9
AD
32 Defaults are:
33 man1dir = $Config{'installman1dir'};
34 man1ext = $Config{'man1ext'};
35 man3dir = $Config{'installman3dir'};
36 man3ext = $Config{'man3ext'};
eabd589f
A
37 --notify (or -n) just lists commands that would be executed.
38 --verbose (or -V) report all progress.
39 --silent (or -S) be silent. Only report errors.\n";
16d20bd9 40
f0512cd0
DC
41my %opts;
42GetOptions( \%opts,
f1745d4f 43 qw( man1dir=s man1ext=s man3dir=s man3ext=s batchlimit=i
ab33fab8 44 destdir:s notify n help silent S verbose V))
16d20bd9 45 || die $usage;
f0512cd0 46die $usage if $opts{help};
16d20bd9 47
5a9231b0 48$opts{man1dir} = "$opts{destdir}$Config{'installman1dir'}"
f0512cd0
DC
49 unless defined($opts{man1dir});
50$opts{man1ext} = $Config{'man1ext'}
51 unless defined($opts{man1ext});
5a9231b0 52$opts{man3dir} = "$opts{destdir}$Config{'installman3dir'}"
f0512cd0
DC
53 unless defined($opts{man3dir});
54$opts{man3ext} = $Config{'man3ext'}
55 unless defined($opts{man3ext});
56$opts{silent} ||= $opts{S};
f0512cd0 57$opts{notify} ||= $opts{n};
4ad019ef 58$opts{verbose} ||= $opts{V} || $opts{notify};
16d20bd9
AD
59
60#Sanity checks
61
cd8bccb5
PP
62-x "./perl$Config{exe_ext}"
63 or warn "./perl$Config{exe_ext} not found! Have you run make?\n";
5a9231b0 64-d "$opts{destdir}$Config{'installprivlib'}"
16d20bd9
AD
65 || warn "Perl library directory $Config{'installprivlib'} not found.
66 Have you run make install?. (Installing anyway.)\n";
cd8bccb5 67-x "t/perl$Config{exe_ext}" || warn "WARNING: You've never run 'make test'!!!",
16d20bd9
AD
68 " (Installing anyway.)\n";
69
1ef57a5c 70$packlist = ExtUtils::Packlist->new("$opts{destdir}$Config{installarchlib}/.packlist");
354f3b56 71
21dae8a0 72
16d20bd9 73# Install the main pod pages.
a2743834 74pod2man('pod', $opts{man1dir}, $opts{man1ext});
16d20bd9
AD
75
76# Install the pods for library modules.
a2743834 77pod2man('lib', $opts{man3dir}, $opts{man3ext});
16d20bd9 78
1fef88e7 79# Install the pods embedded in the installed scripts
bf1ee2ba 80my $has_man1dir = $opts{man1dir} ne '' && -d $opts{man1dir};
21dae8a0
SC
81open UTILS, "utils.lst" or die "Can't open 'utils.lst': $!";
82while (<UTILS>) {
83 next if /^#/;
84 chomp;
85 $_ = $1 if /#.*pod\s*=\s*(\S+)/;
53fb3a93 86 my ($where, $what) = m|^(\S*)/(\S+)|;
a2743834 87 pod2man($where, $opts{man1dir}, $opts{man1ext}, $what);
bf1ee2ba
JH
88 if ($has_man1dir) {
89 if (my ($where2, $what2) = m|#.*link\s*=\s*(\S+)/(\S+)|) {
90 my $old = "$opts{man1dir}/$what.$opts{man1ext}";
91 my $new = "$opts{man1dir}/$what2.$opts{man1ext}";
92 unlink($new);
93 link($old, $new);
94 }
21dae8a0
SC
95 }
96}
1fef88e7 97
a2743834 98sub pod2man {
f1745d4f
JH
99 # @script is scripts names if we are installing manpages embedded
100 # in scripts, () otherwise
101 my($poddir, $mandir, $manext, @script) = @_;
16d20bd9 102 if ($mandir eq ' ' or $mandir eq '') {
f1745d4f
JH
103 if (@script) {
104 warn "Skipping installation of $poddir/$_ man page.\n"
105 foreach @script;
106 } else {
107 warn "Skipping installation of $poddir man pages.\n";
108 }
16d20bd9
AD
109 return;
110 }
111
b48e406f 112 print "installing from $poddir\n" if $opts{verbose};
16d20bd9 113
418918ac 114 mkpath($mandir, $opts{verbose}, 0777) unless $opts{notify}; # In File::Path
b48e406f
NC
115 # Make a list of all the .pm and .pod files in the directory. We avoid
116 # chdir because we are running with @INC = '../lib', and modules may wish
117 # to dynamically require Carp::Heavy or other diagnostics warnings.
118 # Hash the names of files we find, keys are names relative to perl build
119 # dir ('.'), values are names relative to $poddir.
120 my %modpods;
f1745d4f 121 if (@script) {
b48e406f 122 %modpods = (map {+"$poddir/$_", $_} @script);
72b3d9b4
GS
123 }
124 else {
b48e406f
NC
125 File::Find::find({no_chdir=>1,
126 wanted => sub {
127 # $_ is $File::Find::name when using no_chdir
128 if (-f $_ and /\.p(?:m|od)$/) {
129 my $fullname = $_;
130 s!^\Q$poddir\E/!!;
131 $modpods{$fullname} = $_;
132 }
133 }},
134 $poddir);
1fef88e7 135 }
f1745d4f 136 my @to_process;
b48e406f
NC
137 foreach my $mod (sort keys %modpods) {
138 my $manpage = $modpods{$mod};
cd8bccb5
PP
139 my $tmp;
140 # Skip .pm files that have corresponding .pod files, and Functions.pm.
141 next if (($tmp = $mod) =~ s/\.pm$/.pod/ && -f $tmp);
732876f5 142 next if $mod =~ m:/t/:; # no pods from test directories
b48e406f 143 next if ($manpage eq 'Pod/Functions.pm'); #### Used only by pod itself
cd8bccb5 144
63fae907
AT
145 # Skip files without pod docs
146 my $has_pod;
147 if (open T, $mod)
148 {
149 local $_;
150 while (<T>)
151 {
152 ++$has_pod and last if /^=(?:head\d+|item|pod)\b/;
153 }
154
155 close T;
156 }
157
158 unless ($has_pod)
159 {
160 warn "no documentation in $mod\n";
161 next;
162 }
163
16d20bd9
AD
164 # Convert name from File/Basename.pm to File::Basename.3 format,
165 # if necessary.
166 $manpage =~ s#\.p(m|od)$##;
4fabb596 167 if ($^O eq 'os2' || $^O eq 'amigaos' || $^O eq 'uwin' || $^O eq 'cygwin') {
cd8bccb5 168 $manpage =~ s#/#.#g;
72b3d9b4
GS
169 }
170 else {
cd8bccb5
PP
171 $manpage =~ s#/#::#g;
172 }
173 $tmp = "${mandir}/${manpage}.tmp";
16d20bd9 174 $manpage = "${mandir}/${manpage}.${manext}";
f1745d4f
JH
175 push @to_process, [$mod, $tmp, $manpage];
176 }
a2743834
MS
177
178 my $parser = Pod::Man->new( section => $manext,
179 official=> 1,
180 center => 'Perl Programmers Reference Guide'
181 );
182 foreach my $page (@to_process) {
183 my($pod, $tmp, $manpage) = @$page;
184
5a9231b0
MS
185 my $xmanpage = $manpage;
186 $xmanpage =~ s/^\Q$opts{'destdir'}\E// if $opts{'destdir'};
187 print " $xmanpage\n";
a2743834
MS
188 if (!$opts{notify} && $parser->parse_from_file($pod, $tmp)) {
189 if (-s $tmp) {
190 if (rename($tmp, $manpage)) {
5a9231b0 191 $packlist->{$xmanpage} = { type => 'file' };
a2743834
MS
192 next;
193 }
194 }
195 unlink($tmp);
6d64b06f 196 }
16d20bd9 197 }
16d20bd9
AD
198}
199
f0512cd0
DC
200$packlist->write() unless $opts{notify};
201print " Installation complete\n" if $opts{verbose};
16d20bd9
AD
202
203exit 0;
204
205
206###############################################################################
207# Utility subroutines from installperl
208
cd8bccb5 209sub unlink {
f0512cd0 210 my(@names) = @_;
cd8bccb5
PP
211 my $cnt = 0;
212
f0512cd0 213 foreach my $name (@names) {
72b3d9b4
GS
214 next unless -e $name;
215 chmod 0777, $name if $^O eq 'os2';
f0512cd0 216 print " unlink $name\n" if $opts{verbose};
72b3d9b4 217 ( CORE::unlink($name) and ++$cnt
f0512cd0 218 or warn "Couldn't unlink $name: $!\n" ) unless $opts{notify};
cd8bccb5
PP
219 }
220 return $cnt;
221}
222
16d20bd9 223sub link {
354f3b56
AB
224 my($from,$to) = @_;
225 my($success) = 0;
16d20bd9 226
a2743834 227 print " ln $from $to\n" if $opts{verbose};
354f3b56
AB
228 eval {
229 CORE::link($from, $to)
230 ? $success++
231 : ($from =~ m#^/afs/# || $to =~ m#^/afs/#)
232 ? die "AFS" # okay inside eval {}
233 : warn "Couldn't link $from to $to: $!\n"
f0512cd0 234 unless $opts{notify};
354f3b56
AB
235 };
236 if ($@) {
237 File::Copy::copy($from, $to)
238 ? $success++
239 : warn "Couldn't copy $from to $to: $!\n"
f0512cd0 240 unless $opts{notify};
354f3b56
AB
241 }
242 $success;
cd8bccb5
PP
243}
244
245sub rename {
f0512cd0 246 my($from,$to) = @_;
55a105fd 247 if (-f $to and not unlink($to)) {
72b3d9b4
GS
248 my($i);
249 for ($i = 1; $i < 50; $i++) {
250 last if CORE::rename($to, "$to.$i");
251 }
252 warn("Cannot rename to `$to.$i': $!"), return 0
253 if $i >= 50; # Give up!
cd8bccb5 254 }
55a105fd 255 link($from,$to) || return 0;
256 unlink($from);
16d20bd9
AD
257}
258
259sub chmod {
f0512cd0 260 my($mode,$name) = @_;
16d20bd9 261
f0512cd0 262 printf " chmod %o %s\n", $mode, $name if $opts{verbose};
cd8bccb5 263 CORE::chmod($mode,$name) || warn sprintf("Couldn't chmod %o %s: $!\n",$mode,$name)
f0512cd0 264 unless $opts{notify};
16d20bd9
AD
265}
266
16d20bd9 267sub samepath {
f0512cd0
DC
268 my($p1, $p2) = @_;
269 my($dev1, $ino1, $dev2, $ino2);
16d20bd9
AD
270
271 if ($p1 ne $p2) {
272 ($dev1, $ino1) = stat($p1);
273 ($dev2, $ino2) = stat($p2);
274 ($dev1 == $dev2 && $ino1 == $ino2);
275 }
276 else {
277 1;
278 }
279}