On 11.12.2015 11:32, Bert Huijben wrote:


-----Original Message-----
From: Stefan Fuhrmann [mailto:stef...@apache.org]
Sent: donderdag 10 december 2015 23:59
To: dev@apr.apache.org
Subject: [PATCH] APR hash documentation

Hi there,

since 1.4.6, the hash implementation allows for
mismatching and custom hash functions when merging
hashes.  But the docstrings have not been updated.

I don't think this should be applied without leaving a note about not having
that support in earlier versions.

The reason we found this problem is that we tested with those older
versions. If we remove that part of the documentation it will be even harder
to diagnose problems like this in the future.

Fair enough. Here the updated version against /trunk.

-- Stefan^2.

[[[
Since 1.4.6, apr_hash_overlay and apr_hash_merge work with any combination
of hash functions.  Reflect that change in the documentation.

* include/apr_hash.h
   (apr_hash_overlay,
    apr_hash_merge): Update the docstrings.
]]]

[[[
Index: include/apr_hash.h
===================================================================
--- include/apr_hash.h  (revision 1721274)
+++ include/apr_hash.h  (working copy)
@@ -216,8 +216,8 @@

 /**
  * Merge two hash tables into one new hash table. The values of the overlay
- * hash override the values of the base if both have the same key.  Both
- * hash tables must use the same hash function.
+ * hash override the values of the base if both have the same key.  Prior
+ * to release 1.4.6, both hash tables had to use the same hash function.
  * @param p The pool to use for the new hash table
  * @param overlay The table to add to the initial table
  * @param base The table that represents the initial values of the new table
@@ -230,8 +230,8 @@
 /**
  * Merge two hash tables into one new hash table. If the same key
  * is present in both tables, call the supplied merge function to
- * produce a merged value for the key in the new table.  Both
- * hash tables must use the same hash function.
+ * produce a merged value for the key in the new table.  Prior to
+ * release 1.4.6, both hash tables had to use the same hash function.
  * @param p The pool to use for the new hash table
  * @param h1 The first of the tables to merge
  * @param h2 The second of the tables to merge
]]]

Reply via email to