[svn:mod_parrot] r188 - mod_parrot/trunk/docs

Author: ianjoyce
Date: Mon Aug  1 21:29:07 2005
New Revision: 188

Added:
   mod_parrot/trunk/docs/build-autogen.txt
Log:
Adding code auto generation documentation.


Added: mod_parrot/trunk/docs/build-autogen.txt
==============================================================================
--- (empty file)
+++ mod_parrot/trunk/docs/build-autogen.txt	Mon Aug  1 21:29:07 2005
@@ -0,0 +1,27 @@
+This is documentation for the code auto generation phase of the build process.
+
+Code that is currently being generated.
+---------------------------------------
+ + Most of Apache::Constants (lib/Apache/Constants.imc)
+ + Simple properties of Apache::RequestRec (lib/Apache/RequestRec.imc)
+
+
+Files of importance.
+-------------------
+ + build/lib/generate_source.pl
+   - Entry point for the code generation.
+   - Takes arguments from the Makefile and fires off the code generators.
+
+ + build/lib/Generator/ApacheConstants.pm
+   - Generates the following files:
+     - build/src/imc/apache_constants.imc
+   - Parses httpds httpd.h and http_log.h
+
+ + build/lib/Generator/ApacheRequestRec.pm
+   - Generates the following files:
+     - build/src/imc/request_rec.imc
+     - build/src/imc/request_rec_dlfunc.imc
+     - build/src/nci/request_rec.c
+
+ + build/maps/httpd/request_rec.map
+   - Map of data used to generate the files need for Apache::RequestRec.