You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apr.apache.org by st...@apache.org on 2003/11/02 02:06:49 UTC
cvs commit: apr/include apr_allocator.h
striker 2003/11/01 17:06:49
Modified: include apr_allocator.h
Log:
* include/apr_allocator.h
(apr_memnode_t, apr_allocator_free): Update comments regarding the use of
fields within apr_memnode_t.
Revision Changes Path
1.18 +7 -2 apr/include/apr_allocator.h
Index: apr_allocator.h
===================================================================
RCS file: /home/cvs/apr/include/apr_allocator.h,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- apr_allocator.h 31 Oct 2003 08:31:20 -0000 1.17
+++ apr_allocator.h 2 Nov 2003 01:06:49 -0000 1.18
@@ -83,7 +83,10 @@
/** basic memory node structure
* @note The next, ref and first_avail fields are available for use by the
* caller of apr_allocator_alloc(), the remaining fields are read-only.
- * The next, ref and first_avail fields will be properly restored by
+ * The next field has to be used with caution and sensibly set when the
+ * memnode is passed back to apr_allocator_free(). See apr_allocator_free()
+ * for details.
+ * The ref and first_avail fields will be properly restored by
* apr_allocator_free().
*/
struct apr_memnode_t {
@@ -126,7 +129,9 @@
apr_size_t size);
/**
- * Free a block of mem, giving it back to the allocator
+ * Free a list of blocks of mem, giving them back to the allocator.
+ * The list is typically terminated by a memnode with its next field
+ * set to NULL.
* @param allocator The allocator to give the mem back to
* @param memnode The memory node to return
*/