From: Matthias Clasen <mclasen@redhat.com>
Date: Mon, 27 Jul 2015 10:51:17 +0000 (-0400)
Subject: Add a note to the g_str_hash docs
X-Git-Tag: upstream/2.48.0^2~21
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=17871e6881beb401eebb8b05eccb01490cfa85b6;p=platform%2Fupstream%2Fglib.git

Add a note to the g_str_hash docs

Point out some shortcomings of the djb hash, as found in

https://bugzilla.gnome.org/show_bug.cgi?id=751610
---

diff --git a/glib/ghash.c b/glib/ghash.c
index 5c95c72..7f8e5da 100644
--- a/glib/ghash.c
+++ b/glib/ghash.c
@@ -1860,6 +1860,10 @@ g_str_equal (gconstpointer v1,
  * It can be passed to g_hash_table_new() as the @hash_func parameter,
  * when using non-%NULL strings as keys in a #GHashTable.
  *
+ * Note that this function may not be a perfect fit for all use cases.
+ * For example, it produces some hash collisions with strings as short
+ * as 2.
+ *
  * Returns: a hash value corresponding to the key
  */
 guint