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

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot-2.2/rev/25679980d267
changeset: 16318:25679980d267
user:      Timo Sirainen <tss at iki.fi>
date:      Tue Apr 23 21:08:31 2013 +0300
description:
hash_table_clear(): Added a comment about API usage.

diffstat:

 src/lib/hash.h |  4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diffs (14 lines):

diff -r dd6316615025 -r 25679980d267 src/lib/hash.h
--- a/src/lib/hash.h	Tue Apr 23 21:06:34 2013 +0300
+++ b/src/lib/hash.h	Tue Apr 23 21:08:31 2013 +0300
@@ -68,8 +68,8 @@
 #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)