From: Ian Romanick <ian.d.romanick@intel.com>
Date: Wed, 17 Aug 2011 18:43:11 +0000 (-0700)
Subject: mesa: Document an odd side-effect of hash_table_insert
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=16f7bdf5556e739d5a0b6c4c2e2a30bb731f8fc9;p=mesa.git

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 e715bb1cc62..746939c2273 100644
--- 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);