X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=autodoc.pl;h=5317bc6da1cf60ee9eb89df505b6d2f2035c3925;hb=6a703acf87b6701fb41e57b7d4a367cac8a2d489;hp=c87f114fc840b420d01a03b861147ea5091cfe50;hpb=69e39a9aeaf661e41da7db0001d9c91f3c2c89c7;p=p5sagit%2Fp5-mst-13.2.git

diff --git a/autodoc.pl b/autodoc.pl
index c87f114..5317bc6 100644
--- a/autodoc.pl
+++ b/autodoc.pl
@@ -8,6 +8,7 @@ BEGIN {
   require 'regen_lib.pl';
 }
 
+use strict;
 
 #
 # See database of global and static function prototypes in embed.fnc
@@ -33,6 +34,7 @@ sub walk_table (&@) {
     else {
 	safer_unlink $filename;
 	open F, ">$filename" or die "Can't open $filename: $!";
+	binmode F;
 	$F = \*F;
     }
     print $F $leader if $leader;
@@ -44,6 +46,7 @@ sub walk_table (&@) {
 	    $_ .= <IN>;
 	    chomp;
 	}
+	s/\s+$//;
 	my @args;
 	if (/^\s*(#|$)/) {
 	    @args = $_;
@@ -51,6 +54,7 @@ sub walk_table (&@) {
 	else {
 	    @args = split /\s*\|\s*/, $_;
 	}
+	s/\b(NN|NULLOK)\b\s+//g for @args;
 	print $F $function->(@args);
     }
     print $F $trailer if $trailer;
@@ -62,6 +66,7 @@ sub walk_table (&@) {
 my %apidocs;
 my %gutsdocs;
 my %docfuncs;
+my %seenfuncs;
 
 my $curheader = "Unknown section";
 
@@ -117,13 +122,14 @@ DOC:
 sub docout ($$$) { # output the docs for one function
     my($fh, $name, $docref) = @_;
     my($flags, $docs, $ret, $file, @args) = @$docref;
+    $name =~ s/\s*$//;
 
     $docs .= "NOTE: this function is experimental and may change or be
 removed without notice.\n\n" if $flags =~ /x/;
     $docs .= "NOTE: the perl_ form of this function is deprecated.\n\n"
 	if $flags =~ /p/;
 
-    print $fh "=item $name\n$docs";
+    print $fh "=item $name\nX<$name>\n$docs";
 
     if ($flags =~ /U/) { # no usage
 	# nothing
@@ -139,6 +145,27 @@ 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_";
+-*- buffer-read-only: t -*-
+
+!!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
+This file is built by $0 extracting documentation from the C source
+files.
+
+_EOH_
+}
+
+sub readonly_footer (*) {
+    my $fh = shift;
+    print $fh <<'_EOF_';
+=cut
+
+ ex: set ro:
+_EOF_
+}
+
 my $file;
 # glob() picks up docs from extra .c or .h files that may be in unclean
 # development trees.
@@ -158,27 +185,29 @@ for $file (($MANIFEST =~ /^(\S+\.c)\t/gm), ($MANIFEST =~ /^(\S+\.h)\t/gm)) {
 safer_unlink "pod/perlapi.pod";
 open (DOC, ">pod/perlapi.pod") or
 	die "Can't create pod/perlapi.pod: $!\n";
+binmode DOC;
 
-walk_table {	# load documented functions into approriate hash
+walk_table {	# load documented functions into appropriate hash
     if (@_ > 1) {
 	my($flags, $retval, $func, @args) = @_;
 	return "" unless $flags =~ /d/;
 	$func =~ s/\t//g; $flags =~ s/p//; # clean up fields from embed.pl
 	$retval =~ s/\t//;
 	my $docref = delete $docfuncs{$func};
+	$seenfuncs{$func} = 1;
 	if ($docref and @$docref) {
 	    if ($flags =~ /A/) {
 		$docref->[0].="x" if $flags =~ /M/;
-		$apidocs{$docref->[4]}{$func} = 
-		    [$docref->[0] . 'A', $docref->[1], $retval,
-		    				$docref->[3], @args];
+		$apidocs{$docref->[4]}{$func} =
+		    [$docref->[0] . 'A', $docref->[1], $retval, $docref->[3],
+			@args];
 	    } else {
-		$gutsdocs{$docref->[4]}{$func} = 
+		$gutsdocs{$docref->[4]}{$func} =
 		    [$docref->[0], $docref->[1], $retval, $docref->[3], @args];
 	    }
 	}
 	else {
-	    warn "no docs for $func\n" unless $docref and @$docref;
+	    warn "no docs for $func\n" unless $seenfuncs{$func};
 	}
     }
     return "";
@@ -190,12 +219,15 @@ for (sort keys %docfuncs) {
     warn "Unable to place $_!\n";
 }
 
+readonly_header(\*DOC);
+
 print DOC <<'_EOB_';
 =head1 NAME
 
 perlapi - autogenerated documentation for the perl public API
 
 =head1 DESCRIPTION
+X<Perl API> X<API> X<api>
 
 This file contains the documentation of the perl public API generated by
 embed.pl, specifically a listing of functions, macros, flags, and variables
@@ -217,7 +249,8 @@ my $key;
 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";
-    for my $key (sort { uc($a) cmp uc($b); } keys %$section) {
+    # 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";
@@ -245,12 +278,15 @@ perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
 
 _EOE_
 
+readonly_footer(\*DOC);
 
 close(DOC) or die "Error closing pod/perlapi.pod: $!";
 
 safer_unlink "pod/perlintern.pod";
 open(GUTS, ">pod/perlintern.pod") or
 		die "Unable to create pod/perlintern.pod: $!\n";
+binmode GUTS;
+readonly_header(\*GUTS);
 print GUTS <<'END';
 =head1 NAME
 
@@ -258,6 +294,7 @@ perlintern - autogenerated documentation of purely B<internal>
 		 Perl functions
 
 =head1 DESCRIPTION
+X<internal Perl functions> X<interpreter functions>
 
 This file is the autogenerated documentation of functions in the
 Perl interpreter that are documented using Perl's internal documentation
@@ -288,5 +325,6 @@ document their functions.
 perlguts(1), perlapi(1)
 
 END
+readonly_footer(\*GUTS);
 
 close GUTS or die "Error closing pod/perlintern.pod: $!";