Add some documentation to the heads of the various *.pl build scripts

1 files changed, 22 insertions, 0 deletions

diff --git a/embed.pl b/embed.pl
index f85c5a326d..50da23207d 100755
--- a/embed.pl
+++ b/embed.pl
@@ -1,4 +1,26 @@
 #!/usr/bin/perl -w
+# 
+# Regenerate (overwriting only if changed):
+#
+#    embed.h
+#    embedvar.h
+#    global.sym
+#    perlapi.c
+#    perlapi.h
+#    proto.h
+#
+# from information stored in
+#
+#    embed.fnc
+#    intrpvar.h
+#    perlvars.h
+#    pp.sym     (which has been generated by opcode.pl)
+#
+# plus from the values hardcoded into this script in @extvars.
+#
+# Accepts the standard regen_lib -q and -v args.
+#
+# This script is normally invoked from regen.pl.
 
 require 5.003;	# keep this compatible, an old perl is all we may have before
                 # we build the new one