apr-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dave Seidel" <d...@mindreef.com>
Subject RE: APR_RING_* documentation?
Date Thu, 17 Oct 2002 14:05:01 GMT
Thanks, Cliff (& Tony), that's exactly what I discovered.  This is
valuable, but time-consuming, because I have to read through a fairly
complex subsystem but focus on its use of one particular set of calls.
As with all non-trivial APIs, it is usually helpful to have some prose
that establishes context, requirements, and usage patterns (I don't mean
formally, but just basically "here's how you should use this stuff");
this is a pain to extract from a series of comments.  I'm surprised that
there appear to be no test cases for this code, especially given how
important it is to the httpd infrastructure -- an entry in apr-util/test
would have probably been sufficient to help me and others to get quickly
up to speed.

- Dave

-----Original Message-----
From: Cliff Woolley [mailto:jwoolley@virginia.edu] 
Sent: Thursday, October 17, 2002 9:36 AM
To: Dave Seidel
Cc: APR developers
Subject: Re: APR_RING_* documentation?

On Thu, 17 Oct 2002, Dave Seidel wrote:

> Is there ant documentation on the APR_RING_* macros besides the 
> comments in apr_ring.h, e.g., does anyone know of any articles on how 
> these macros should be used?  Thanks in advance.

The documentation in the header file is pretty much it.  Though it's
helpful to see how they're used by example; for that, take a look at the
bucket brigades code in APR-util (apr_buckets.h and buckets/*.c).


View raw message