This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
https://perl5.git.perl.org / perl5.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
[Merge] minitest fixes
[perl5.git] / autodoc.pl
diff --git a/autodoc.pl b/autodoc.pl
index 5317bc6..6ba223e 100644 (file)
--- a/autodoc.pl
+++ b/autodoc.pl
@@ -1,14 +1,36 @@
 #!/usr/bin/perl -w
 #!/usr/bin/perl -w
+# 
+# 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 invoked as part of 'make all'
+#
+# '=head1' are the only headings looked for.  If the first non-blank line after
+# the heading begins with a word character, it is considered to be the first 
+# line of documentation that applies to the heading itself.  That is, it is 
+# output immediately after the heading, before the first function, and not 
+# indented. The next input line that is a pod directive terminates this 
+# heading-level documentation.
 
 
-require 5.003; # keep this compatible, an old perl is all we may have before
-                # we build the new one
+use strict;
 
 
-BEGIN {
-  push @INC, 'lib';
-  require 'regen_lib.pl';
+if (@ARGV) {
+    my $workdir = shift;
+    chdir $workdir
+        or die "Couldn't chdir to '$workdir': $!";
 }
 }
-
-use strict;
+require 'regen/regen_lib.pl';
+require 'regen/embed_lib.pl';
 
 #
 # See database of global and static function prototypes in embed.fnc
 
 #
 # See database of global and static function prototypes in embed.fnc
@@ -17,77 +39,77 @@ use strict;
 # implicit interpreter context argument.
 #
 
 # implicit interpreter context argument.
 #
 
-open IN, "embed.fnc" or die $!;
-
-# walk table providing an array of components in each line to
-# subroutine, printing the result
-sub walk_table (&@) {
-    my $function = shift;
-    my $filename = shift || '-';
-    my $leader = shift;
-    my $trailer = shift;
-    my $F;
-    local *F;
-    if (ref $filename) {       # filehandle
-       $F = $filename;
-    }
-    else {
-       safer_unlink $filename;
-       open F, ">$filename" or die "Can't open $filename: $!";
-       binmode F;
-       $F = \*F;
-    }
-    print $F $leader if $leader;
-    seek IN, 0, 0;             # so we may restart
-    while (<IN>) {
-       chomp;
-       next if /^:/;
-       while (s|\\\s*$||) {
-           $_ .= <IN>;
-           chomp;
-       }
-       s/\s+$//;
-       my @args;
-       if (/^\s*(#|$)/) {
-           @args = $_;
-       }
-       else {
-           @args = split /\s*\|\s*/, $_;
-       }
-       s/\b(NN|NULLOK)\b\s+//g for @args;
-       print $F $function->(@args);
-    }
-    print $F $trailer if $trailer;
-    unless (ref $filename) {
-       close $F or die "Error closing $filename: $!";
-    }
-}
-
-my %apidocs;
-my %gutsdocs;
-my %docfuncs;
-my %seenfuncs;
+my %docs;
+my %funcflags;
+my %macro = (
+            ax => 1,
+            items => 1,
+            ix => 1,
+            svtype => 1,
+           );
+my %missing;
 
 my $curheader = "Unknown section";
 
 sub autodoc ($$) { # parse a file and extract documentation info
     my($fh,$file) = @_;
 
 my $curheader = "Unknown section";
 
 sub autodoc ($$) { # parse a file and extract documentation info
     my($fh,$file) = @_;
-    my($in, $doc, $line);
+    my($in, $doc, $line, $header_doc);
+
+    # Count lines easier
+    my $get_next_line = sub { $line++; return <$fh> };
+
 FUNC:
 FUNC:
-    while (defined($in = <$fh>)) {
+    while (defined($in = $get_next_line->())) {
+       if ($in =~ /^#\s*define\s+([A-Za-z_][A-Za-z_0-9]+)\(/ &&
+           ($file ne 'embed.h' || $file ne 'proto.h')) {
+           $macro{$1} = $file;
+           next FUNC;
+       }
         if ($in=~ /^=head1 (.*)/) {
             $curheader = $1;
         if ($in=~ /^=head1 (.*)/) {
             $curheader = $1;
+
+            # If the next non-space line begins with a word char, then it is
+            # the start of heading-ldevel documentation.
+           if (defined($doc = $get_next_line->())) {
+                # Skip over empty lines
+                while ($doc =~ /^\s+$/) {
+                    if (! defined($doc = $get_next_line->())) {
+                        next FUNC;
+                    }
+                }
+
+                if ($doc !~ /^\w/) {
+                    $in = $doc;
+                    redo FUNC;
+                }
+                $header_doc = $doc;
+
+                # Continue getting the heading-level documentation until read
+                # in any pod directive (or as a fail-safe, find a closing
+                # comment to this pod in a C language file
+HDR_DOC:
+                while (defined($doc = $get_next_line->())) {
+                    if ($doc =~ /^=\w/) {
+                        $in = $doc;
+                        redo FUNC;
+                    }
+
+                    if ($doc =~ m:^\s*\*/$:) {
+                        warn "=cut missing? $file:$line:$doc";;
+                        last HDR_DOC;
+                    }
+                    $header_doc .= $doc;
+                }
+            }
             next FUNC;
         }
             next FUNC;
         }
-       $line++;
        if ($in =~ /^=for\s+apidoc\s+(.*?)\s*\n/) {
            my $proto = $1;
            $proto = "||$proto" unless $proto =~ /\|/;
            my($flags, $ret, $name, @args) = split /\|/, $proto;
            my $docs = "";
 DOC:
        if ($in =~ /^=for\s+apidoc\s+(.*?)\s*\n/) {
            my $proto = $1;
            $proto = "||$proto" unless $proto =~ /\|/;
            my($flags, $ret, $name, @args) = split /\|/, $proto;
            my $docs = "";
 DOC:
-           while (defined($doc = <$fh>)) {
-               $line++;
+           while (defined($doc = $get_next_line->())) {
                last DOC if $doc =~ /^=\w+/;
                if ($doc =~ m:^\*/$:) {
                    warn "=cut missing? $file:$line:$doc";;
                last DOC if $doc =~ /^=\w+/;
                if ($doc =~ m:^\*/$:) {
                    warn "=cut missing? $file:$line:$doc";;
@@ -96,17 +118,57 @@ DOC:
                $docs .= $doc;
            }
            $docs = "\n$docs" if $docs and $docs !~ /^\n/;
                $docs .= $doc;
            }
            $docs = "\n$docs" if $docs and $docs !~ /^\n/;
+
+           # Check the consistency of the flags
+           my ($embed_where, $inline_where);
+           my ($embed_may_change, $inline_may_change);
+
+           my $docref = delete $funcflags{$name};
+           if ($docref and %$docref) {
+               $embed_where = $docref->{flags} =~ /A/ ? 'api' : 'guts';
+               $embed_may_change = $docref->{flags} =~ /M/;
+                $flags .= 'D' if $docref->{flags} =~ /D/;
+           } else {
+               $missing{$name} = $file;
+           }
            if ($flags =~ /m/) {
            if ($flags =~ /m/) {
-               if ($flags =~ /A/) {
-                   $apidocs{$curheader}{$name} = [$flags, $docs, $ret, $file, @args];
+               $inline_where = $flags =~ /A/ ? 'api' : 'guts';
+               $inline_may_change = $flags =~ /x/;
+
+               if (defined $embed_where && $inline_where ne $embed_where) {
+                   warn "Function '$name' inconsistency: embed.fnc says $embed_where, Pod says $inline_where";
                }
                }
-               else {
-                   $gutsdocs{$curheader}{$name} = [$flags, $docs, $ret, $file, @args];
+
+               if (defined $embed_may_change
+                   && $inline_may_change ne $embed_may_change) {
+                   my $message = "Function '$name' inconsistency: ";
+                   if ($embed_may_change) {
+                       $message .= "embed.fnc says 'may change', Pod does not";
+                   } else {
+                       $message .= "Pod says 'may change', embed.fnc does not";
+                   }
+                   warn $message;
                }
                }
+           } elsif (!defined $embed_where) {
+               warn "Unable to place $name!\n";
+               next;
+           } else {
+               $inline_where = $embed_where;
+               $flags .= 'x' if $embed_may_change;
+               @args = @{$docref->{args}};
+               $ret = $docref->{retval};
            }
            }
-           else {
-               $docfuncs{$name} = [$flags, $docs, $ret, $file, $curheader, @args];
-           }
+
+           $docs{$inline_where}{$curheader}{$name}
+               = [$flags, $docs, $ret, $file, @args];
+
+            # Create a special entry with an empty-string name for the
+            # heading-level documentation.
+           if (defined $header_doc) {
+                $docs{$inline_where}{$curheader}{""} = $header_doc;
+                undef $header_doc;
+            }
+
            if (defined $doc) {
                if ($doc =~ /^=(?:for|head)/) {
                    $in = $doc;
            if (defined $doc) {
                if ($doc =~ /^=(?:for|head)/) {
                    $in = $doc;
@@ -124,10 +186,19 @@ sub docout ($$$) { # output the docs for one function
     my($flags, $docs, $ret, $file, @args) = @$docref;
     $name =~ s/\s*$//;
 
     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/;
+    if ($flags =~ /D/) {
+        $docs = "\n\nDEPRECATED!  It is planned to remove this function from a
+future release of Perl.  Do not use it for new code; remove it from
+existing code.\n\n$docs";
+    }
+    else {
+        $docs = "\n\nNOTE: this function is experimental and may change or be
+removed without notice.\n\n$docs" if $flags =~ /x/;
+    }
     $docs .= "NOTE: the perl_ form of this function is deprecated.\n\n"
        if $flags =~ /p/;
     $docs .= "NOTE: the perl_ form of this function is deprecated.\n\n"
        if $flags =~ /p/;
+    $docs .= "NOTE: this function must be explicitly called as Perl_$name with an aTHX_ parameter.\n\n"
+        if $flags =~ /o/;
 
     print $fh "=item $name\nX<$name>\n$docs";
 
 
     print $fh "=item $name\nX<$name>\n$docs";
 
@@ -138,90 +209,170 @@ removed without notice.\n\n" if $flags =~ /x/;
     } elsif ($flags =~ /n/) { # no args
        print $fh "\t$ret\t$name\n\n";
     } else { # full usage
     } elsif ($flags =~ /n/) { # no args
        print $fh "\t$ret\t$name\n\n";
     } else { # full usage
-       print $fh "\t$ret\t$name";
-       print $fh "(" . join(", ", @args) . ")";
-       print $fh "\n\n";
+       my $p            = $flags =~ /o/; # no #define foo Perl_foo
+       my $n            = "Perl_"x$p . $name;
+       my $large_ret    = length $ret > 7;
+       my $indent_size  = 7+8 # nroff: 7 under =head + 8 under =item
+                         +8+($large_ret ? 1 + length $ret : 8)
+                         +length($n) + 1;
+       my $indent;
+       print $fh "\t$ret" . ($large_ret ? ' ' : "\t") . "$n(";
+       my $long_args;
+       for (@args) {
+           if ($indent_size + 2 + length > 79) {
+               $long_args=1;
+               $indent_size -= length($n) - 3;
+               last;
+           }
+       }
+       my $args = '';
+       if ($p) {
+           $args = @args ? "pTHX_ " : "pTHX";
+           if ($long_args) { print $fh $args; $args = '' }
+       }
+       $long_args and print $fh "\n";
+       my $first = !$long_args;
+       while () {
+           if (!@args or
+                length $args
+                && $indent_size + 3 + length($args[0]) + length $args > 79
+           ) {
+               print $fh
+                 $first ? '' : (
+                   $indent //=
+                      "\t".($large_ret ? " " x (1+length $ret) : "\t")
+                     ." "x($long_args ? 4 : 1 + length $n)
+                 ),
+                 $args, (","x($args ne 'pTHX_ ') . "\n")x!!@args;
+               $args = $first = '';
+           }
+           @args or last;
+           $args .= ", "x!!(length $args && $args ne 'pTHX_ ')
+                  . shift @args;
+       }
+       if ($long_args) { print $fh "\n", substr $indent, 0, -4 }
+       print $fh ")\n\n";
     }
     print $fh "=for hackers\nFound in file $file\n\n";
 }
 
     }
     print $fh "=for hackers\nFound in file $file\n\n";
 }
 
-sub readonly_header (*) {
-    my $fh = shift;
-    print $fh <<"_EOH_";
--*- buffer-read-only: t -*-
+sub sort_helper {
+    # Do a case-insensitive dictionary sort, with only alphabetics
+    # significant, falling back to using everything for determinancy
+    return (uc($a =~ s/[[^:alpha]]//r) cmp uc($b =~ s/[[^:alpha]]//r))
+           || uc($a) cmp uc($b)
+           || $a cmp $b;
+}
+
+sub output {
+    my ($podname, $header, $dochash, $missing, $footer) = @_;
+    my $fh = open_new("pod/$podname.pod", undef,
+                     {by => "$0 extracting documentation",
+                       from => 'the C source files'}, 1);
 
 
-!!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
-This file is built by $0 extracting documentation from the C source
-files.
+    print $fh $header;
 
 
-_EOH_
+    my $key;
+    for $key (sort sort_helper keys %$dochash) {
+       my $section = $dochash->{$key}; 
+       print $fh "\n=head1 $key\n\n";
+
+        # Output any heading-level documentation and delete so won't get in
+        # the way later
+        if (exists $section->{""}) {
+            print $fh $section->{""} . "\n";
+            delete $section->{""};
+        }
+       print $fh "=over 8\n\n";
+
+       for my $key (sort sort_helper keys %$section) {
+           docout($fh, $key, $section->{$key});
+       }
+       print $fh "\n=back\n";
+    }
+
+    if (@$missing) {
+        print $fh "\n=head1 Undocumented functions\n\n";
+    print $fh $podname eq 'perlapi' ? <<'_EOB_' : <<'_EOB_';
+The following functions have been flagged as part of the public API,
+but are currently undocumented.  Use them at your own risk, as the
+interfaces are subject to change.  Functions that are not listed in this
+document are not intended for public use, and should NOT be used under any
+circumstances.
+
+If you use one of the undocumented functions below, you may wish to consider
+creating and submitting documentation
+for it.  If your patch is accepted, this
+will indicate that the interface is stable (unless it is explicitly marked
+otherwise).
+
+=over
+
+_EOB_
+The following functions are currently undocumented.  If you use one of
+them, you may wish to consider creating and submitting documentation for
+it.
+
+=over
+
+_EOB_
+    for my $missing (sort @$missing) {
+        print $fh "=item $missing\nX<$missing>\n\n";
+    }
+    print $fh "=back\n\n";
 }
 }
+    print $fh $footer, "=cut\n";
 
 
-sub readonly_footer (*) {
-    my $fh = shift;
-    print $fh <<'_EOF_';
-=cut
+    read_only_bottom_close_and_rename($fh);
+}
 
 
- ex: set ro:
-_EOF_
+foreach (@{(setup_embed())[0]}) {
+    next if @$_ < 2;
+    my ($flags, $retval, $func, @args) = @$_;
+    s/\b(?:NN|NULLOK)\b\s+//g for @args;
+
+    $funcflags{$func} = {
+                        flags => $flags,
+                        retval => $retval,
+                        args => \@args,
+                       };
 }
 
 }
 
-my $file;
 # glob() picks up docs from extra .c or .h files that may be in unclean
 # development trees.
 # glob() picks up docs from extra .c or .h files that may be in unclean
 # development trees.
-my $MANIFEST = do {
-  local ($/, *FH);
-  open FH, "MANIFEST" or die "Can't open MANIFEST: $!";
-  <FH>;
-};
+open my $fh, '<', 'MANIFEST'
+    or die "Can't open MANIFEST: $!";
+while (my $line = <$fh>) {
+    next unless my ($file) = $line =~ /^(\S+\.[ch])\t/;
 
 
-for $file (($MANIFEST =~ /^(\S+\.c)\t/gm), ($MANIFEST =~ /^(\S+\.h)\t/gm)) {
     open F, "< $file" or die "Cannot open $file for docs: $!\n";
     $curheader = "Functions in file $file\n";
     autodoc(\*F,$file);
     close F or die "Error closing $file: $!\n";
 }
     open F, "< $file" or die "Cannot open $file for docs: $!\n";
     $curheader = "Functions in file $file\n";
     autodoc(\*F,$file);
     close F or die "Error closing $file: $!\n";
 }
+close $fh or die "Error whilst reading MANIFEST: $!";
 
 
-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 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];
-           } else {
-               $gutsdocs{$docref->[4]}{$func} =
-                   [$docref->[0], $docref->[1], $retval, $docref->[3], @args];
-           }
-       }
-       else {
-           warn "no docs for $func\n" unless $seenfuncs{$func};
-       }
-    }
-    return "";
-} \*DOC;
+for (sort keys %funcflags) {
+    next unless $funcflags{$_}{flags} =~ /d/;
+    warn "no docs for $_\n"
+}
+
+foreach (sort keys %missing) {
+    next if $macro{$_};
+    # Heuristics for known not-a-function macros:
+    next if /^[A-Z]/;
+    next if /^dj?[A-Z]/;
 
 
-for (sort keys %docfuncs) {
-    # Have you used a full for apidoc or just a func name?
-    # Have you used Ap instead of Am in the for apidoc?
-    warn "Unable to place $_!\n";
+    warn "Function '$_', documented in $missing{$_}, not listed in embed.fnc";
 }
 
 }
 
-readonly_header(\*DOC);
+# walk table providing an array of components in each line to
+# subroutine, printing the result
 
 
-print DOC <<'_EOB_';
+# List of funcs in the public API that aren't also marked as experimental nor
+# deprecated.
+my @missing_api = grep $funcflags{$_}{flags} =~ /A/ && $funcflags{$_}{flags} !~ /[MD]/ && !$docs{api}{$_}, keys %funcflags;
+output('perlapi', <<'_EOB_', $docs{api}, \@missing_api, <<'_EOE_');
 =head1 NAME
 
 perlapi - autogenerated documentation for the perl public API
 =head1 NAME
 
 perlapi - autogenerated documentation for the perl public API
@@ -230,34 +381,42 @@ perlapi - autogenerated documentation for the perl public API
 X<Perl API> X<API> X<api>
 
 This file contains the documentation of the perl public API generated by
 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
-that may be used by extension writers.  The interfaces of any functions that
-are not listed here are subject to change without notice.  For this reason,
-blindly using functions listed in proto.h is to be avoided when writing
-extensions.
+F<embed.pl>, specifically a listing of functions, macros, flags, and variables
+that may be used by extension writers.  L<At the end|/Undocumented functions>
+is a list of functions which have yet to be documented.  The interfaces of
+those are subject to change without notice.  Anything not listed here is
+not part of the public API, and should not be used by extension writers at
+all.  For these reasons, blindly using functions listed in proto.h is to be
+avoided when writing extensions.
 
 Note that all Perl API global variables must be referenced with the C<PL_>
 
 Note that all Perl API global variables must be referenced with the C<PL_>
-prefix.  Some macros are provided for compatibility with the older,
+prefix.  Again, those not listed here are not to be used by extension writers,
+and can be changed or removed without notice; same with macros.
+Some macros are provided for compatibility with the older,
 unadorned names, but this support may be disabled in a future release.
 
 unadorned names, but this support may be disabled in a future release.
 
-The listing is alphabetical, case insensitive.
+Perl was originally written to handle US-ASCII only (that is characters
+whose ordinal numbers are in the range 0 - 127).
+And documentation and comments may still use the term ASCII, when
+sometimes in fact the entire range from 0 - 255 is meant.
+
+Note that Perl can be compiled and run under EBCDIC (See L<perlebcdic>)
+or ASCII.  Most of the documentation (and even comments in the code)
+ignore the EBCDIC possibility.  
+For almost all purposes the differences are transparent.
+As an example, under EBCDIC,
+instead of UTF-8, UTF-EBCDIC is used to encode Unicode strings, and so
+whenever this documentation refers to C<utf8>
+(and variants of that name, including in function names),
+it also (essentially transparently) means C<UTF-EBCDIC>.
+But the ordinals of characters differ between ASCII, EBCDIC, and
+the UTF- encodings, and a string encoded in UTF-EBCDIC may occupy more bytes
+than in UTF-8.
+
+The listing below is alphabetical, case insensitive.
 
 _EOB_
 
 
 _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
 =head1 AUTHORS
 
 Until May 1997, this document was maintained by Jeff Okamoto
@@ -274,20 +433,15 @@ Updated to be autogenerated from comments in the source by Benjamin Stuhl.
 
 =head1 SEE ALSO
 
 
 =head1 SEE ALSO
 
-perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
+L<perlguts>, L<perlxs>, L<perlxstut>, L<perlintern>
 
 _EOE_
 
 
 _EOE_
 
-readonly_footer(\*DOC);
-
-close(DOC) or die "Error closing pod/perlapi.pod: $!";
+# List of non-static internal functions
+my @missing_guts =
+ grep $funcflags{$_}{flags} !~ /[As]/ && !$docs{guts}{$_}, keys %funcflags;
 
 
-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';
+output('perlintern', <<'END', $docs{guts}, \@missing_guts, <<'END');
 =head1 NAME
 
 perlintern - autogenerated documentation of purely B<internal>
 =head1 NAME
 
 perlintern - autogenerated documentation of purely B<internal>
@@ -298,33 +452,19 @@ 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
 
 This file is the autogenerated documentation of functions in the
 Perl interpreter that are documented using Perl's internal documentation
-format but are not marked as part of the Perl API. In other words,
+format but are not marked as part of the Perl API.  In other words,
 B<they are not for use in extensions>!
 
 END
 
 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
 =head1 AUTHORS
 
 The autodocumentation system was originally added to the Perl core by
-Benjamin Stuhl. Documentation is by whoever was kind enough to
+Benjamin Stuhl.  Documentation is by whoever was kind enough to
 document their functions.
 
 =head1 SEE ALSO
 
 document their functions.
 
 =head1 SEE ALSO
 
-perlguts(1), perlapi(1)
+L<perlguts>, L<perlapi>
 
 END
 
 END
-readonly_footer(\*GUTS);
-
-close GUTS or die "Error closing pod/perlintern.pod: $!";
Unnamed repository; edit this file 'description' to name the repository.