sbekman 01/06/29 00:46:04
Modified: pod modperl_design.pod modperl_dev.pod
modperl_style.pod
Log:
a few corrections and extensions
Revision Changes Path
1.3 +5 -4 modperl-2.0/pod/modperl_design.pod
Index: modperl_design.pod
===================================================================
RCS file: /home/cvs/modperl-2.0/pod/modperl_design.pod,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- modperl_design.pod 2001/02/28 05:40:13 1.2
+++ modperl_design.pod 2001/06/29 07:46:02 1.3
@@ -89,13 +89,14 @@
If all running interpreters are in use, mod_perl will clone new
interpreters to handle the request, up until this number of
-interpreters is reached. when Max is reached, mod_perl will block (via
-COND_WAIT()) until one becomes available (signaled via COND_SIGNAL())
+interpreters is reached. when PerlInterpMax is reached, mod_perl will
+block (via COND_WAIT()) until one becomes available (signaled via
+COND_SIGNAL())
=item PerlInterpMinSpare
The minimum number of available interpreters this parameter will clone
-interpreters up to Max, before a request comes in.
+interpreters up to PerlInterpMax, before a request comes in.
=item PerlInterpMaxSpare
@@ -187,7 +188,7 @@
the xs code was written for them here and there.
The goal for 2.0 is to generate the majority of xs code and provide
-thin wrappers were needed to make the API more Perlish. As part of
+thin wrappers where needed to make the API more Perlish. As part of
this goal, nearly the entire APR and Apache API, along with their
public data structures will covered from the get-go. Certain
functions and structures which are considered "private" to Apache or
1.27 +77 -13 modperl-2.0/pod/modperl_dev.pod
Index: modperl_dev.pod
===================================================================
RCS file: /home/cvs/modperl-2.0/pod/modperl_dev.pod,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -r1.26 -r1.27
--- modperl_dev.pod 2001/06/17 17:21:15 1.26
+++ modperl_dev.pod 2001/06/29 07:46:02 1.27
@@ -64,9 +64,10 @@
% perl Makefile.PL MP_GENERATE_XS=1 MP_USE_DSO=1 \
MP_APXS=$apache_prefix/bin/apxs && make
-I<options> an optional list of (key,value) pairs. Currently all options are
-boolean, set them with MP_XXX=1.
+I<options> an optional list of (key,value) pairs.
+Boolean options: set them with MP_XXX=1.
+
=over 4
=item MP_PROMPT_DEFAULT
@@ -106,38 +107,59 @@
Enable tracing
+=item MP_INST_APACHE2
+
+Install *.pm relative to Apache2/ directory
+
+=back
+
+Non-Boolean options: set them with MP_XXX=value.
+
+=over 4
+
=item MP_CCOPTS
Add to compiler flags, e.g.
MP_CCOPTS = -Werror
-=item MP_INST_APACHE2
-
-Install *.pm relative to Apache2/ directory
-
=item MP_OPTIONS_FILE
Read options from given file
=back
-mod_perl specific compiler opts:
+mod_perl specific compiler options:
=over 4
=item -DMP_IOBUFSIZE
-Change the default mod_perl's 8k IO buffer size, e.g. 16k:
+Change the default mod_perl's 8K IO buffer size, e.g. 16K:
MP_CCOPTS=-DMP_IOBUFSIZE=16384
=back
+
+Options can also be specified in the file I<makepl_args.mod_perl2> or
+I<.makepl_args.mod_perl2>. The file can be placed under $ENV{HOME},
+the root of the source package or its parent directory. So if you
+unpack the mod_perl source into I</tmp/mod_perl-2.x/> and your home is
+I</home/foo/>, the file will be searched in:
+
+ /tmp/mod_perl-2.x/makepl_args.mod_perl2
+ /tmp/makepl_args.mod_perl2
+ /home/foo/makepl_args.mod_perl2
+ /tmp/mod_perl-2.x/.makepl_args.mod_perl2
+ /tmp/.makepl_args.mod_perl2
+ /home/foo/.makepl_args.mod_perl2
-Options can also be specified in the file C<makepl_args.mod_perl2>.
-Command line options override those from C<makepl_args_mod_perl2>
-and those from MP_OPTIONS_FILE.
+If the file specified in C<MP_OPTIONS_FILE> is found the
+I<makepl_args.mod_perl2> will be ignored.
+Command line options override those from I<makepl_args.mod_perl2> and
+those from C<MP_OPTIONS_FILE>.
+
=head2 Compile mod_perl
% make
@@ -311,7 +333,7 @@
set the trace level. This directive is enabled when mod_perl is compiled with
the MP_TRACE option. C<level> is either:
-all
+ all
which sets maximum logging and debugging levels;
@@ -325,7 +347,7 @@
m memory allocations
s perl sections
-a numeric value.
+or a numeric value.
When C<level> is not specified, the tracing level will be set to the
value of the MOD_PERL_TRACE environment variable.
@@ -452,3 +474,45 @@
<VirtualHost ...>
PerlOptions -Authen -Authz -Access
</VirtualHost>
+
+
+=head1 Notes for Developers
+
+If you develop some parts of the mod_perl core you may find these usefull:
+
+=over
+
+=item *
+
+Apache source code cross-reference (LXR):
+http://lxr.webperf.org/
+
+=item *
+
+Apache source code through Doxygen documentation system:
+
+http://docx.webperf.org/
+
+
+=item *
+
+
+
+=back
+
+
+
+
+=head1 Submitting Patches
+
+If you submit patches the I<Porting/patching.pod> manpage can be very
+useful. You can find it I<perl-5.7.0/Porting/patching.pod> or similar
+or read it online at
+http://sunsite.ualberta.ca/Documentation/Misc/perl-5.6.1/Porting/patching.html
+.
+
+Note that we prefer the patches inlined into an email. This makes
+easier to comment on them.
+
+=cut
+
1.5 +3 -2 modperl-2.0/pod/modperl_style.pod
Index: modperl_style.pod
===================================================================
RCS file: /home/cvs/modperl-2.0/pod/modperl_style.pod,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- modperl_style.pod 2001/04/26 03:11:04 1.4
+++ modperl_style.pod 2001/06/29 07:46:02 1.5
@@ -44,7 +44,8 @@
=head1 Perl code
Perl code also follows the Apache style guide, in terms of
-indentation, braces, etc.
+indentation, braces, etc. Style issues not covered by Apache style of
+guide should be looked up in the I<perlstyle> manpage.
=head2 Global Variables
@@ -127,6 +128,6 @@
=item %main::
-stay away from main:: to avoid namespace clashes
+stay away from C<main::> to avoid namespace clashes
=back
