Rename to Porting/perldelta_template.pod so that t/porting/podcheck.t covers it.

[perl5.git] / autodoc.pl

diff --git a/autodoc.pl b/autodoc.pl
index 502f6ab..042131e 100644 (file)
--- a/autodoc.pl
+++ b/autodoc.pl
@@ -1,12 +1,20 @@
 #!/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';
-}
+# 
+# Unconditionally regenerate:
+#
+#    pod/perlintern.pod
+#    pod/perlapi.pod
+#
+# from information stored in
+#
+#    embed.fnc
+#    plus all the .c and .h files listed in MANIFEST
+#
+# Has an optional arg, which is the directory to chdir to before reading
+# MANIFEST and *.[ch].
+#
+# This script is normally invoked as part of 'make all', but is also
+# called from from regen.pl.
 
 use strict;
 
@@ -99,9 +107,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 +120,32 @@ 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: $!";
+}
+
+if (@ARGV) {
+    my $workdir = shift;
+    chdir $workdir
+        or die "Couldn't chdir to '$workdir': $!";
 }
 
 my $file;
@@ -136,9 +164,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 +212,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 +258,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 +278,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 +294,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 +305,3 @@ document their functions.
 perlguts(1), perlapi(1)
 
 END
-readonly_footer($guts);
-
-safer_close($guts);