[svn:mod_parrot] r302 - mod_parrot/trunk

Author: jhorwitz
Date: Fri Dec 28 11:27:53 2007
New Revision: 302

Modified:
   mod_parrot/trunk/CHANGES
   mod_parrot/trunk/README
   mod_parrot/trunk/TODO

Log:
documentation updates


Modified: mod_parrot/trunk/CHANGES
==============================================================================
--- mod_parrot/trunk/CHANGES	(original)
+++ mod_parrot/trunk/CHANGES	Fri Dec 28 11:27:53 2007
@@ -2,7 +2,8 @@
 
 0.4    XXX
        * Support for Parrot 0.5.1 (Hatachi)
-       * Transition to server-side tests
+       * Begin transition to server-side tests
+       * Keep testing infrastructure on make clean (versus distclean)
        * Update PIR syntax and types that have changed since mod_parrot 0.3
        * Convert classes to new object model
        * Convert to nested namespaces
@@ -11,7 +12,9 @@
        * Remove underscore prefix from HLL handler subs
        * Map Apache MIME types to HLLs
        * Map Apache handler names to HLLs
-       * Per-server context pools
+       * Initialize interpreter at the earliest possible Apache phase
+       * Per-server context pools for virtual hosts (default is per-process)
+       * Properly merge server configs
        * Can pass a PMC note via pmc_notes()
        * Implement mod_perl-like cleanup handlers
        * Use proto-objects make mod_parrot classes instantiable from an HLL
@@ -28,6 +31,7 @@
          - ParrotAddType
          - ParrotAddHandler
          - ParrotOptions
+           o Parent
 
 0.3    August 2, 2005
        * Support for Parrot 0.2.2 (geeksunite)

Modified: mod_parrot/trunk/README
==============================================================================
--- mod_parrot/trunk/README	(original)
+++ mod_parrot/trunk/README	Fri Dec 28 11:27:53 2007
@@ -19,32 +19,39 @@
 REQUIREMENTS
 ------------
 * Apache 2.0.x or 2.2.x
-* A recent Parrot source tree (all tests pass as of r21360)
-* Perl 5.6.0 or later
+* Parrot 0.5.1 (Hatachi) or a recent source tree (all tests pass as of r24053)
+* Perl 5.6.0 or later for configuration
 * Apache::Test 1.26 or later (for tests)
 
 INSTALLATION
 ------------
-To install:
+To configure, compile, test and install:
 
-1) perl ./Configure.pl --parrot-build-dir=/path/to/parrot --apxs=/path/to/apxs
+1) perl Configure.pl --parrot-build-dir=/path/to/parrot --apxs=/path/to/apxs
 2) make
 3) make libraries
-4) make test (requires Apache::Test)
+4) make test
 5) make install
 6) Copy the lib directory to a directory of your choosing.  This *should* be
    installed in a more standard place, but we'll just copy it anywhere for now.
 
 CONFIGURING APACHE
 ------------------
+NOTE: This is a very basic configuration for pure PIR handlers.  See the
+web site for documentation on configuring handlers in other languages.
+
 1) Verify mod_parrot is activated in httpd.conf:
 
    LoadModule parrot_module      modules/mod_parrot.so
 
-2) Tell Apache how to initialize mod_parrot using ParrotInit.
+2) Tell Apache how to initialize mod_parrot using ParrotInit:
 
    ParrotInit /path/to/lib/mod_parrot.pbc
 
+   Alternatively you can copy mod_parrot.pbc to parrot's runtime directory
+   and set the PARROT_RUNTIME environment variable to that directory.
+   mod_parrot will then be able to find this file automatically.
+
 3) Preload your Parrot handler with ParrotLoad.  It can be PIR or compiled PBC.
 
    ParrotLoad /path/to/your/code
@@ -74,25 +81,15 @@
 
 6) Go to the URL you configured and try out your new handler.
 
-
-EXAMPLES
---------
-See the "eg" directory for simple examples of various handlers.
-
 DOCUMENTATION
 -------------
 The "docs" directory contains most of the documentation.  Most of it is
 focused on the design of mod_parrot rather than usage.  Additional POD
-documentation can be found in:
-* lib/Apache/RequestRec.pir
-* lib/Apache/Constants.pir
+documentation can be found in various PIR files in the lib directory.
+
+For more thorough documentation and tutorials, visit the mod_parrot
+web site at http://www.smashing.org/mod_parrot.
 
 NOTES
 -----
-ParrotLoad is only valid in a server context, not in a directory block.  This
-will change in a future release.
-
-Code might be loaded multiple times, causing the httpd processes to grow.
-
-When changing handler code, you should stop and start Apache instead of using 
-apachectl restart".
+Restarting Apache might crash the server.  Use apachectl stop and start instead.

Modified: mod_parrot/trunk/TODO
==============================================================================
--- mod_parrot/trunk/TODO	(original)
+++ mod_parrot/trunk/TODO	Fri Dec 28 11:27:53 2007
@@ -9,3 +9,4 @@
 * autoloading of HLL compiler code (need a Parrot_load_hll_bytecode())
 * separate HLL impelmentations into their own distributions
 * support Apache 2.2+ auth providers
+* fix restart crashes -- parrot might be stealing SIGHUP