dougm 01/02/18 14:00:48
Modified: pod modperl_style.pod
Log:
document modperl C code prefix conventions
Revision Changes Path
1.2 +26 -0 modperl-2.0/pod/modperl_style.pod
Index: modperl_style.pod
===================================================================
RCS file: /home/cvs/modperl-2.0/pod/modperl_style.pod,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- modperl_style.pod 2001/01/02 19:56:08 1.1
+++ modperl_style.pod 2001/02/18 22:00:48 1.2
@@ -11,6 +11,32 @@
mod_perl C code follows the Apache style guide:
http://dev.apache.org/styleguide.html
+=head2 Prefixes
+
+=over 4
+
+=item modperl_
+
+The prefix for mod_perl C API functions.
+
+=item MP_
+
+The prefix for mod_perl C macros.
+
+=item mpxs_
+
+The prefix for mod_perl XS utility functions.
+
+=item mp_xs_
+
+The prefix for mod_perl I<generated> XS utility functions.
+
+=item MPXS_
+
+The prefix for mod_perl XSUBs with an XS() prototype.
+
+=back
+
=head1 XS code
C code inside xs modules also follows the Apache style guide.
