Author: rhuijben
Date: Thu Oct 8 08:35:00 2015
New Revision: 1707448
URL: http://svn.apache.org/viewvc?rev=1707448&view=rev
Log:
Following up on r1707445, replace ### comment by comments on the public api.
* buckets/aggregate_buckets.c
(serf_bucket_aggregate_become): Remove ### comment.
* serf_bucket_types.h
(serf_bucket_request_become,
serf_bucket_aggregate_become): Document that caller should cleanup.
Modified:
serf/trunk/buckets/aggregate_buckets.c
serf/trunk/serf_bucket_types.h
Modified: serf/trunk/buckets/aggregate_buckets.c
URL:
http://svn.apache.org/viewvc/serf/trunk/buckets/aggregate_buckets.c?rev=1707448&r1=1707447&r2=1707448&view=diff
==============================================================================
--- serf/trunk/buckets/aggregate_buckets.c (original)
+++ serf/trunk/buckets/aggregate_buckets.c Thu Oct 8 08:35:00 2015
@@ -142,10 +142,6 @@ void serf_bucket_aggregate_become(serf_b
bucket->data = ctx;
/* The allocator remains the same. */
-
- /* ### How does this handle the data of the original bucket?
- ### We should probably undo this step on destroy, to
- ### allow proper cleanup */
}
Modified: serf/trunk/serf_bucket_types.h
URL:
http://svn.apache.org/viewvc/serf/trunk/serf_bucket_types.h?rev=1707448&r1=1707447&r2=1707448&view=diff
==============================================================================
--- serf/trunk/serf_bucket_types.h (original)
+++ serf/trunk/serf_bucket_types.h Thu Oct 8 08:35:00 2015
@@ -61,6 +61,10 @@ void serf_bucket_request_set_CL(
serf_bucket_t *serf_bucket_request_get_headers(
serf_bucket_t *request);
+/** Transform @a bucket in-place into a request bucket.
+ *
+ * It is callers responsibility to free resources held by the original
+ * bucket */
void serf_bucket_request_become(
serf_bucket_t *bucket,
const char *method,
@@ -225,7 +229,10 @@ serf_bucket_t *serf__bucket_stream_creat
serf_bucket_aggregate_eof_t fn,
void *baton);
-/** Transform @a bucket in-place into an aggregate bucket. */
+/** Transform @a bucket in-place into an aggregate bucket.
+ *
+ * It is callers responsibility to free resources held by the original
+ * bucket */
void serf_bucket_aggregate_become(
serf_bucket_t *bucket);
