X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/741c0772bf49e348fe0e2ea00a8937512b03d074..0ed2b00b2bd6a650391433ad8733983692df43d5:/autodoc.pl diff --git a/autodoc.pl b/autodoc.pl index f82593e..2bcf263 100644 --- a/autodoc.pl +++ b/autodoc.pl @@ -13,8 +13,7 @@ # 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 regen.pl. +# This script is invoked as part of 'make all' # # '=head1' are the only headings looked for. If the next line after the # heading begins with a word character, it is considered to be the first line @@ -254,7 +253,7 @@ 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'}); + from => 'the C source files'}, 1); print $fh $header; @@ -283,13 +282,14 @@ sub output { 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 +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 +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). @@ -371,13 +371,15 @@ This file contains the documentation of the perl public API generated by F, specifically a listing of functions, macros, flags, and variables that may be used by extension writers. L is a list of functions which have yet to be documented. The interfaces of -those are subject to change without notice. Any functions not listed here are +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 -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. Perl was originally written to handle US-ASCII only (that is characters @@ -437,7 +439,7 @@ X X 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! END @@ -445,7 +447,7 @@ END =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