X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=autodoc.pl;h=5317bc6da1cf60ee9eb89df505b6d2f2035c3925;hb=25ff0154ccf606eb5512a8cde622caf50e20fba3;hp=cb77a14ae940bd6549bc0f08d89fc9aec04037b8;hpb=7eb550cf010090aecb73da60fde61194798b89d1;p=p5sagit%2Fp5-mst-13.2.git diff --git a/autodoc.pl b/autodoc.pl index cb77a14..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 @@ -144,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. @@ -197,6 +219,8 @@ for (sort keys %docfuncs) { warn "Unable to place $_!\n"; } +readonly_header(\*DOC); + print DOC <<'_EOB_'; =head1 NAME @@ -254,6 +278,7 @@ perlguts(1), perlxs(1), perlxstut(1), perlintern(1) _EOE_ +readonly_footer(\*DOC); close(DOC) or die "Error closing pod/perlapi.pod: $!"; @@ -261,6 +286,7 @@ 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 @@ -299,5 +325,6 @@ document their functions. perlguts(1), perlapi(1) END +readonly_footer(\*GUTS); close GUTS or die "Error closing pod/perlintern.pod: $!";