Add comment to the top of most .c files explaining their purpose

p4raw-id: //depot/perl@23176

1 files changed, 13 insertions, 0 deletions

diff --git a/run.c b/run.c
index 3d48139d88..b98a76e9ab 100644
--- a/run.c
+++ b/run.c
@@ -8,6 +8,19 @@
  *
  */
 
+/* This file contains the main Perl opcode execution loop. It just
+ * calls the pp_foo() function associated with each op, and expects that
+ * function to return a pointer to the next op to be executed, or null if
+ * its the end of the sub or program or whatever.
+ *
+ * There is a similar loop in dump.c, Perl_runops_debug(), which does
+ * the same, but also checks for various debug flags each time round the
+ * loop.
+ *
+ * Why this function requires a file all of its own is anybody's guess.
+ * DAPM.
+ */
+
 #include "EXTERN.h"
 #define PERL_IN_RUN_C
 #include "perl.h"