joes 2003/06/27 15:03:53
Modified: . README STATUS
glue/perl README
Added: . CHANGES INSTALL
Log:
Add INSTALL, CHANGES, etc.
Revision Changes Path
1.4 +2 -0 httpd-apreq-2/README
Index: README
===================================================================
RCS file: /home/cvs/httpd-apreq-2/README,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- README 15 Jun 2003 05:29:03 -0000 1.3
+++ README 27 Jun 2003 22:03:52 -0000 1.4
@@ -43,6 +43,8 @@
in the main directory.
+ The Perl API documentation ...XXX...
+
Installation
------------
1.14 +5 -2 httpd-apreq-2/STATUS
Index: STATUS
===================================================================
RCS file: /home/cvs/httpd-apreq-2/STATUS,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- STATUS 27 Jun 2003 16:33:20 -0000 1.13
+++ STATUS 27 Jun 2003 22:03:52 -0000 1.14
@@ -28,7 +28,10 @@
TODO:
- * Settle on the Perl API and start tracking CHANGES.
+ * Adopt a versioning system for the various components:
+ 1) src/, (libtool-based)
+ 2) env/, (module-magic-number ?)
+ 3) glue/, (per-language ?)
* Improve documentation system:
1.1 httpd-apreq-2/CHANGES
Index: CHANGES
===================================================================
=head Changes with libapreq-2.0.0-dev
=over 4
=item June 27, 2003 - C API [joes]
The new filter-based design required a complete
departure from libapreq-1.X codebase. libapreq-2
is based solely on APR, and to be fully functional,
requires a supporting environment similar to Apache-2.
A person wishing to port libapreq-2 to a new environment
needs to provide definitions for the declarations in apreq_env.h.
=item June 27, 2003 - Perl API [joes]
Aggregates are always collected into an APR::Table-based package.
New table packages: Apache::Cookie::Table, Apache::Request::Table,
and Apache::Upload::Table.
=item June 27, 2003 - Perl API [joes]
Apache::Cookie->fetch now requires an "environment" argument ($r).
Its return value is blessed into the Apache::Cookie::Jar class.
=item June 27, 2003 - Perl API [joes]
Two new request lookup functions:
1) $req->args - param lookup using only the query string
2) $req->body - param lookup using only the POST data
=back
1.1 httpd-apreq-2/INSTALL
Index: INSTALL
===================================================================
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 install
(optional)% make perl_install
Win32 build:
1.5 +32 -11 httpd-apreq-2/glue/perl/README
Index: README
===================================================================
RCS file: /home/cvs/httpd-apreq-2/glue/perl/README,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- README 15 Jun 2003 10:33:00 -0000 1.4
+++ README 27 Jun 2003 22:03:53 -0000 1.5
@@ -1,9 +1,31 @@
-NOTES on xsbuilder/
+To parse the libapreq headers into xsbuilder/tables:
- maps/ - stores
+ % perl ../../build/xsbuilder.pl run
+To build the xs/ directory and configure the tests:
+ % perl Makefile.PL -apxs /path/to/apache2/bin/apxs
+To run the test suite:
+
+ % make test
+
+
+
+
+DEVELOPER NOTES
+
+xsbuilder/ (analogous to modperl-2.0/xs directory)
+
+ apreq_xs_postperl.h - helper functions & macros for XS
+ maps/ - files used to generate xs/ bindings
+ Apache/
+ Request/
+ Apache__Request.h - custom XS code for Request.xs
+ Request_pm - perl code included in Request.pm
+ Cookie/
+ Apache__Cookie.h - custom XS for Cookie.xs
+ Cookie_pm - perl code included in Cookie.pm
current class diagram:
@@ -11,25 +33,24 @@
// \\
- fetch // \\ new
+Apache::Cookie->fetch// \\Apache::Request->new
// \\
- Apache::Cookie::Jar Apache::Request
+ Apache::Cookie::Jar Apache::Request
- cookies / \ \ args, body, params
+ cookies / / upload \ args, body, params
- Apache::Cookie::Table \ get Apache::Request::Table
+ Apache::Cookie::Table Apache::Upload::Table Apache::Request::Table
- get \ \
+ / get / get
- Apache::Cookie
+ Apache::Cookie Apache::Upload
legend: double lines ("//" or "\\") represent an inheritance relationship.
single lines ("/" or "\") represent method calls.
-missing components: Apache::Request::Upload
- Apache::Request::Parser
- Apache::Request::Util
+missing components: Apache::Request::Parser
+
