rculfhash: implement iterator debugging config option

[urcu.git] / README.md

diff --git a/README.md b/README.md
index 7a33cd7ea044c138618d886f50325661ff757105..601703bdf6209af39c9e27e47a9d0c9d3e2d6b13 100644 (file)
--- a/README.md
+++ b/README.md
@@ -410,6 +410,20 @@ systems can be disabled with:
 theoretically yielding slightly better performance.
 
 
+### Usage of `--enable-cds-lfht-iter-debug`
+
+By default the library is configured with extra debugging checks for
+lock-free hash table iterator traversal disabled.
+
+Building liburcu with --enable-cds-lfht-iter-debug and rebuilding
+application to match the ABI change allows finding cases where the hash
+table iterator is re-purposed to be used on a different hash table while
+still being used to iterate on a hash table.
+
+This option alters the rculfhash ABI. Make sure to compile both library
+and application with matching configuration.
+
+
 Make targets
 ------------