Mailing List Archive

gozer@apache.org wrote:
> gozer 2004/08/11 15:52:42
>
> Modified: src/docs/2.0/api/Apache Const.pod
> Log:
> Document the new :context group of constants
> NOT_IN_VIRTUALHOST
> NOT_IN_LIMIT
> NOT_IN_DIRECTORY
> NOT_IN_LOCATION
> NOT_IN_FILES
> NOT_IN_DIR_LOC_FILE
> GLOBAL_ONLY
>
> Revision Changes Path
> 1.17 +96 -0 modperl-docs/src/docs/2.0/api/Apache/Const.pod
>
> Index: Const.pod
> ===================================================================
> RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/Const.pod,v
> retrieving revision 1.16
> retrieving revision 1.17
> diff -u -r1.16 -r1.17
> --- Const.pod 9 Aug 2004 00:26:23 -0000 1.16
> +++ Const.pod 11 Aug 2004 22:52:42 -0000 1.17
> @@ -418,6 +418,102 @@
>
>
>
> +=head2 C<:context>
> +
> + use Apache::Const -compile => qw(:context);
> +
> +The C<:context> group is for constants that allow directive
> +handlers to check what kind of context (Location/Directory/Server/etc)
> +they are in. For more information, see L<Apache::CmdParms>

- It needs to point to the method where it's used. in which case you
don't even need to duplicate the explanation of their usage, have it
only in one place: the method if it's the only place it's used, here in
Const.pod if it's used in more than one place. in the latter case point
the methods that use it here.
- It needs to use a fully qualified link
- the convention for modules are C<>

e.g. the template is:

=head2 C<:conn_keepalive>

use Apache::Const -compile => qw(:conn_keepalive);

The C<:conn_keepalive> group is used by the
(C<L<$c-E<gt>keepalive|docs::2.0::api::Apache::Connection/C_keepalive_>>)
method.

Thanks.


--
__________________________________________________________________
Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org http://ticketmaster.com

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