From: Timo Sirainen <tss@iki.fi>
Date: Tue, 23 Apr 2013 18:08:31 +0000 (+0300)
Subject: hash_table_clear(): Added a comment about API usage.
X-Git-Tag: 2.2.2~59
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3b09ea6d8593ea15cefbcd344671b8eac3719118;p=thirdparty%2Fdovecot%2Fcore.git

hash_table_clear(): Added a comment about API usage.
---

diff --git a/src/lib/hash.h b/src/lib/hash.h
index f0ccb67de1..ead59a1945 100644
--- a/src/lib/hash.h
+++ b/src/lib/hash.h
@@ -68,8 +68,8 @@ void hash_table_destroy(struct hash_table **table);
 #define hash_table_destroy(table) \
 	hash_table_destroy(&(*table)._table)
 /* Remove all nodes from hash table. If free_collisions is TRUE, the
-   memory allocated from node_pool is freed, or discarded with
-   alloconly pools. */
+   memory allocated from node_pool is freed, or discarded with alloconly pools.
+   WARNING: If you p_clear() the node_pool, the free_collisions must be TRUE. */
 void hash_table_clear(struct hash_table *table, bool free_collisions);
 #define hash_table_clear(table, free_collisions) \
 	hash_table_clear((table)._table, free_collisions)