stas 2002/12/27 23:39:28
Modified: src/docs/2.0/api/ModPerl-Registry/ModPerl RegistryCooker.pod
RegistryLoader.pod
src/docs/2.0/user/compat compat.pod
Log:
more registry docs
Revision Changes Path
1.4 +34 -4
modperl-docs/src/docs/2.0/api/ModPerl-Registry/ModPerl/RegistryCooker.pod
Index: RegistryCooker.pod
===================================================================
RCS file:
/home/cvs/modperl-docs/src/docs/2.0/api/ModPerl-Registry/ModPerl/RegistryCooker.pod,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- RegistryCooker.pod 27 Dec 2002 07:05:22 -0000 1.3
+++ RegistryCooker.pod 28 Dec 2002 07:39:28 -0000 1.4
@@ -33,14 +33,28 @@
Here are the current overridable methods:
+META: these are all documented in RegistryCooker.pm, though not using
+pod. please help to port these to pod and move the descriptions here.
+
=over
=item * new()
+create the class's object, bless it and return it
+
+ my $obj = $class->new($r);
+
+C<$class> -- the registry class, usually C<__PACKAGE__> can be used.
+
+C<$r> -- C<L<Apache::Request>> object.
+
default: new()
=item * init()
+initializes the data object's fields: C<REQ>, C<FILENAME>,
+C<URI>. Called from the new().
+
default: init()
=item * default_handler()
@@ -128,16 +142,32 @@
=back
-Special Predefined functions
+
+
+
+=head2 Special Predefined Functions
+
+The following functions are implemented as constants.
=over
=item * NOP()
-META: compelete
+Use when the function shouldn't do anything.
+
+=item * TRUE()
+
+Use when a function should always return a true value.
+
+=item * FALSE()
+
+Use when a function should always return a false value.
=back
+
+
+
=head1 Sub-classing Techniques
To override the default C<ModPerl::RegistryCooker> methods, first,
@@ -199,8 +229,8 @@
return (stat $self->[FILENAME])[1];
}
-META: when $r->finfo will be ported it'll be more effecient. (stat
-$r->finfo)[1]
+META: when $r-E<gt>finfo will be ported it'll be more effecient.
+(stat $r-E<gt>finfo)[1]
=head1 Authors
1.2 +5 -1
modperl-docs/src/docs/2.0/api/ModPerl-Registry/ModPerl/RegistryLoader.pod
Index: RegistryLoader.pod
===================================================================
RCS file:
/home/cvs/modperl-docs/src/docs/2.0/api/ModPerl-Registry/ModPerl/RegistryLoader.pod,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- RegistryLoader.pod 13 Nov 2001 04:36:21 -0000 1.1
+++ RegistryLoader.pod 28 Dec 2002 07:39:28 -0000 1.2
@@ -46,11 +46,15 @@
When creating a new C<ModPerl::RegistryLoader> object, one has to
specify which of the C<ModPerl::RegistryCooker> derived modules to
use. For example if a script is going to run under
-C<Apache::RegistryBB> the object is initialized as:
+C<ModPerl::RegistryBB> the object is initialized as:
my $rlbb = ModPerl::RegistryLoader->new(
package => 'ModPerl::RegistryBB',
);
+
+If the package is not specified C<ModPerl::Registry> is assumed:
+
+ my $rlbb = ModPerl::RegistryLoader->new();
To turn the debugging on, set the I<debug> attribute to a true value:
1.38 +11 -0 modperl-docs/src/docs/2.0/user/compat/compat.pod
Index: compat.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/user/compat/compat.pod,v
retrieving revision 1.37
retrieving revision 1.38
diff -u -r1.37 -r1.38
--- compat.pod 15 Dec 2002 15:27:51 -0000 1.37
+++ compat.pod 28 Dec 2002 07:39:28 -0000 1.38
@@ -183,7 +183,18 @@
META: complete
+META: document that for now ModPerl::Registry doesn't chdir() into the
+script's dir like Apache::Registry does, because chdir() affects the
+whole process under threads.
+
+=head2 C<ModPerl::RegistryLoader>
+
+In mod_perl 1.0 it was only possible to preload scripts as
+C<Apache::Registry> handlers. In 2.0 the loader can use any of the
+registry classes to preload into. The old API works as before, but new
+options can be passed. See the I<L<ModPerl::RegistryLoader>> manpage
+for more information.
=head1 C<Apache::Constants>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
