diff options
author | Nicholas Clark <nick@ccl4.org> | 2009-04-18 13:21:05 +0100 |
---|---|---|
committer | Nicholas Clark <nick@ccl4.org> | 2009-04-18 13:21:22 +0100 |
commit | 7b73ff9889742cfd1d8c92116386d655caecafb7 (patch) | |
tree | 5f75b5cefed15b0e94ac679e6abd5f0c87eb1cfc /autodoc.pl | |
parent | 3dc608da20ed2bfc3a3adc9459ee35d5fa2839b3 (diff) | |
download | perl-7b73ff9889742cfd1d8c92116386d655caecafb7.tar.gz |
As autodoc.pl no longer rebuilds repository files, no need to use regen_lib.pl
Refactor the duplicated logic for opening, generating and closing files into
a single output() subroutine.
Diffstat (limited to 'autodoc.pl')
-rw-r--r-- | autodoc.pl | 80 |
1 files changed, 23 insertions, 57 deletions
diff --git a/autodoc.pl b/autodoc.pl index 502f6ab93c..4cccc354db 100644 --- a/autodoc.pl +++ b/autodoc.pl @@ -1,13 +1,5 @@ #!/usr/bin/perl -w -require 5.003; # keep this compatible, an old perl is all we may have before - # we build the new one - -BEGIN { - push @INC, 'lib'; - require 'regen_lib.pl'; -} - use strict; # @@ -99,9 +91,12 @@ removed without notice.\n\n" if $flags =~ /x/; print $fh "=for hackers\nFound in file $file\n\n"; } -sub readonly_header (*) { - my $fh = shift; - print $fh <<"_EOH_"; +sub output { + my ($podname, $header, $dochash, $footer) = @_; + my $filename = "pod/$podname.pod"; + open my $fh, '>', $filename or die "Can't open $filename: $!"; + + print $fh <<"_EOH_", $header; -*- buffer-read-only: t -*- !!!!!!! DO NOT EDIT THIS FILE !!!!!!! @@ -109,15 +104,26 @@ This file is built by $0 extracting documentation from the C source files. _EOH_ -} -sub readonly_footer (*) { - my $fh = shift; - print $fh <<'_EOF_'; + my $key; + # case insensitive sort, with fallback for determinacy + for $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %$dochash) { + my $section = $dochash->{$key}; + print $fh "\n=head1 $key\n\n=over 8\n\n"; + # Again, fallback for determinacy + for my $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %$section) { + docout($fh, $key, $section->{$key}); + } + print $fh "\n=back\n"; + } + + print $fh $footer, <<'_EOF_'; =cut ex: set ro: _EOF_ + + close $fh or die "Can't close $filename: $!"; } my $file; @@ -136,9 +142,6 @@ for $file (($MANIFEST =~ /^(\S+\.c)\t/gm), ($MANIFEST =~ /^(\S+\.h)\t/gm)) { close F or die "Error closing $file: $!\n"; } -safer_unlink "pod/perlapi.pod"; -my $doc = safer_open("pod/perlapi.pod"); - open IN, "embed.fnc" or die $!; # walk table providing an array of components in each line to @@ -187,9 +190,7 @@ for (sort keys %docfuncs) { warn "Unable to place $_!\n"; } -readonly_header($doc); - -print $doc <<'_EOB_'; +output('perlapi', <<'_EOB_', \%apidocs, <<'_EOE_'); =head1 NAME perlapi - autogenerated documentation for the perl public API @@ -235,20 +236,6 @@ The listing below is alphabetical, case insensitive. _EOB_ -my $key; -# case insensitive sort, with fallback for determinacy -for $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %apidocs) { - my $section = $apidocs{$key}; - print $doc "\n=head1 $key\n\n=over 8\n\n"; - # Again, fallback for determinacy - for my $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %$section) { - docout($doc, $key, $section->{$key}); - } - print $doc "\n=back\n"; -} - -print $doc <<'_EOE_'; - =head1 AUTHORS Until May 1997, this document was maintained by Jeff Okamoto @@ -269,14 +256,7 @@ perlguts(1), perlxs(1), perlxstut(1), perlintern(1) _EOE_ -readonly_footer($doc); - -safer_close($doc); - -safer_unlink "pod/perlintern.pod"; -my $guts = safer_open("pod/perlintern.pod"); -readonly_header($guts); -print $guts <<'END'; +output('perlintern', <<'END', \%gutsdocs, <<'END'); =head1 NAME perlintern - autogenerated documentation of purely B<internal> @@ -292,17 +272,6 @@ B<they are not for use in extensions>! END -for $key (sort { uc($a) cmp uc($b); } keys %gutsdocs) { - my $section = $gutsdocs{$key}; - print $guts "\n=head1 $key\n\n=over 8\n\n"; - for my $key (sort { uc($a) cmp uc($b); } keys %$section) { - docout($guts, $key, $section->{$key}); - } - print $guts "\n=back\n"; -} - -print $guts <<'END'; - =head1 AUTHORS The autodocumentation system was originally added to the Perl core by @@ -314,6 +283,3 @@ document their functions. perlguts(1), perlapi(1) END -readonly_footer($guts); - -safer_close($guts); |