mesa: Document an odd side-effect of hash_table_insert

Signed-off-by: Ian Romanick <ian.d.romanick@intel.com>
Reviewed-by: Kenneth Graunke <kenneth@whitecape.org>

diff --git a/src/mesa/program/hash_table.h b/src/mesa/program/hash_table.h
index e715bb1cc62e7ec7353481f9bc88b5e3287a8af5..746939c2273b7a1bf145fc5342d082268192cb3f 100644 (file)
--- a/src/mesa/program/hash_table.h
+++ b/src/mesa/program/hash_table.h
@@ -88,6 +88,11 @@ extern void *hash_table_find(struct hash_table *ht, const void *key);
 
 /**
  * Add an element to a hash table
+ *
+ * \warning
+ * If \c key is already in the hash table, it will be added again.  Future
+ * calls to \c hash_table_find and \c hash_table_remove will return or remove,
+ * repsectively, the most recently added instance of \c key.
  */
 extern void hash_table_insert(struct hash_table *ht, void *data,
     const void *key);