Author: joes
Date: Tue May 17 11:31:41 2005
New Revision: 170634
URL: http://svn.apache.org/viewcvs?rev=170634&view=rev
Log:
Doc tweaks.
Added:
httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Hook/Hook.pod
httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Parser/Parser.pod
Removed:
httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Table/
Modified:
httpd/apreq/trunk/build/RELEASE
httpd/apreq/trunk/build/WEBSITE
httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.pod
httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.xs
httpd/apreq/trunk/glue/perl/xsbuilder/maps/apreq_structures.map
Modified: httpd/apreq/trunk/build/RELEASE
URL:
http://svn.apache.org/viewcvs/httpd/apreq/trunk/build/RELEASE?rev=170634&r1=170633&r2=170634&view=diff
==============================================================================
--- httpd/apreq/trunk/build/RELEASE (original)
+++ httpd/apreq/trunk/build/RELEASE Tue May 17 11:31:41 2005
@@ -5,7 +5,7 @@
% make release
- This will generate a libapreq2-2.XX-dev.tar.gz candidate in the
+ This will generate a libapreq2-2.XX.tar.gz candidate in the
current directory. You should keep this source tree
intact to tag the final release.
@@ -34,21 +34,21 @@
/** @page STATUS
- 2.XX-dev released on <today's date>.
+ 2.XX released on <today's date>.
Also add the release date to the top @section in CHANGES:
/** @page CHANGES
- @section v2_XX_dev Changes with libapreq2-2.XX-dev (released ...).
+ @section v2_XX Changes with libapreq2-2.XX (released ...).
Commit the changes and tag the tree (tr/0-9a-zA-Z/_/c in the
version number)
- % svn commit -m "2.XX-dev released." STATUS CHANGES
+ % svn commit -m "2.XX released." STATUS CHANGES
% svn cp https://svn.apache.org/repos/asf/httpd/apreq/trunk \
- https://svn.apache.org/repos/asf/httpd/apreq/tags/v2_XX_dev
+ https://svn.apache.org/repos/asf/httpd/apreq/tags/v2_XX
6. Regenerate the release
@@ -56,23 +56,23 @@
Then test and sign it via gpg:
- % gpg --detach-sign --armor libapreq2-2.XX-dev.tar.gz
+ % gpg --detach-sign --armor libapreq2-2.XX.tar.gz
or pgp:
- % pgp -sba libapreq2-2.XX-dev.tar.gz
+ % pgp -sba libapreq2-2.XX.tar.gz
7. Upload (scp) the package and signature to www.apache.org
for distribution:
- % scp libapreq2-2.XX-dev.tar.gz* \
+ % scp libapreq2-2.XX.tar.gz* \
<username>@people.apache.org:/www/www.apache.org/dist/httpd/libapreq/
Ask another developer to confirm the uploaded signature is ok.
- % gpg --verify libapreq2-2.XX-dev.tar.gz.asc
- % pgp libapreq2-2.XX-dev.tar.gz.asc
+ % gpg --verify libapreq2-2.XX.tar.gz.asc
+ % pgp libapreq2-2.XX.tar.gz.asc
Check that your public key is among those listed in the
/www/www.apache.org/dist/httpd/KEYS file. If not, you
Modified: httpd/apreq/trunk/build/WEBSITE
URL:
http://svn.apache.org/viewcvs/httpd/apreq/trunk/build/WEBSITE?rev=170634&r1=170633&r2=170634&view=diff
==============================================================================
--- httpd/apreq/trunk/build/WEBSITE (original)
+++ httpd/apreq/trunk/build/WEBSITE Tue May 17 11:31:41 2005
@@ -1,9 +1,3 @@
-build/
- General Info on the apreq community.
- Utility scripts for building & packaging httpd-apreq-2.
-
-
-
UPDATING THE WEBSITE:
(cf: http://jakarta.apache.org/site/jakarta-site2.html )
@@ -32,12 +26,12 @@
$ cd httpd-site
$ emacs xdocs/apreq
$ ant
- $ cvs commit -m "..." xdocs/apreq/ docs/apreq/
+ $ svn commit -m "..." xdocs/apreq/ docs/apreq/
5) Login (via ssh) to httpd.apache.org and do
$ cd /www/httpd.apache.org
- $ cvs update index.html apreq/
+ $ svn update index.html apreq/
Added: httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Hook/Hook.pod
URL:
http://svn.apache.org/viewcvs/httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Hook/Hook.pod?rev=170634&view=auto
==============================================================================
--- httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Hook/Hook.pod (added)
+++ httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Hook/Hook.pod Tue May 17
11:31:41 2005
@@ -0,0 +1,58 @@
+=head1 NAME
+
+APR::Request::Hook - wrapper for libapreq2's hook API.
+
+
+
+
+=head1 SYNOPSIS
+
+ use APR::Request::Hook;
+
+
+
+
+=head1 DESCRIPTION
+
+
+This manpage documents the APR::Request::Hook package.
+
+
+
+
+=head1 METHODS
+
+APR::Request::Hook
+
+
+
+
+=head2 make
+
+
+
+
+
+=head1 SEE ALSO
+
+L<< APR::Request >>, L<< APR::Request::Parser >>
+
+
+
+
+=head1 COPYRIGHT
+
+ Copyright 2003-2005 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
Added: httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Parser/Parser.pod
URL:
http://svn.apache.org/viewcvs/httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Parser/Parser.pod?rev=170634&view=auto
==============================================================================
--- httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Parser/Parser.pod (added)
+++ httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Parser/Parser.pod Tue May
17 11:31:41 2005
@@ -0,0 +1,58 @@
+=head1 NAME
+
+APR::Request::Parser - wrapper for libapreq2's parser API.
+
+
+
+
+=head1 SYNOPSIS
+
+ use APR::Request::Parser;
+
+
+
+
+=head1 DESCRIPTION
+
+
+This manpage documents the APR::Request::Parser package.
+
+
+
+
+=head1 METHODS
+
+APR::Request::Parser
+
+
+
+
+=head2 make
+
+
+
+
+
+=head1 SEE ALSO
+
+L<< APR::Request >>, L<< APR::Request::Hook >>
+
+
+
+
+=head1 COPYRIGHT
+
+ Copyright 2003-2005 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
Modified: httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.pod
URL:
http://svn.apache.org/viewcvs/httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.pod?rev=170634&r1=170633&r2=170634&view=diff
==============================================================================
--- httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.pod (original)
+++ httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.pod Tue May 17
11:31:41 2005
@@ -13,7 +13,8 @@
$pool = APR::Pool->new;
$ba = APR::BucketAlloc->new($pool);
$bb = APR::Brigade->new($pool, $ba);
- $bb->insert_tail(APR::Bucket->new($ba,
"alpha=body1&beta=body2;foo=body3"));
+ $bb->insert_tail(APR::Bucket->new($ba,
+ "alpha=body1&beta=body2;foo=body3"));
$parser = APR::Request::Parser->urlencoded($pool, $ba,
"application/x-www-form-urlencoded");
@@ -50,7 +51,34 @@
for interfacing with libapreq2's module API. It also provides
a few utility functions and constants.
-This manpage documents the APR::Request package.
+This manpage documents the APR::Request and APR::Request::Custom
+packages.
+
+
+
+=head1 METHODS
+
+APR::Request::Custom - derived from APR::Request.
+
+
+
+
+=head2 handle
+
+ APR::Request::Custom->handle($pool,
+ $query_string,
+ $cookie_header,
+ $parser,
+ $read_limit,
+ $brigade)
+
+Creates a new APR::Request::Custom object. The $query_string
+and $cookie_headers are immediately parsed into the C<args> and
+C<jar> tables. The $parser is an APR::Request::Parser object
+which is invoked when fetching C<body> entries from the $brigade.
+The $read_limit represents the maximum number of bytes this handle
+may feed into the parser.
+
@@ -62,6 +90,16 @@
+=head2 pool
+
+
+
+
+=head2 bucket_alloc
+
+
+
+
=head2 jar_status
@@ -112,16 +150,6 @@
-=head2 pool
-
-
-
-
-=head2 bucket_alloc
-
-
-
-
=head2 read_limit
@@ -205,7 +233,7 @@
=head1 SEE ALSO
L<APR::Request::Error>, L<APR::Request::Param>,
-L<APR::Request::Cookie>
+L<APR::Request::Cookie>, L<APR::Request::Parser>
Modified: httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.xs
URL:
http://svn.apache.org/viewcvs/httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.xs?rev=170634&r1=170633&r2=170634&view=diff
==============================================================================
--- httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.xs (original)
+++ httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.xs Tue May 17
11:31:41 2005
@@ -241,6 +241,8 @@
APR::Request req
CODE:
RETVAL = req->pool;
+ OUTPUT:
+ RETVAL
APR::BucketAlloc
@@ -248,6 +250,8 @@
APR::Request req
CODE:
RETVAL = req->bucket_alloc;
+ OUTPUT:
+ RETVAL
MODULE = APR::Request::Param PACKAGE = APR::Request::Param::Table
Modified: httpd/apreq/trunk/glue/perl/xsbuilder/maps/apreq_structures.map
URL:
http://svn.apache.org/viewcvs/httpd/apreq/trunk/glue/perl/xsbuilder/maps/apreq_structures.map?rev=170634&r1=170633&r2=170634&view=diff
==============================================================================
--- httpd/apreq/trunk/glue/perl/xsbuilder/maps/apreq_structures.map (original)
+++ httpd/apreq/trunk/glue/perl/xsbuilder/maps/apreq_structures.map Tue May 17
11:31:41 2005
@@ -13,7 +13,7 @@
! v
</apreq_param_t>
-<apreq_handle_t MODULE=APR::Request::Handle>
+<apreq_handle_t MODULE=APR::Request>
! module
</apreq_handle_t>
