joes 2003/10/18 14:03:06
Modified: . INSTALL Makefile.am README STATUS
build doxygen.conf
glue Makefile.am
Log:
Bring README & INSTALL up to date
Revision Changes Path
1.8 +9 -12 httpd-apreq-2/INSTALL
Index: INSTALL
===================================================================
RCS file: /home/cvs/httpd-apreq-2/INSTALL,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- INSTALL 8 Oct 2003 17:44:18 -0000 1.7
+++ INSTALL 18 Oct 2003 21:03:06 -0000 1.8
@@ -24,24 +24,22 @@
Unix build, where libtool/automake/autoconf works:
- (optional)% ./buildconf
% ./configure --with-apache2-apxs=/path/to/apache2/bin/apxs
- % make && make test
- (optional)% make perl_glue
- (optional)% make perl_test
+ % make
+ (optional)% make test
% make install
- (optional)% make perl_install
-Or using the CPAN/perlish way:
+Or using the CPAN/perlish way (which includes the Apache::Request and
+Apache::Cookie modules):
- (optional)% ./buildconf
% perl Makefile.PL --with-apache2-apxs=/path/to/apache2/bin/apxs
- % make && make test
- (optional)% make perl_glue
- (optional)% make perl_test
+ % make
+ (optional)% make test
% make install
- (optional)% make perl_install
+
+Developers and other folks using httpd-apreq-2 directly from cvs need to
+execute "./buildconf" prior to running "./configure".
Alternately, here's a recipe to install mod_apreq.c as a static apache
module:
@@ -60,7 +58,6 @@
% ./configure --with-apache2-src=/path/to/httpd-2.0
% make
(optional)% make test
- % make httpd_install
% make install
1.16 +2 -2 httpd-apreq-2/Makefile.am
Index: Makefile.am
===================================================================
RCS file: /home/cvs/httpd-apreq-2/Makefile.am,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- Makefile.am 17 Oct 2003 06:27:20 -0000 1.15
+++ Makefile.am 18 Oct 2003 21:03:06 -0000 1.16
@@ -20,8 +20,8 @@
apreq2_config:
dist-hook:
- rm -rf `find $(distdir)/build -name CVS`
- rm -rf `find $(distdir)/build -name '*~'`
+ rm -rf `find $(distdir) -name '*CVS'`
+ rm -rf `find $(distdir) -name '*~'`
docs: src env glue build/doxygen.conf
doxygen build/doxygen.conf
1.5 +52 -28 httpd-apreq-2/README
Index: README
===================================================================
RCS file: /home/cvs/httpd-apreq-2/README,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- README 27 Jun 2003 22:03:52 -0000 1.4
+++ README 18 Oct 2003 21:03:06 -0000 1.5
@@ -3,66 +3,90 @@
What is it?
-----------
- httpd-apreq (aka `apreq') is subproject of the Apache HTTP Server Project
- whose membership (aka apreq's `committers') develops and maintains the
+ libapreq (aka `apreq') is subproject of the Apache HTTP Server Project
+ whose membership (the apreq `committers') develops and maintains the
libapreq software library.
libapreq is a safe, standards-compliant, high-performance library
used for parsing HTTP cookies, query-strings and POST data. The
- original version (libapreq-1) was designed by Lincoln Stein and Doug
+ original version (libapreq-1.X) was designed by Lincoln Stein and Doug
MacEachern. The perl APIs Apache::Request and Apache::Cookie are the
lightweight mod_perl analogs of the CGI and CGI::Cookie perl modules.
- The 2.0 version of libapreq is an improved version that's been
- completely redesigned around Apache-2's input filter API. Here's
- a brief list of new features:
-
- * provides overridable parsers for "application/x-www-form-urlencoded",
- "multipart/form-data", and in the future "application/xml" enctypes.
-
- * accepts chunked POST data.
-
- * Support for RFC-based Cookies.
-
- * XForms?
+ Version 2 of libapreq is an improved codebase designed around APR
+ and Apache-2's input filter API. The C codebase is separated into
+ two independent components:
+
+ 1) libapreq2, the shared library. This libarary is based
+ solely on libapr and libaprutil, and requires linking
+ applications to provide stub code for the apreq_env
+ interface (defined by the "apreq_env.h" header file).
+ The source files for libapreq2 are in the src/ directory.
+
+ 2) A collection of "environment" modules which provide the
+ aforementioned supporting functions for the apreq_env API.
+ The modules' source files are in the env/ directory.
+ Two supported modules are now available
+
+ 1) mod_apreq - an Apache 2 filter module,
+
+ 2) libapreq_cgi - a static library for creating
+ CGI applications with libapreq2.
+
+
+ Version 2 also includes the perl APIs for libapreq2- Apache::Request
+ and Apache::Cookie. The corresponding XS modules are generated in
+ perl/glue/xs by ExtUtils::XSBuilder, which is based on the new build
+ system created specifically for modperl-2.
The Latest Version
------------------
Details of the latest version can be found on the libapreq
- project page under http://httpd.apache.org/apreq.
+ project page at
+
+ http://httpd.apache.org/apreq
+
Documentation
-------------
- The C API documentation is in the docs/ directory. It is
+ The documentation is in the docs/ directory. It is
based on Doxygen, and can be regenerated by typing
% make docs
in the main directory.
- The Perl API documentation ...XXX...
Installation
------------
For full details please consult the INSTALL file. Briefly,
+ to install just the C API (libapreq2 + environment modules)
+ on a Unix-like system:
% ./configure --with-apache2-apxs=/path/to/apache2/bin/apxs
- % make && make test
- (optional)% make perl_glue
- (optional)% make perl_test
+ % make
+ % make test
+ % make install
+
+ To build and install the perl API as well, either add
+ the "--enable-perl-glue" configure option, or let Makefile.PL
+ enable it for you:
+
+ % perl Makefile.PL --with-apache2-apxs=/path/to/apache2/bin/apxs
+ % make
+ % make test
% make install
- (optional)% make perl_install
-
Licensing
---------
Please see the file called LICENSE.
+
Contacts
--------
@@ -79,7 +103,7 @@
Java API - XXX
Python API - XXX
- developer list (bugs, patches, etc.):
+ developer list (bugs, patches, code contributions, etc.):
[EMAIL PROTECTED]
@@ -89,10 +113,10 @@
We wish to acknowledge the following copyrighted works that
make up portions of the Apache software:
- libapreq relies heavily on the use of GNU autoconf, automake and
- libtool to provide a build environment. The core unit tests for
- libapreq are based upon CuTest. The environment and perl glue
- tests are based on Apache::Test.
+ libapreq version 2 relies heavily on the use of GNU autoconf,
+ automake and libtool to provide a build environment. The core
+ unit tests for libapreq are based upon CuTest. The environment
+ and perl glue tests are based on Apache::Test.
Doxygen generates the documentation for libapreq-2. The perl glue
and pods are generated by ExtUtils::XSBuilder.
1.26 +9 -5 httpd-apreq-2/STATUS
Index: STATUS
===================================================================
RCS file: /home/cvs/httpd-apreq-2/STATUS,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- STATUS 13 Oct 2003 18:24:46 -0000 1.25
+++ STATUS 18 Oct 2003 21:03:06 -0000 1.26
@@ -15,10 +15,14 @@
RELEASE SHOWSTOPPERS:
- - Choose a versioning system:
- -# src/, (libtool-based, following apr)
- -# env/, (module-magic-number ?)
- -# glue/, (per-language ?)
+ - Incorporate prereq checks into build system:
+
+ -# autoconf et.al version tests in buildconf,
+ -# perl module checks in Makefile.PL,
+ -# doxygen, ap[ru] & httpd version checks in configure.ac
+
+ - Fix *nix build system so "% make dist" generates a CPAN-friendly
+ and fully functional tarball.
CURRENT VOTES:
1.6 +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.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- doxygen.conf 10 Jul 2003 04:35:18 -0000 1.5
+++ doxygen.conf 18 Oct 2003 21:03:06 -0000 1.6
@@ -17,7 +17,7 @@
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
-PROJECT_NAME = libapreq-2
+PROJECT_NAME = libapreq2
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
1.3 +0 -2 httpd-apreq-2/glue/Makefile.am
Index: Makefile.am
===================================================================
RCS file: /home/cvs/httpd-apreq-2/glue/Makefile.am,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Makefile.am 17 Oct 2003 14:49:12 -0000 1.2
+++ Makefile.am 18 Oct 2003 21:03:06 -0000 1.3
@@ -1,8 +1,6 @@
EXTRA_DIST = perl
dist-hook:
- rm -rf `find $(distdir)/glue -name CVS`
- rm -rf `find $(distdir)/glue -name '*~'`
perl_config:
cd perl; @PERL@ ../../build/xsbuilder.pl run
