[glib] ghash: Document that GHashTable is not suitable for static hash tables



commit 404c2d24542d5306aa579cfc43470e789306866e
Author: Philip Withnall <withnall endlessm com>
Date:   Thu Mar 2 10:26:26 2017 +0000

    ghash: Document that GHashTable is not suitable for static hash tables
    
    Instead, gperf should be used for that kind of thing.
    
    Inspired by http://stackoverflow.com/q/42372382/2931197.
    
    Signed-off-by: Philip Withnall <withnall endlessm com>

 glib/ghash.c |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)
---
diff --git a/glib/ghash.c b/glib/ghash.c
index 9afa121..01c495e 100644
--- a/glib/ghash.c
+++ b/glib/ghash.c
@@ -89,6 +89,10 @@
  * space saving, if your set is large. The functions
  * g_hash_table_add() and g_hash_table_contains() are designed to be
  * used when using #GHashTable this way.
+ *
+ * #GHashTable is not designed to be statically initialised with keys and
+ * values known at compile time. To build a static hash table, use a tool such
+ * as [gperf](https://www.gnu.org/software/gperf/).
  */
 
 /**


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]