apr-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Cliff Woolley <cliffwool...@yahoo.com>
Subject docco problem (was RE: Chunk filter problem?)
Date Tue, 13 Feb 2001 18:25:31 GMT

> -----Original Message-----
> Okay, I'm not 100% sure on this, but I think I spotted a problem in the
> chunk filter such that two immortal buckets are getting inserted AFTER the
> EOS bucket by means of transposed parameters to the
> APR_BUCKET_INSERT_BEFORE macro.

Okay, I had it the wrong way around, thankfully.  It's the documentation
that's got it wrong, not the chunk filter.  So nix the chunk filter patch,
as it's incorrect.  Instead, we just need to change the docco in
apr_buckets.h in APR-UTIL to reflect reality:

Index: apr_buckets.h
===================================================================
RCS file: /home/cvspublic/apr-util/include/apr_buckets.h,v
retrieving revision 1.73
diff -u -r1.73 apr_buckets.h
--- apr_buckets.h	2001/02/11 15:50:10	1.73
+++ apr_buckets.h	2001/02/13 18:21:46
@@ -338,16 +338,16 @@

 /**
  * Insert a list of buckets before a specified bucket
- * @param a The buckets to insert
- * @param b The bucket to insert before
+ * @param a The bucket to insert before
+ * @param b The buckets to be inserted
  * @deffunc void APR_BUCKET_INSERT_BEFORE(apr_bucket *a, apr_bucket *b)
  */
 #define APR_BUCKET_INSERT_BEFORE(a, b)					\
 	APR_RING_INSERT_BEFORE((a), (b), link)
 /**
  * Insert a list of buckets after a specified bucket
- * @param a The buckets to insert
- * @param b The bucket to insert after
+ * @param a The bucket to insert after
+ * @param b The buckets to be inserted
  * @deffunc void APR_BUCKET_INSERT_AFTER(apr_bucket *a, apr_bucket *b)
  */
 #define APR_BUCKET_INSERT_AFTER(a, b)					\



It'd be really nice if the ring macros were documented, as that would have
cleared up this confusion pretty quickly (as it was, I had to trace through
the ring macros on a whiteboard to make absolutely sure of which way around
they were supposed to go).  I don't suppose anyone would object if I
documented them?  =-)

--Cliff


Mime
View raw message