stas 2002/08/12 20:19:24
Modified: src/docs/1.0/api Apache.pod
Log:
sync with the modperl rep:
document the server_root_relative() method
Revision Changes Path
1.12 +28 -0 modperl-docs/src/docs/1.0/api/Apache.pod
Index: Apache.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/1.0/api/Apache.pod,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- Apache.pod 16 May 2002 12:16:47 -0000 1.11
+++ Apache.pod 13 Aug 2002 03:19:24 -0000 1.12
@@ -484,6 +484,34 @@
PerlTransHandler trans_handler
+=item $r-E<gt>server_root_relative( [$relative_path] )
+
+If called without any arguments, this method returns the value of the
+currently-configured C<ServerRoot> directory.
+
+If a single argument is passed, it concatenates it with the value of
+C<ServerRoot>. For example here is how to get the path to the
+I<error_log> file under the server root:
+
+ my $error_log = $r->server_root_relative("logs/error_log");
+
+See also the next item.
+
+=item Apache-E<gt>server_root_relative( [$relative_path] )
+
+Same as the previous item, but this time it's used without a request
+object. This method is usually needed in a startup file. For example
+the following startup file modifies C<@INC> to add a local directory
+with perl modules located under the server root and after that loads a
+module from that directory.
+
+ BEGIN {
+ use Apache():
+ use lib Apache->server_root_relative("lib/my_project");
+ }
+ use MyProject::Config ();
+
+
=item $r-E<gt>allow_options
The C<$r-E<gt>allow_options> method can be used for
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
