From: Nicholas Clark <nick@ccl4.org>
Date: Sun, 29 Oct 2006 21:23:12 +0000 (+0000)
Subject: Modify autodoc.pl to add read-only editor boilerplate for perlapi.pod
X-Git-Tag: accepted/trunk/20130322.191538~16752
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=e04926433bb6070f25203e63e55060257391035c;p=platform%2Fupstream%2Fperl.git

Modify autodoc.pl to add read-only editor boilerplate for perlapi.pod
and perlguts.pod

p4raw-id: //depot/perl@29138
---

diff --git a/autodoc.pl b/autodoc.pl
index cb77a14..7748e2a 100644
--- a/autodoc.pl
+++ b/autodoc.pl
@@ -144,6 +144,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 +218,8 @@ for (sort keys %docfuncs) {
     warn "Unable to place $_!\n";
 }
 
+readonly_header(DOC);
+
 print DOC <<'_EOB_';
 =head1 NAME
 
@@ -254,6 +277,7 @@ perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
 
 _EOE_
 
+readonly_footer(DOC);
 
 close(DOC) or die "Error closing pod/perlapi.pod: $!";
 
@@ -261,6 +285,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 +324,6 @@ document their functions.
 perlguts(1), perlapi(1)
 
 END
+readonly_footer(GUTS);
 
 close GUTS or die "Error closing pod/perlintern.pod: $!";
diff --git a/pod/perlapi.pod b/pod/perlapi.pod
index df78a14..c5f4823 100644
--- a/pod/perlapi.pod
+++ b/pod/perlapi.pod
@@ -1,3 +1,9 @@
+-*- buffer-read-only: t -*-
+
+!!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
+This file is built by autodoc.pl extracting documentation from the C source
+files.
+
 =head1 NAME
 
 perlapi - autogenerated documentation for the perl public API
@@ -6931,3 +6937,6 @@ Updated to be autogenerated from comments in the source by Benjamin Stuhl.
 
 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
 
+=cut
+
+ex: set ro: