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 (file)
--- 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