Author: stas Date: Wed Apr 27 08:11:12 2005 New Revision: 164989 URL: http://svn.apache.org/viewcvs?rev=164989&view=rev Log: various corrections and polish
Modified: perl/modperl/docs/trunk/src/docs/2.0/user/handlers/intro.pod perl/modperl/docs/trunk/src/docs/2.0/user/handlers/server.pod perl/modperl/docs/trunk/src/docs/2.0/user/install/install.pod perl/modperl/docs/trunk/src/docs/2.0/user/intro/start_fast.pod perl/modperl/docs/trunk/src/docs/2.0/user/porting/compat.pod Modified: perl/modperl/docs/trunk/src/docs/2.0/user/handlers/intro.pod URL: http://svn.apache.org/viewcvs/perl/modperl/docs/trunk/src/docs/2.0/user/handlers/intro.pod?rev=164989&r1=164988&r2=164989&view=diff ============================================================================== --- perl/modperl/docs/trunk/src/docs/2.0/user/handlers/intro.pod (original) +++ perl/modperl/docs/trunk/src/docs/2.0/user/handlers/intro.pod Wed Apr 27 08:11:12 2005 @@ -79,35 +79,36 @@ value -- things will change in the future and you won't know why things aren't working anymore. -The only value that can be returned by all handlers is C<Apache2::Const::OK>, -which tells Apache that the handler has successfully finished its -execution. +The only value that can be returned by all handlers is +C<Apache2::Const::OK>, which tells Apache that the handler has +successfully finished its execution. -C<Apache2::Const::DECLINED> is another return value that indicates success, -but it's only relevant for -L<phases|docs::2.0::user::handlers::intro/Stacked_Handlers> -of type C<L<RUN_FIRST|/RUN_FIRST>>. +C<Apache2::Const::DECLINED> is another return value that indicates +success, but it's only relevant for +L<phases|docs::2.0::user::handlers::intro/Stacked_Handlers> of type +C<L<RUN_FIRST|/RUN_FIRST>>. L<HTTP handlers|docs::2.0::user::handlers::http> may also return -C<Apache2::Const::DONE> which tells Apache to stop the normal L<HTTP request +C<Apache2::Const::DONE> which tells Apache to stop the normal L<HTTP +request cycle|docs::2.0::user::handlers::http/HTTP_Request_Cycle_Phases> and fast forward to the C<L<PerlLogHandler|docs::2.0::user::handlers::http/PerlLogHandler>>, followed by C<L<PerlCleanupHandler|docs::2.0::user::handlers::http/PerlCleanupHandler>>. L<HTTP handlers|docs::2.0::user::handlers::http> may return any HTTP -status, which similarly to C<Apache2::Const::DONE> will cause an abort of the -request cycle, by also will be interpreted as an error. Therefore you -don't want to return C<Apache2::Const::HTTP_OK> from your HTTP response -handler, but C<Apache2::Const::OK> and Apache will send the C<200 OK> status -by itself. +status, which similarly to C<Apache2::Const::DONE> will cause an abort +of the request cycle, by also will be interpreted as an +error. Therefore you don't want to return C<Apache2::Const::HTTP_OK> +from your HTTP response handler, but C<Apache2::Const::OK> and Apache +will send the C<200 OK> status by itself. L<Filter handlers|docs::2.0::user::handlers::filters> return C<Apache2::Const::OK> to indicate that the filter has successfully -finished. If the return value is C<Apache2::Const::DECLINED>, mod_perl will -read and forward the data on behalf of the filter. Please notice that -this feature is specific to mod_perl. If there is some problem with -obtaining or sending the bucket brigades, or the buckets in it, +finished. If the return value is C<Apache2::Const::DECLINED>, mod_perl +will read and forward the data on behalf of the filter. Please notice +that this feature is specific to mod_perl. If there is some problem +with obtaining or sending the bucket brigades, or the buckets in it, filters need to return the error returned by the method that tried to manipulate the bucket brigade or the bucket. Normally it'd be an C<L<APR::|docs::2.0::api::APR::Const>> constant. @@ -119,8 +120,8 @@ handler, which, if returning anything but C<Apache2::Const::OK> or C<Apache2::Const::DONE>, will prevent from C<L<PerlConnectionHandler|docs::2.0::user::handlers::protocols/PerlConnectionHandler>> -to be -run. C<L<PerlPreConnectionHandler|docs::2.0::user::handlers::protocols/PerlPreConnectionHandler>> +to be run. +C<L<PerlPreConnectionHandler|docs::2.0::user::handlers::protocols/PerlPreConnectionHandler>> handlers should always return C<Apache2::Const::OK>. Modified: perl/modperl/docs/trunk/src/docs/2.0/user/handlers/server.pod URL: http://svn.apache.org/viewcvs/perl/modperl/docs/trunk/src/docs/2.0/user/handlers/server.pod?rev=164989&r1=164988&r2=164989&view=diff ============================================================================== --- perl/modperl/docs/trunk/src/docs/2.0/user/handlers/server.pod (original) +++ perl/modperl/docs/trunk/src/docs/2.0/user/handlers/server.pod Wed Apr 27 08:11:12 2005 @@ -53,8 +53,8 @@ Let's look at the following example that demonstrates all the startup phases: - file:MyApache2/StartupLog.pm - --------------------------- + #file:MyApache2/StartupLog.pm + #---------------------------- package MyApache2::StartupLog; use strict; @@ -590,8 +590,8 @@ commonly used modules, pre-compile constants, etc. Here is a typical I<startup.pl> for mod_perl 2.0: - file:startup.pl - --------------- + #file:startup.pl + #--------------- use lib qw(/home/httpd/perl); Modified: perl/modperl/docs/trunk/src/docs/2.0/user/install/install.pod URL: http://svn.apache.org/viewcvs/perl/modperl/docs/trunk/src/docs/2.0/user/install/install.pod?rev=164989&r1=164988&r2=164989&view=diff ============================================================================== --- perl/modperl/docs/trunk/src/docs/2.0/user/install/install.pod (original) +++ perl/modperl/docs/trunk/src/docs/2.0/user/install/install.pod Wed Apr 27 08:11:12 2005 @@ -34,7 +34,7 @@ =over -=item prefork MPM +=item Prefork MPM Requires at least Perl version 5.6.1. @@ -49,7 +49,7 @@ on some platforms it's unstable (e.g., FreeBSD), so don't enable it unless you really need it. -=item threaded MPMs +=item Threaded MPMs Require at least Perl version 5.8.0 with ithreads support built-in. That means that it should report: @@ -60,12 +60,6 @@ If that's not what you see rebuild Perl with C<-Dusethreads>. -=item threads.pm - -If you want to run applications that take benefit of Perl's -I<threads.pm> Perl version 5.8.1 or higher w/ithreads enabled is -required. Perl 5.8.0's I<threads.pm> doesn't work with mod_perl 2.0. - =item Static prefork build Perl with ithreads support version 5.6.1 or higher @@ -76,6 +70,12 @@ Perl with ithreads support version 5.8.0 or higher +=item threads.pm + +If you want to run applications that take benefit of Perl's +I<threads.pm> Perl version 5.8.1 or higher w/ithreads enabled is +required. Perl 5.8.0's I<threads.pm> doesn't work with mod_perl 2.0. + =back =item * CPAN Perl Modules @@ -93,16 +93,23 @@ =over -=item CGI.pm 3.01 +=item CGI.pm 3.08 =item Compress::Zlib 1.09 =back +Though the easiest way to satisfy all the dependencies is to install +C<Bundle::Apache2> available from CPAN. =back + + + + + =head2 Downloading Stable Release Sources If you are going to install mod_perl on a production site, you want to @@ -138,16 +145,17 @@ =head2 Getting Bleeding Edge Sources -If you really know what you are doing you can use the cvs/svn versions of -the components. Chances are that you don't want to them on a +If you really know what you are doing you can use the cvs/svn versions +of the components. Chances are that you don't want to them on a production site. You have been warned! =over =item Perl -CVS Perl (aka bleadperl or bleedperl) is only generally available -through an rsync repository maintained by ActiveState: +The cutting edge version of Perl (aka bleadperl or bleedperl) is only +generally available through an rsync repository maintained by +ActiveState: # (--delete to ensure a clean state) % rsync -acvz --delete --force \ @@ -191,6 +199,9 @@ % ./Configure -des -Dusethreads +Most likely you don't want perl-support for threads enabled, in which +case pass: C<-Uusethreads> instead of C<-Dusethreads>. + If you want to debug mod_perl segmentation faults, add the following I<./Configure> options: @@ -259,7 +270,8 @@ =item Stable Release -Download from: I<http://perl.apache.org/download/> +Download from I<http://perl.apache.org/download/> or your favorite +CPAN mirror. This direct link which symlinks to the latest release should work too: I<http://perl.apache.org/dist/mod_perl-2.0-current.tar.gz>. @@ -302,7 +314,10 @@ The following sections give the details about all the available options, but let's mention first an important one. -Configure Options are discussed in L<Build Options|/mod_perl_Build_Options> +Configuration options are discussed in L<Build +Options|/mod_perl_Build_Options>. + + =head3 Dynamic mod_perl Modified: perl/modperl/docs/trunk/src/docs/2.0/user/intro/start_fast.pod URL: http://svn.apache.org/viewcvs/perl/modperl/docs/trunk/src/docs/2.0/user/intro/start_fast.pod?rev=164989&r1=164988&r2=164989&view=diff ============================================================================== --- perl/modperl/docs/trunk/src/docs/2.0/user/intro/start_fast.pod (original) +++ perl/modperl/docs/trunk/src/docs/2.0/user/intro/start_fast.pod Wed Apr 27 08:11:12 2005 @@ -83,9 +83,10 @@ Check I<$HOME/httpd/prefork/logs/error_log> to see that the server has started and it's a right one. It should say something similar to: - [Tue May 25 09:24:28 2004] [notice] Apache/2.0.50-dev (Unix) - mod_perl/1.99_15-dev Perl/v5.8.4 mod_ssl/2.0.50-dev OpenSSL/0.9.7c - DAV/2 configured -- resuming normal operations + [Tue Apr 26 23:28:49 2005] [notice] Apache/2.0.54-dev (Unix) + mod_ssl/2.0.54-dev OpenSSL/0.9.7e DAV/2 mod_perl/1.999.23-dev + Perl/v5.8.6 configured -- resuming normal operations + Modified: perl/modperl/docs/trunk/src/docs/2.0/user/porting/compat.pod URL: http://svn.apache.org/viewcvs/perl/modperl/docs/trunk/src/docs/2.0/user/porting/compat.pod?rev=164989&r1=164988&r2=164989&view=diff ============================================================================== --- perl/modperl/docs/trunk/src/docs/2.0/user/porting/compat.pod (original) +++ perl/modperl/docs/trunk/src/docs/2.0/user/porting/compat.pod Wed Apr 27 08:11:12 2005 @@ -225,7 +225,6 @@ This document explains what APIs have changed and what new APIs should be used instead. - Finally, mod_perl 2.0 has all its methods spread across many modules. In order to use these methods the modules containing them have to be loaded first. The module --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]