perl-docs-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject cvs commit: modperl-docs/src/api/mod_perl-2.0/Apache ServerUtil.pod
Date Tue, 20 Nov 2001 02:35:07 GMT
stas        01/11/19 18:35:07

  Modified:    src/api/mod_perl-2.0/Apache ServerUtil.pod
  Log:
  - adjust the doc for server_root_relative
  - document the server_root constant
  - split the API doc into constants, functions and methods sections.
  
  Revision  Changes    Path
  1.3       +36 -20    modperl-docs/src/api/mod_perl-2.0/Apache/ServerUtil.pod
  
  Index: ServerUtil.pod
  ===================================================================
  RCS file: /home/cvs/modperl-docs/src/api/mod_perl-2.0/Apache/ServerUtil.pod,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- ServerUtil.pod	2001/11/14 08:50:00	1.2
  +++ ServerUtil.pod	2001/11/20 02:35:07	1.3
  @@ -24,8 +24,44 @@
   Function arguments (if any) and return values are shown in the
   function's synopsis.
   
  +=head2 CONSTANTS
  +
  +=over
  +
  +=item * server_root
  +
  +returns the value set by the C<ServerRoot> directive.
  +
  +=back
  +
  +=head2 FUNCTIONS
  +
   =over
   
  +=item * server_root_relative()
  +
  +Returns the canonical form of the filename made absolute to
  +C<ServerRoot>:
  +
  +  Apache::server_root_relative($pool, $fname);
  +
  +C<$fname> is appended to the value of C<ServerRoot> and return
  +it. e.g.:
  +
  +  my $log_dir = Apache::server_root_relative($r->pool, 'logs');
  +
  +If C<$fname> is not specified, the value of C<ServerRoot> is returned
  +with a trailing C</>. (it's the same as using C<''> as C<$fname>'s
  +value).
  +
  +Also see the L<C<server_root>> constant.
  +
  +=back
  +
  +=head2 METHODS
  +
  +=over
  +
   =item * server()
   
   The main server's object can be retrieved with:
  @@ -84,26 +120,6 @@
   
   =item * get_handlers()
   
  -=item * server_root_relative()
  -
  -Returns the canonical form of the filename made absolute to
  -C<ServerRoot>:
  -
  -  Apache::server_root_relative([$fname, [$pool]]);
  -
  -If C<$fname> is specified, it'll be appended to the value of
  -C<ServerRoot> and return it. e.g.:
  -
  -  my $log_dir = Apache::server_root_relative('log', $r->pool);
  -
  -If C<$pool> is not specified, the default server startup pool is used
  -(this style adds an overhead of fetching the startup data). e.g.:
  -
  -  my $conf_dir = Apache::server_root_relative('conf');
  -
  -If C<$fname> is not specified, the value of C<ServerRoot> is returned
  -with a trailing C</>. (it's the same as using C<''> as C<$fname>'s
  -value).
   
   =back
   
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-cvs-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-cvs-help@perl.apache.org


Mime
View raw message