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

p4raw-id: //depot/perl@23176

1 files changed, 9 insertions, 0 deletions

diff --git a/perly.y b/perly.y
index 9224537979..5d1b19fd77 100644
--- a/perly.y
+++ b/perly.y
@@ -12,6 +12,15 @@
  * All that is gold does not glitter, not all those who wander are lost.'
  */
 
+/* This file holds the grammar for the Perl language. If edited, you need
+ * to run regen_perly.pl, which re-creates the files perly.h, perly.tab
+ * and perly.act which are derived from this.
+ *
+ * The main job of of this grammar is to call the various newFOO()
+ * functions in op.c to build a syntax tree of OP structs.
+ * It relies in the lexer in toke.c to do the tokenizing.
+ */
+
 /*  Make the parser re-entrant. */
 
 %pure_parser