X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=README.md;h=2fe14c3db756394d2cdf2c09ebe5e1b018c89324;hb=3c3f9aff1e6980292d31a7819d7ba998e8d0b754;hp=38a76c29740a8286eabc92edb29b5eadc520b0a4;hpb=efa4515da1e6ecd02edd94d422d486c6ef0bcd4d;p=urcu.git diff --git a/README.md b/README.md index 38a76c2..2fe14c3 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,6 @@ Should also work on: - Android - NetBSD 5 - OpenBSD - - Darwin (more testing needed before claiming support for these OS). @@ -176,7 +175,7 @@ This is the preferred version of the library, in terms of grace-period detection speed, read-side speed and flexibility. Dynamically detects kernel support for `sys_membarrier()`. Falls back on `urcu-mb` scheme if support is not present, which has slower -read-side. Use the --disable-sys-membarrier-fallback configure option +read-side. Use the `--disable-sys-membarrier-fallback` configure option to disable the fall back, thus requiring `sys_membarrier()` to be available. This gives a small speedup when `sys_membarrier()` is supported by the kernel, and aborts in the library constructor if not @@ -382,7 +381,8 @@ By default the library is configured with internal debugging self-checks disabled. For always-on debugging self-checks: - ./configure --enable-rcu-debug + + ./configure --enable-rcu-debug For fine grained enabling of debugging self-checks, build userspace-rcu with `DEBUG_RCU` defined and compile dependent @@ -413,7 +413,7 @@ theoretically yielding slightly better performance. 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 +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. @@ -447,7 +447,7 @@ follows: - An application executable is built with `_LGPL_SOURCE` defined, includes any of the Userspace RCU 0.10 urcu flavor headers, and is built - without the -fpic compiler option. + without the `-fpic` compiler option. - The Userspace RCU 0.10 library shared objects are updated to 0.11 or 0.12 without rebuilding the application. @@ -459,7 +459,7 @@ Some possible work-arounds for this are: - Rebuild the application against Userspace RCU 0.11+. - - Rebuild the application with -fpic. + - Rebuild the application with `-fpic`. - Upgrade Userspace RCU to 0.13+ without installing 0.11 nor 0.12.