Commit | Line | Data |
---|---|---|
d7816c47 NC |
1 | #!/usr/bin/perl -w |
2 | ||
3 | use strict; | |
449e2f79 | 4 | use Digest::MD5 'md5'; |
9bbb230a | 5 | use File::Find; |
d7816c47 NC |
6 | |
7 | # make it clearer when we haven't run to completion, as we can be quite | |
8 | # noisy when things are working ok | |
9 | ||
10 | sub my_die { | |
11 | print STDERR "$0: ", @_; | |
12 | print STDERR "\n" unless $_[-1] =~ /\n\z/; | |
13 | print STDERR "ABORTED\n"; | |
14 | exit 255; | |
15 | } | |
16 | ||
17 | sub open_or_die { | |
18 | my $filename = shift; | |
19 | open my $fh, '<', $filename or my_die "Can't open $filename: $!"; | |
20 | return $fh; | |
21 | } | |
22 | ||
bcfe7366 NC |
23 | sub slurp_or_die { |
24 | my $filename = shift; | |
25 | my $fh = open_or_die($filename); | |
26 | binmode $fh; | |
27 | local $/; | |
28 | my $contents = <$fh>; | |
29 | die "Can't read $filename: $!" unless defined $contents and close $fh; | |
30 | return $contents; | |
31 | } | |
32 | ||
33 | sub write_or_die { | |
34 | my ($filename, $contents) = @_; | |
35 | open my $fh, '>', $filename or die "Can't open $filename for writing: $!"; | |
36 | binmode $fh; | |
37 | print $fh $contents or die "Can't write to $filename: $!"; | |
38 | close $fh or die "Can't close $filename: $!"; | |
39 | } | |
40 | ||
9bbb230a NC |
41 | sub pods_to_install { |
42 | # manpages not to be installed | |
43 | my %do_not_install = map { ($_ => 1) } | |
44 | qw(Pod::Functions XS::APItest XS::Typemap); | |
45 | ||
46 | my (%done, %found); | |
47 | ||
48 | File::Find::find({no_chdir=>1, | |
49 | wanted => sub { | |
65e5b016 NC |
50 | if (m!/t\z!) { |
51 | ++$File::Find::prune; | |
52 | return; | |
53 | } | |
54 | ||
9bbb230a NC |
55 | # $_ is $File::Find::name when using no_chdir |
56 | return unless m!\.p(?:m|od)\z! && -f $_; | |
9bbb230a NC |
57 | return if m!lib/Net/FTP/.+\.pm\z!; # Hi, Graham! :-) |
58 | # Skip .pm files that have corresponding .pod files | |
59 | return if s!\.pm\z!.pod! && -e $_; | |
60 | s!\.pod\z!!; | |
61 | s!\Alib/!!; | |
62 | s!/!::!g; | |
63 | ||
64 | my_die("Duplicate files for $_, '$done{$_}' and '$File::Find::name'") | |
65 | if exists $done{$_}; | |
66 | $done{$_} = $File::Find::name; | |
67 | ||
68 | return if $do_not_install{$_}; | |
69 | return if is_duplicate_pod($File::Find::name); | |
70 | $found{/\A[a-z]/ ? 'PRAGMA' : 'MODULE'}{$_} | |
71 | = $File::Find::name; | |
72 | }}, 'lib'); | |
73 | return \%found; | |
74 | } | |
9887f448 NC |
75 | |
76 | my %state = ( | |
77 | # Don't copy these top level READMEs | |
78 | ignore => { | |
79 | micro => 1, | |
80 | # vms => 1, | |
81 | }, | |
82 | ); | |
83 | ||
4027e27b NC |
84 | { |
85 | my (%Lengths, %MD5s); | |
86 | ||
87 | sub is_duplicate_pod { | |
88 | my $file = shift; | |
89 | ||
90 | # Initialise the list of possible source files on the first call. | |
91 | unless (%Lengths) { | |
92 | __prime_state() unless $state{master}; | |
93 | foreach (@{$state{master}}) { | |
2ce3647c | 94 | next unless $_->[2]{dual}; |
4027e27b NC |
95 | # This is a dual-life perl*.pod file, which will have be copied |
96 | # to lib/ by the build process, and hence also found there. | |
97 | # These are the only pod files that might become duplicated. | |
2ce3647c NC |
98 | ++$Lengths{-s $_->[1]}; |
99 | ++$MD5s{md5(slurp_or_die($_->[1]))}; | |
4027e27b NC |
100 | } |
101 | } | |
102 | ||
103 | # We are a file in lib. Are we a duplicate? | |
104 | # Don't bother calculating the MD5 if there's no interesting file of | |
105 | # this length. | |
106 | return $Lengths{-s $file} && $MD5s{md5(slurp_or_die($file))}; | |
107 | } | |
449e2f79 NC |
108 | } |
109 | ||
9887f448 | 110 | sub __prime_state { |
d7816c47 NC |
111 | my $source = 'perldelta.pod'; |
112 | my $filename = "pod/$source"; | |
64587559 | 113 | my $contents = slurp_or_die($filename); |
d7816c47 | 114 | my @want = |
bcfe7366 | 115 | $contents =~ /perldelta - what is new for perl v(5)\.(\d+)\.(\d+)\n/; |
d7816c47 | 116 | die "Can't extract version from $filename" unless @want; |
0aef0fe5 NC |
117 | my $delta_leaf = join '', 'perl', @want, 'delta'; |
118 | $state{delta_target} = "$delta_leaf.pod"; | |
bcfe7366 | 119 | $state{delta_version} = \@want; |
d7816c47 NC |
120 | |
121 | # This way round so that keys can act as a MANIFEST skip list | |
122 | # Targets will always be in the pod directory. Currently we can only cope | |
123 | # with sources being in the same directory. | |
124 | $state{copies}{$state{delta_target}} = $source; | |
125 | ||
0aef0fe5 NC |
126 | # The default flags if none explicitly set for the current file. |
127 | my $current_flags = ''; | |
128 | my (%flag_set, @paths); | |
d7816c47 | 129 | |
0aef0fe5 NC |
130 | my $master = open_or_die('pod/perl.pod'); |
131 | ||
132 | while (<$master>) { | |
133 | last if /^=begin buildtoc$/; | |
134 | } | |
135 | die "Can't find '=begin buildtoc':" if eof $master; | |
136 | ||
137 | while (<$master>) { | |
138 | next if /^$/ or /^#/; | |
139 | last if /^=end buildtoc/; | |
140 | my ($command, @args) = split ' '; | |
141 | if ($command eq 'flag') { | |
142 | # For the named pods, use these flags, instead of $current_flags | |
143 | my $flags = shift @args; | |
144 | my_die("Malformed flag $flags") | |
145 | unless $flags =~ /\A=([a-z]*)\z/; | |
146 | $flag_set{$_} = $1 foreach @args; | |
147 | } elsif ($command eq 'path') { | |
148 | # If the pod's name matches the regex, prepend the given path. | |
149 | my_die("Malformed path for /$args[0]/") | |
150 | unless @args == 2; | |
151 | push @paths, [qr/\A$args[0]\z/, $args[1]]; | |
152 | } elsif ($command eq 'aux') { | |
153 | # The contents of perltoc.pod's "AUXILIARY DOCUMENTATION" section | |
4e604983 | 154 | $state{aux} = [sort @args]; |
0aef0fe5 NC |
155 | } else { |
156 | my_die("Unknown buildtoc command '$command'"); | |
157 | } | |
158 | } | |
d7816c47 NC |
159 | |
160 | foreach (<$master>) { | |
0aef0fe5 NC |
161 | next if /^$/ or /^#/; |
162 | next if /^=head2/; | |
163 | last if /^=for buildtoc __END__$/; | |
164 | ||
165 | if (my ($action, $flags) = /^=for buildtoc flag ([-+])([a-z]+)/) { | |
166 | if ($action eq '+') { | |
167 | $current_flags .= $flags; | |
168 | } else { | |
169 | my_die("Attempt to unset [$flags] failed - flags are '$current_flags") | |
170 | unless $current_flags =~ s/[\Q$flags\E]//g; | |
171 | } | |
172 | } elsif (my ($leafname, $desc) = /^\s+(\S+)\s+(.*)/) { | |
173 | my $podname = $leafname; | |
174 | my $filename = "pod/$podname.pod"; | |
175 | foreach (@paths) { | |
176 | my ($re, $path) = @$_; | |
177 | if ($leafname =~ $re) { | |
178 | $podname = $path . $leafname; | |
179 | $filename = "$podname.pod"; | |
180 | last; | |
181 | } | |
182 | } | |
183 | ||
184 | # Keep this compatible with pre-5.10 | |
185 | my $flags = delete $flag_set{$leafname}; | |
186 | $flags = $current_flags unless defined $flags; | |
187 | ||
188 | my %flags; | |
d7816c47 | 189 | $flags{toc_omit} = 1 if $flags =~ tr/o//d; |
dc437300 | 190 | $flags{dual} = $podname ne $leafname; |
d7816c47 NC |
191 | |
192 | $state{generated}{"$podname.pod"}++ if $flags =~ tr/g//d; | |
193 | ||
194 | if ($flags =~ tr/r//d) { | |
195 | my $readme = $podname; | |
196 | $readme =~ s/^perl//; | |
64587559 | 197 | $state{readmes}{$readme} = $desc; |
d7816c47 | 198 | $flags{readme} = 1; |
d7816c47 NC |
199 | } else { |
200 | $state{pods}{$podname} = $desc; | |
201 | } | |
202 | my_die "Unknown flag found in section line: $_" if length $flags; | |
449e2f79 | 203 | |
d7816c47 | 204 | push @{$state{master}}, |
2ce3647c | 205 | [$leafname, $filename, \%flags]; |
0aef0fe5 NC |
206 | |
207 | if ($podname eq 'perldelta') { | |
208 | local $" = '.'; | |
0aef0fe5 | 209 | push @{$state{master}}, |
2ce3647c | 210 | [$delta_leaf, "pod/$state{delta_target}"]; |
dc437300 | 211 | $state{pods}{$delta_leaf} = "Perl changes in version @want"; |
0aef0fe5 NC |
212 | } |
213 | ||
d7816c47 | 214 | } else { |
0aef0fe5 | 215 | my_die("Malformed line: $_"); |
d7816c47 NC |
216 | } |
217 | } | |
0aef0fe5 | 218 | close $master or my_die("close pod/perl.pod: $!"); |
e1aae8e4 NC |
219 | # This has to be special-cased somewhere. Turns out this is cleanest: |
220 | push @{$state{master}}, ['a2p', 'x2p/a2p.pod', {toc_omit => 1}]; | |
0aef0fe5 NC |
221 | |
222 | my_die("perl.pod sets flags for unknown pods: " | |
223 | . join ' ', sort keys %flag_set) | |
224 | if keys %flag_set; | |
9887f448 NC |
225 | } |
226 | ||
227 | sub get_pod_metadata { | |
228 | # Do we expect to find generated pods on disk? | |
229 | my $permit_missing_generated = shift; | |
230 | # Do they want a consistency report? | |
231 | my $callback = shift; | |
d7816c47 | 232 | |
9887f448 | 233 | __prime_state() unless $state{master}; |
d4c6b7ae NC |
234 | return \%state unless $callback; |
235 | ||
9887f448 NC |
236 | my %BuildFiles; |
237 | ||
238 | foreach my $path (@_) { | |
239 | $path =~ m!([^/]+)$!; | |
240 | ++$BuildFiles{$1}; | |
241 | } | |
242 | ||
d7816c47 NC |
243 | # Sanity cross check |
244 | ||
0aef0fe5 | 245 | my (%disk_pods, %manipods, %manireadmes); |
852355fc | 246 | my (%cpanpods, %cpanpods_leaf); |
d7816c47 NC |
247 | my (%our_pods); |
248 | ||
249 | # These are stub files for deleted documents. We don't want them to show up | |
250 | # in perl.pod, they just exist so that if someone types "perldoc perltoot" | |
251 | # they get some sort of pointer to the new docs. | |
252 | my %ignoredpods | |
253 | = map { ( "$_.pod" => 1 ) } qw( perlboot perlbot perltooc perltoot ); | |
254 | ||
255 | # Convert these to a list of filenames. | |
64587559 NC |
256 | ++$our_pods{"$_.pod"} foreach keys %{$state{pods}}; |
257 | foreach (@{$state{master}}) { | |
2ce3647c NC |
258 | ++$our_pods{"$_->[0].pod"} |
259 | if $_->[2]{readme}; | |
d7816c47 NC |
260 | } |
261 | ||
262 | opendir my $dh, 'pod'; | |
263 | while (defined ($_ = readdir $dh)) { | |
264 | next unless /\.pod\z/; | |
d7816c47 NC |
265 | ++$disk_pods{$_}; |
266 | } | |
267 | ||
268 | # Things we copy from won't be in perl.pod | |
269 | # Things we copy to won't be in MANIFEST | |
270 | ||
271 | my $mani = open_or_die('MANIFEST'); | |
272 | while (<$mani>) { | |
273 | chomp; | |
274 | s/\s+.*$//; | |
275 | if (m!^pod/([^.]+\.pod)!i) { | |
6fdb59a5 | 276 | ++$manipods{$1}; |
d7816c47 NC |
277 | } elsif (m!^README\.(\S+)!i) { |
278 | next if $state{ignore}{$1}; | |
6fdb59a5 | 279 | ++$manireadmes{"perl$1.pod"}; |
d7816c47 | 280 | } elsif (exists $our_pods{$_}) { |
852355fc NC |
281 | ++$cpanpods{$_}; |
282 | m!([^/]+)$!; | |
283 | ++$cpanpods_leaf{$1}; | |
d7816c47 NC |
284 | $disk_pods{$_}++ |
285 | if -e $_; | |
286 | } | |
287 | } | |
288 | close $mani or my_die "close MANIFEST: $!\n"; | |
289 | ||
c26a697b NC |
290 | # Are we running before known generated files have been generated? |
291 | # (eg in a clean checkout) | |
292 | my %not_yet_there; | |
293 | if ($permit_missing_generated) { | |
294 | # If so, don't complain if these files aren't yet in place | |
295 | %not_yet_there = (%manireadmes, %{$state{generated}}, %{$state{copies}}) | |
296 | } | |
297 | ||
d7816c47 NC |
298 | my @inconsistent; |
299 | foreach my $i (sort keys %disk_pods) { | |
300 | push @inconsistent, "$0: $i exists but is unknown by buildtoc\n" | |
301 | unless $our_pods{$i}; | |
302 | push @inconsistent, "$0: $i exists but is unknown by MANIFEST\n" | |
9e241592 NC |
303 | if !$BuildFiles{'MANIFEST'} # Ignore if we're rebuilding MANIFEST |
304 | && !$manipods{$i} && !$manireadmes{$i} && !$state{copies}{$i} | |
305 | && !$state{generated}{$i} && !$cpanpods{$i}; | |
d7816c47 NC |
306 | } |
307 | foreach my $i (sort keys %our_pods) { | |
308 | push @inconsistent, "$0: $i is known by buildtoc but does not exist\n" | |
c26a697b | 309 | unless $disk_pods{$i} or $BuildFiles{$i} or $not_yet_there{$i}; |
d7816c47 | 310 | } |
9e241592 NC |
311 | unless ($BuildFiles{'MANIFEST'}) { |
312 | # Again, ignore these if we're about to rebuild MANIFEST | |
313 | foreach my $i (sort keys %manipods) { | |
314 | push @inconsistent, "$0: $i is known by MANIFEST but does not exist\n" | |
315 | unless $disk_pods{$i}; | |
316 | push @inconsistent, "$0: $i is known by MANIFEST but is marked as generated\n" | |
317 | if $state{generated}{$i}; | |
318 | } | |
d7816c47 | 319 | } |
d4c6b7ae | 320 | &$callback(@inconsistent); |
d7816c47 NC |
321 | return \%state; |
322 | } | |
323 | ||
324 | 1; | |
325 | ||
326 | # Local variables: | |
327 | # cperl-indent-level: 4 | |
328 | # indent-tabs-mode: nil | |
329 | # End: | |
330 | # | |
331 | # ex: set ts=8 sts=4 sw=4 et: |