svn commit: r419959 - /perl/Apache-SizeLimit/trunk/lib/Apache/SizeLimit.pm

[au...@apache.org]

Author: autarch
Date: Fri Jul  7 12:12:55 2006
New Revision: 419959

URL: http://svn.apache.org/viewvc?rev=419959&view=rev
Log:
Perrin's doc patch.

Modified:
    perl/Apache-SizeLimit/trunk/lib/Apache/SizeLimit.pm

Modified: perl/Apache-SizeLimit/trunk/lib/Apache/SizeLimit.pm
URL: http://svn.apache.org/viewvc/perl/Apache-SizeLimit/trunk/lib/Apache/SizeLimit.pm?rev=419959&r1=419958&r2=419959&view=diff
==============================================================================
--- perl/Apache-SizeLimit/trunk/lib/Apache/SizeLimit.pm (original)
+++ perl/Apache-SizeLimit/trunk/lib/Apache/SizeLimit.pm Fri Jul  7 12:12:55 2006
@@ -409,8 +409,8 @@
 
     PerlCleanupHandler Apache::SizeLimit
 
-This will ensure that C<< Apache::SizeLimit->handler() >> is called
-run for all requests.
+This will ensure that C<< Apache::SizeLimit->handler() >> is run
+for all requests.
 
 If you want to combine this module with a cleanup handler of your own,
 make sure that C<Apache::SizeLimit> is the last handler run:
@@ -420,8 +420,10 @@
 Remember, mod_perl will run stacked handlers from right to left, as
 they're defined in your configuration.
 
-You can also explicitly call the C<< Apache::SizeLimit->handler() >>
-function from your own cleanup handler:
+If you have some cleanup code you need to run, but stacked handlers
+aren't appropriate for your setup, you can also explicitly call the
+C<< Apache::SizeLimit->handler() >> function from your own cleanup
+handler:
 
     package My::CleanupHandler
 
@@ -439,9 +441,10 @@
 
 =item * Apache::SizeLimit->add_cleanup_handler($r)
 
-You can call this method inside a request to run C<Apache::SizeLimit>'s
-C<handler()> method for just that request. If this method is called
-repeatedly, it ensures that it only every adds one cleanup handler.
+You can call this method inside a request to run
+C<Apache::SizeLimit>'s C<handler()> method for just that request. It's
+safe to call this method repeatedly -- the cleanup will only be run
+once per request.
 
 =back