stas 2004/08/18 00:13:39
Modified: src/docs/2.0/api/Apache compat.pod porting.pod
src/docs/2.0/api/ModPerl Const.pod Util.pod
Log:
polish
Revision Changes Path
1.10 +21 -0 modperl-docs/src/docs/2.0/api/Apache/compat.pod
Index: compat.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/compat.pod,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -u -r1.9 -r1.10
--- compat.pod 22 May 2004 02:03:27 -0000 1.9
+++ compat.pod 18 Aug 2004 07:13:39 -0000 1.10
@@ -2,6 +2,10 @@
Apache::compat -- 1.0 backward compatibility functions deprecated in 2.0
+
+
+
+
=head1 Synopsis
# either add at the very beginning of startup.pl
@@ -16,6 +20,11 @@
my ($local_port, $local_addr) = sockaddr_in($c->local_addr);
Apache::compat::restore_mp2_api('Apache::Connection::local_addr');
+
+
+
+
+
=head1 Description
C<Apache::compat> provides mod_perl 1.0 compatibility layer and can be
@@ -92,6 +101,11 @@
Both C<override_mp2_api()> and C<restore_mp2_api()> accept a list of
functions to operate on.
+
+
+
+
+
=head2 Available Overridable Functions
At the moment the following colliding functions are available for
@@ -151,6 +165,11 @@
at the very beginning of their I<startup.pl>. But this will most
certainly break the module that needed this module.
+
+
+
+
+
=head1 API
You should be reading the mod_perl 1.0 L<API
@@ -163,6 +182,8 @@
to mod_perl 2.0|docs::2.0::user::porting::compat> which covers all
mod_perl 1.0 constants, functions and methods that have changed in
mod_perl 2.0.
+
+
1.6 +10 -0 modperl-docs/src/docs/2.0/api/Apache/porting.pod
Index: porting.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/porting.pod,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -u -r1.5 -r1.6
--- porting.pod 22 May 2004 02:03:27 -0000 1.5
+++ porting.pod 18 Aug 2004 07:13:39 -0000 1.6
@@ -2,6 +2,8 @@
Apache::porting -- a helper module for mod_perl 1.0 to mod_perl 2.0 porting
+
+
=head1 Synopsis
# either add at the very beginning of startup.pl
@@ -14,6 +16,9 @@
# now issue requests and look at the error_log file for hints
+
+
+
=head1 Description
C<Apache::porting> helps to port mod_perl 1.0 code to run under
@@ -45,6 +50,7 @@
+
=head1 Culprits
C<Apache::porting> uses the C<UNIVERSAL::AUTOLOAD> function to provide
@@ -66,9 +72,13 @@
the discussion on the dev list (hint: search the archive for EazyLife)
+
+
+
=head1 See Also
L<mod_perl 2.0 documentation|docs::2.0::index>.
+
1.4 +0 -8 modperl-docs/src/docs/2.0/api/ModPerl/Const.pod
Index: Const.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/ModPerl/Const.pod,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -u -r1.3 -r1.4
--- Const.pod 4 Jul 2004 01:41:49 -0000 1.3
+++ Const.pod 18 Aug 2004 07:13:39 -0000 1.4
@@ -40,14 +40,6 @@
-=head2 C<:common>
-
- use ModPerl::Const -compile => qw(:common);
-
-The C<:common> group is for ModPerl constants.
-
-
-
=head2 Other Constants
1.9 +51 -22 modperl-docs/src/docs/2.0/api/ModPerl/Util.pod
Index: Util.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/ModPerl/Util.pod,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -u -r1.8 -r1.9
--- Util.pod 22 May 2004 02:03:28 -0000 1.8
+++ Util.pod 18 Aug 2004 07:13:39 -0000 1.9
@@ -1,6 +1,6 @@
=head1 NAME
-ModPerl::Util - Helper mod_perl 2.0 Functions
+ModPerl::Util - Helper mod_perl Functions
@@ -9,18 +9,23 @@
use ModPerl::Util;
+ # e.g. PerlResponseHandler
$callback = Apache::current_callback;
+ # exit w/o killing the interpreter
ModPerl::Util::exit();
- ModPerl::Util::untaint($) # secret API?
+ # untaint a string (do not use it! see the doc)
+ ModPerl::Util::untaint($string);
+
+
=head1 Description
-C<ModPerl::Util> provides mod_perl 2.0 util functions.
+C<ModPerl::Util> provides mod_perl utilities API.
@@ -33,33 +38,21 @@
-=head2 C<untaint>
-
-Untaint the variable, by turning its tainted bit off (used internally).
-
- untaint($var);
-
-=over 4
-
-=item arg1: C<$var> (scalar)
-
-=item ret: no return value
-
-=back
-Do not use this function unless you know what you are doing. To learn
-how to properly untaint variables refer to the I<perlsec> manpage.
=head2 C<current_callback>
-Returns the currently running callback, like 'PerlResponseHandler'.
+Returns the currently running callback name,
+e.g. C<'PerlResponseHandler'>.
$callback = Apache::current_callback();
=over 4
-=item ret: C<$callback> (string)
+=item ret: C<$callback> ( string )
+
+=item since: 1.99_12
=back
@@ -67,6 +60,8 @@
+
+
=head2 C<exit>
Terminate the request, but not the current process (or not the current
@@ -76,9 +71,10 @@
=over 4
-=item opt arg1: C<$status> (integer)
+=item opt arg1: C<$status> ( integer )
-The exit status, which as of this writing is ignored.
+The exit status, which as of this writing is ignored. (it's accepted
+to be compatible with the core C<exit> function.)
=item ret: no return value
@@ -132,9 +128,42 @@
you really want to avoid under mod_perl.
+
+
+
+
+=head2 C<untaint>
+
+Untaint the variable, by turning its tainted SV flag off (used
+internally).
+
+ ModPerl::Util::untaint($tainted_var);
+
+=over 4
+
+=item arg1: C<$tainted_var> (scalar)
+
+=item ret: no return value
+
+C<$tainted_var> is untainted.
+
+=item since: 1.99_12
+
+=back
+
+Do not use this function unless you know what you are doing. To learn
+how to properly untaint variables refer to the I<perlsec> manpage.
+
+
+
+
+
+
=head1 See Also
L<mod_perl 2.0 documentation|docs::2.0::index>.
+
+
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
