You are viewing a plain text version of this content. The canonical link for it is here.
Posted to apreq-cvs@httpd.apache.org by jo...@apache.org on 2003/10/29 03:20:24 UTC
cvs commit: httpd-apreq-2/src apreq_env.c apreq_version.h
joes 2003/10/28 18:20:24
Modified: . CHANGES INSTALL MANIFEST.SKIP Makefile.am
configure.ac
build doxygen.conf
env mod_apreq.c
glue/perl/xsbuilder/Apache/Cookie Cookie_pod
glue/perl/xsbuilder/Apache/Request Request_pod
src apreq_env.c apreq_version.h
Log:
Mainly doxygen fixes. Add prebuild docs/ directory to the release tarball. Also stop using library version numbers 2.X.Y where package versions are required 2.XX
Revision Changes Path
1.15 +3 -3 httpd-apreq-2/CHANGES
Index: CHANGES
===================================================================
RCS file: /home/cvs/httpd-apreq-2/CHANGES,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- CHANGES 27 Oct 2003 03:07:28 -0000 1.14
+++ CHANGES 29 Oct 2003 02:20:24 -0000 1.15
@@ -1,8 +1,8 @@
/** @page CHANGES
-@section 2.0.1-dev Changes with libapreq2-2.0.1-dev
+@section 2.01-dev Changes with libapreq2-2.01-dev
--October 26, 2003 - C API [joes]
+- October 26, 2003 - C API [joes]
Incorporate libapreq_cgi into libapreq2 as the default environment,
and add apreq_env_t and initializer apreq_env_module() to manage the
@@ -10,7 +10,7 @@
was problematic on non-ELF systems).
-@section 2.0.0-dev Changes with libapreq2-2.0.0-dev
+@section 2.00-dev Changes with libapreq2-2.00-dev
- October 24, 2003 - C API: libapreq_cgi.c [randyk, joes]
1.10 +3 -16 httpd-apreq-2/INSTALL
Index: INSTALL
===================================================================
RCS file: /home/cvs/httpd-apreq-2/INSTALL,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- INSTALL 27 Oct 2003 22:51:57 -0000 1.9
+++ INSTALL 29 Oct 2003 02:20:24 -0000 1.10
@@ -1,22 +1,9 @@
PREREQUISITES:
-C API:
- libapr/libaprutil 0.9.4
- apache w/ mod_so 2.0.46
- Apache::Test 1.0.3
+Please see the PREREQUISITES file. If you are building httpd-apreq-2
+directly from cvs, you can generate the list of prerequisites:
-Perl API:
- perl 5.6.1
- mod_perl-2 1.99_9-dev
- ExtUtils::XSBuilder 0.23
-
-Documentation (CVS):
- doxygen 1.3
-
-GNU auto* build system (CVS):
- libtool 1.4.2
- autoconf 2.53
- automake 1.6.3
+ % perl build/version_check.pl
INSTRUCTIONS:
1.2 +1 -0 httpd-apreq-2/MANIFEST.SKIP
Index: MANIFEST.SKIP
===================================================================
RCS file: /home/cvs/httpd-apreq-2/MANIFEST.SKIP,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- MANIFEST.SKIP 28 Oct 2003 14:00:06 -0000 1.1
+++ MANIFEST.SKIP 29 Oct 2003 02:20:24 -0000 1.2
@@ -28,6 +28,7 @@
# perl glue
glue/perl/blib
glue/perl/xsbuilder/tables
+glue/perl/xs\b
#Apache Test stuff
t/TEST$
1.18 +23 -7 httpd-apreq-2/Makefile.am
Index: Makefile.am
===================================================================
RCS file: /home/cvs/httpd-apreq-2/Makefile.am,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- Makefile.am 28 Oct 2003 14:00:06 -0000 1.17
+++ Makefile.am 29 Oct 2003 02:20:24 -0000 1.18
@@ -1,12 +1,13 @@
AUTOMAKE_OPTIONS = foreign
SUBDIRS = src env glue t
-EXTRA_DIST = README INSTALL CHANGES MANIFEST.SKIP Makefile.PL build win32
+EXTRA_DIST = README INSTALL CHANGES MANIFEST.SKIP Makefile.PL buildconf build win32 docs
APU_SRCDIR=`@APU_CONFIG@ --srcdir`
APR_SRCDIR=`@APR_CONFIG@ --srcdir`
APU_DOX = (cd $(APU_SRCDIR); cat - docs/doxygen.conf | doxygen -)
APR_DOX = (cd $(APR_SRCDIR); cat - docs/doxygen.conf | doxygen -)
-COOKIE_POD=glue/perl/blib/lib/Apache/Cookie.pod
-REQUEST_POD=glue/perl/blib/lib/Apache/Request.pod
+POD_PREFIX=glue/perl/xsbuilder/Apache
+COOKIE_POD=$(POD_PREFIX)/Cookie/Cookie_pod
+REQUEST_POD=$(POD_PREFIX)/Request/Request_pod
SED_BODY_TAG= s(^[\S\s]+<body.+|</body>[\S\s]+$$)()gi
EUM=ExtUtils::Manifest
@@ -18,10 +19,9 @@
PERL_TEST =
endif
-release: distdir
+release: reconfig docs_clean docs distdir
@PERL@ build/version_check.pl > $(distdir)/PREREQUISITES
echo MANIFEST > $(distdir)/MANIFEST
- cd $(distdir); ./buildconf
@cd $(distdir); @PERL@ -M$(EUM) -e "$(EUM)::mkmanifest"
@PERL@ -ple '$$_="$(distdir)/$$_"' $(distdir)/MANIFEST | tar -czf $(distdir).tar.gz -T -
rm -rf $(distdir)
@@ -37,9 +37,21 @@
apreq2_config:
-docs: src env glue build/doxygen.conf
+reconfig:
+ ./buildconf
+ ./config.status
+
+docs_clean:
+ -rm -rf docs
+
+docs: src env glue build/doxygen.conf apr_tags pod2html
doxygen build/doxygen.conf
+docs_install: docs
+ @$(NORMAL_INSTALL)
+ $(mkinstalldirs) $(DESTDIR)$(pkgdatadir)
+ cp -a docs $(DESTDIR)$(pkgdatadir)
+
pod2html: Request.html Cookie.html
Cookie.html: Makefile.am $(COOKIE_POD)
@@ -47,9 +59,13 @@
Request.html: Makefile.am $(REQUEST_POD)
pod2html <$(REQUEST_POD)| perl -0777 -pe '$(SED_BODY_TAG)' > Request.html
-apr_tags:
+apr_tags: docs/apr.tag docs/apu.tag
+
+docs/apu.tag:
-mkdir docs
echo GENERATE_TAGFILE=`pwd`/docs/apu.tag | $(APU_DOX)
+docs/apr.tag:
+ -mkdir docs
echo GENERATE_TAGFILE=`pwd`/docs/apr.tag | $(APR_DOX)
test: lib_test env_test $(PERL_TEST)
1.11 +1 -1 httpd-apreq-2/configure.ac
Index: configure.ac
===================================================================
RCS file: /home/cvs/httpd-apreq-2/configure.ac,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- configure.ac 27 Oct 2003 22:51:57 -0000 1.10
+++ configure.ac 29 Oct 2003 02:20:24 -0000 1.11
@@ -1,7 +1,7 @@
dnl Process this file with autoconf to produce a configure script.
AC_PREREQ(2.53)
-AC_INIT(libapreq - Apache Request Library, 2.0.1-dev, apreq-dev@httpd.apache.org, libapreq2)
+AC_INIT(libapreq - Apache Request Library, 2.01-dev, apreq-dev@httpd.apache.org, libapreq2)
dnl this:
dnl AC_CONFIG_AUX_DIR(build)
1.7 +1 -1 httpd-apreq-2/build/doxygen.conf
Index: doxygen.conf
===================================================================
RCS file: /home/cvs/httpd-apreq-2/build/doxygen.conf,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- doxygen.conf 18 Oct 2003 21:03:06 -0000 1.6
+++ doxygen.conf 29 Oct 2003 02:20:24 -0000 1.7
@@ -333,7 +333,7 @@
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories.
-EXCLUDE_PATTERNS = apreq_tables*
+EXCLUDE_PATTERNS = apreq_tables* apreq_config*
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
1.34 +40 -21 httpd-apreq-2/env/mod_apreq.c
Index: mod_apreq.c
===================================================================
RCS file: /home/cvs/httpd-apreq-2/env/mod_apreq.c,v
retrieving revision 1.33
retrieving revision 1.34
diff -u -r1.33 -r1.34
--- mod_apreq.c 27 Oct 2003 03:07:28 -0000 1.33
+++ mod_apreq.c 29 Oct 2003 02:20:24 -0000 1.34
@@ -69,23 +69,6 @@
#define dR request_rec *r = (request_rec *)env
-/**
- * @file mod_apreq.c
- * @brief Source for mod_apreq.so.
- */
-
-/**
- * Uses apxs to compile and install.
- * @defgroup mod_apreq mod_apreq.so
- * @ingroup MODULES
- * @brief Apache-2 filter module.
- * @{
- */
-
-
-#define APREQ_MODULE_NAME "APACHE2"
-#define APREQ_MODULE_MAGIC_NUMBER 20031025
-
/** The warehouse. */
struct env_config {
apreq_jar_t *jar;
@@ -104,6 +87,41 @@
static const char filter_name[] = "APREQ";
module AP_MODULE_DECLARE_DATA apreq_module;
+/**
+ * @file mod_apreq.c
+ * @brief Source code for Apache-2 filter module
+ */
+
+/**
+ * mod_apreq.c provides an input filter for using libapreq2
+ * (and allow its parsed data structures to be shared) within
+ * the Apache-2 webserver. Using it, libapreq2 works properly
+ * in every phase of the HTTP request, from translation handlers
+ * to output filters, and even for subrequests / internal redirects.
+ *
+ * After installing mod_apreq, be sure your webserver's
+ * httpd.conf activates it on startup with a LoadModule directive:
+ * <pre><code>
+ *
+ * LoadModule modules/mod_apreq.so
+ *
+ * </code></pre>
+ * Normally the installation process triggered by '% make install'
+ * will make the necessary changes to httpd.conf for you.
+ *
+ * XXX describe normal operation, effects of apreq_config_t settings, etc.
+ *
+ * @defgroup mod_apreq Apache-2 Filter Module
+ * @ingroup MODULES
+ * @brief mod_apreq.c: Apache-2 filter module
+ * @{
+ */
+
+
+#define APREQ_MODULE_NAME "APACHE2"
+#define APREQ_MODULE_MAGIC_NUMBER 20031025
+
+
static void apache2_log(const char *file, int line, int level,
apr_status_t status, void *env, const char *fmt,
va_list vp)
@@ -132,10 +150,10 @@
return apr_table_get(r->headers_in, name);
}
-/**
- * r->headers_out.
+/*
+ * r->headers_out ~> r->err_headers_out ?
* @bug Sending a Set-Cookie header on a 304
- * requires a different header table.
+ * requires err_headers_out table.
*/
static apr_status_t apache2_header_out(void *env, const char *name,
char *value)
@@ -443,6 +461,8 @@
AP_FTYPE_CONTENT_SET);
}
+/** @} */
+
module AP_MODULE_DECLARE_DATA apreq_module =
{
STANDARD20_MODULE_STUFF,
@@ -454,4 +474,3 @@
register_hooks, /* callback for registering hooks */
};
-/** @} */
1.3 +0 -8 httpd-apreq-2/glue/perl/xsbuilder/Apache/Cookie/Cookie_pod
Index: Cookie_pod
===================================================================
RCS file: /home/cvs/httpd-apreq-2/glue/perl/xsbuilder/Apache/Cookie/Cookie_pod,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Cookie_pod 15 Jul 2003 03:44:29 -0000 1.2
+++ Cookie_pod 29 Oct 2003 02:20:24 -0000 1.3
@@ -21,8 +21,6 @@
interface is identical to I<CGI::Cookie>. Please consult the L<CGI::Cookie>
documentation for more details.
-=over 4
-
=head2 new
Just like CGI::Cookie::new, but requires an I<Apache> request object:
@@ -126,8 +124,6 @@
my $secure = $cookie->secure;
$cookie->secure(1);
-=back
-
=head1 CHANGES to the v1 API:
=over 4
@@ -146,10 +142,6 @@
=back
=head1 BUGS
-
-=over 4
-
-=back
=head1 SEE ALSO
1.3 +0 -8 httpd-apreq-2/glue/perl/xsbuilder/Apache/Request/Request_pod
Index: Request_pod
===================================================================
RCS file: /home/cvs/httpd-apreq-2/glue/perl/xsbuilder/Apache/Request/Request_pod,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Request_pod 15 Jul 2003 13:15:10 -0000 1.2
+++ Request_pod 29 Oct 2003 02:20:24 -0000 1.3
@@ -35,8 +35,6 @@
=back
-=over 4
-
=head2 new [NEEDS REWRITE: No longer require Apache* objects]
Create a new I<Apache::Request> object with an I<Apache::RequestRec> object $r:
@@ -209,8 +207,6 @@
my $upload = $apr->upload($name);
-=back
-
=head1 SUBCLASSING Apache::Request [WRONG- This is unnecessary now]
The Apache::Request class cannot be subclassed directly because its constructor
@@ -273,8 +269,6 @@
=head1 Apache::Upload METHODS
-=over 4
-
=head2 name
The name of the filefield parameter:
@@ -357,8 +351,6 @@
Typically the new name must lie on the same file system as the
spool file. Check your system's link(2) manpage for details.
-
-=back
=head1 SEE ALSO
1.2 +16 -17 httpd-apreq-2/src/apreq_env.c
Index: apreq_env.c
===================================================================
RCS file: /home/cvs/httpd-apreq-2/src/apreq_env.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- apreq_env.c 27 Oct 2003 03:07:28 -0000 1.1
+++ apreq_env.c 29 Oct 2003 02:20:24 -0000 1.2
@@ -67,17 +67,7 @@
/**
* @file apreq_env.c
- * @brief Source for libapreq_cgi.a.
- */
-
-/**
- * libapreq_cgi is a static library that CGI "scripts" (written
- * in C) can link against to to have libapreq work in a CGI environment.
- *
- * @defgroup libapreq_cgi libapreq_cgi.a
- * @ingroup MODULES
- * @brief Static library for linking libapreq to a CGI C-script.
- * @{
+ * @brief Implements logging and environment hooks, also the default CGI module.
*/
static const apreq_env_t *apreq_env;
@@ -143,12 +133,6 @@
return apreq_env->read(env,block,bytes);
}
-
-/** Default CGI module extracted from libapreq_cgi */
-
-#define APREQ_MODULE_NAME "CGI"
-#define APREQ_MODULE_MAGIC_NUMBER 20031025
-
#define dP apr_pool_t *p = (apr_pool_t *)env
static struct {
@@ -166,6 +150,21 @@
"Lookup of %s failed: status=%d", k, rc); \
} \
} while (0)
+
+
+/**
+ * CGI is the default environment module included in libapreq2...
+ * XXX add more info here XXX
+ *
+ * @defgroup CGI Common Gateway Interface
+ * @ingroup MODULES
+ * @brief apreq_env.c: libapreq2's default CGI module
+ * @{
+ */
+
+
+#define APREQ_MODULE_NAME "CGI"
+#define APREQ_MODULE_MAGIC_NUMBER 20031025
static apr_pool_t *cgi_pool(void *env)
{
1.3 +3 -5 httpd-apreq-2/src/apreq_version.h
Index: apreq_version.h
===================================================================
RCS file: /home/cvs/httpd-apreq-2/src/apreq_version.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- apreq_version.h 27 Oct 2003 03:07:28 -0000 1.2
+++ apreq_version.h 29 Oct 2003 02:20:24 -0000 1.3
@@ -64,9 +64,7 @@
/**
* @file apreq_version.h
- * @brief
- *
- * libapreq's Version
+ * @brief Versioning API for libapreq
*
* There are several different mechanisms for accessing the version. There
* is a string form, and a set of numbers; in addition, there are constants
@@ -117,14 +115,14 @@
APREQ_IS_DEV_STRING
/**
- * Return APR-util's version information information in a numeric form.
+ * Return libapreq's version information information in a numeric form.
*
* @param pvsn Pointer to a version structure for returning the version
* information.
*/
APREQ_DECLARE(void) apreq_version(apr_version_t *pvsn);
-/** Return APU's version information as a string. */
+/** Return libapreq's version information as a string. */
APREQ_DECLARE(const char *) apreq_version_string(void);