Rename 'pool_close' to 'pool_destroy'

Author: 8dcc

README.org

@@ -49,7 +49,7 @@ described below:
 3. When a chunk is no longer needed, free it so it can be used by subsequent
    allocations.
 4. Optionally expand the pool, if you run out of chunks.
-5. When the pool itself is no longer needed, close it.
+5. When the pool itself is no longer needed, destroy it.
 
 For a full example, see [[file:src/libpool-test.c][src/libpool-test.c]].
 
@@ -65,7 +65,7 @@ This library consists of only 5 functions:
 
   This function will allocate a =Pool= structure, along with the array of chunks
   used for later allocations. The caller must free the returned pointer using
-  =pool_close=.
+  =pool_destroy=.
 
   Note that the =chunk_sz= argument must be greater or equal than
   =sizeof(void*)=. For more information, see the /Caveats/ section.
@@ -77,11 +77,11 @@ This library consists of only 5 functions:
   On success, it returns /true/; otherwise, it returns /false/ and leaves the pool
   unchanged.
 
-- Function: =pool_close= ::
+- Function: =pool_destroy= ::
 
   Free all data in a =Pool= structure, along with the structure itself. After a
-  pool is closed, all data previously allocated from that pool (with =pool_alloc=)
-  becomes unusable.
+  pool is destroyed, all data previously allocated from that pool (with
+  =pool_alloc=) becomes unusable.
 
   Allows =NULL= as the argument.
 

src/benchmark.c

@@ -25,7 +25,7 @@ static void benchmark_libpool(size_t nmemb, size_t size) {
 
     while (ptrs_pos > 0)
         pool_free(pool, ptrs[--ptrs_pos]);
-    pool_close(pool);
+    pool_destroy(pool);
 }
 
 static void benchmark_malloc(size_t nmemb, size_t size) {

src/libpool-test.c

@@ -51,7 +51,7 @@ static void test_pool(Pool* pool) {
     /*
      * Keep allocating until we run out of chunks, to illustrate what happens
      * after too many allocations. We are "leaking" pool memory in this loop,
-     * but it's not really leaked to the system because we will `close' the pool
+     * but it's not really leaked to the system because we will destroy the pool
      * later.
      */
     for (i = 0; i < 35; i++) {
@@ -108,12 +108,12 @@ int main(void) {
     test_pool(pool1);
 
     /*
-     * When we are done, we "close" each pool. All previously allocated data
+     * When we are done, we destroy each pool. All previously allocated data
      * from the pool becomes unusable, and the necessary resources allocated by
      * `pool_new' are freed.
      */
-    pool_close(pool2);
-    pool_close(pool1);
+    pool_destroy(pool2);
+    pool_destroy(pool1);
 
     return 0;
 }

src/libpool.c

@@ -215,7 +215,7 @@ bool pool_expand(Pool* pool, size_t extra_sz) {
  * contain the base address of each chunk array. We free the array, and then the
  * `ArrayStart' structure itself. Lastly, we free the `Pool' structure.
  */
-void pool_close(Pool* pool) {
+void pool_destroy(Pool* pool) {
     ArrayStart* array_start;
     ArrayStart* next;
 

src/libpool.h

@@ -26,7 +26,7 @@ typedef struct Pool Pool;
 
 /*
  * External functions for allocating and freeing system memory. Used by
- * `pool_new' and `pool_close'.
+ * `pool_new' and `pool_detroy'.
  *
  * If `LIBPOOL_NO_STDLIB' is defined, they are set to NULL, so the user must
  * initialize them. Otherwise, their default value is `malloc' and `free', from
@@ -43,7 +43,7 @@ extern PoolFreeFuncPtr pool_ext_free;
  *
  * Notes:
  *   - If the initialization fails, NULL is returned.
- *   - The caller must free the returned pointer using `pool_close'.
+ *   - The caller must free the returned pointer using `pool_destroy'.
  *   - The `chunk_sz' must be greater or equal than `sizeof(void*)'.
  *   - The pool size can be updated with `pool_expand', but the chunk size
  *     cannot be changed.
@@ -63,7 +63,7 @@ bool pool_expand(Pool* pool, size_t extra_sz);
  * data allocated from this the pool becomes unusable. Allows NULL as the
  * `pool' parameter.
  */
-void pool_close(Pool* pool);
+void pool_destroy(Pool* pool);
 
 /*
  * Allocate a fixed-size chunk from the specified pool. If no chunks are