Re-instate the old perl getcwd as _perl_getcwd, and use it if loading

[perl5.git] / autodoc.pl

diff --git a/autodoc.pl b/autodoc.pl
index 5e7b3c2..cb77a14 100644 (file)
--- a/autodoc.pl
+++ b/autodoc.pl
@@ -45,6 +45,7 @@ sub walk_table (&@) {
            $_ .= <IN>;
            chomp;
        }
+       s/\s+$//;
        my @args;
        if (/^\s*(#|$)/) {
            @args = $_;
@@ -52,6 +53,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;
@@ -63,6 +65,7 @@ sub walk_table (&@) {
 my %apidocs;
 my %gutsdocs;
 my %docfuncs;
+my %seenfuncs;
 
 my $curheader = "Unknown section";
 
@@ -118,13 +121,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
@@ -161,26 +165,27 @@ 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 "";
@@ -198,6 +203,7 @@ print DOC <<'_EOB_';
 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
@@ -219,7 +225,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";
@@ -261,6 +268,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