Fix: Add missing cmm_smp_mb() in deprecated urcu-signal

[userspace-rcu.git] / README.md

diff --git a/README.md b/README.md
index 6b87b63719aa03eaa57d01a6bc671624bafd7c1f..58db299018deb07f36fbdd1bad863ed35f82b3e0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2023 EfficiOS Inc.
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+

 Userspace RCU Implementation
 ============================
 
 Userspace RCU Implementation
 ============================
 


@@ -214,9 +220,10 @@ results in slower reads.
   1. `#include <urcu/urcu-signal.h>`
   2. Link the application with `-lurcu-signal`
 
   1. `#include <urcu/urcu-signal.h>`
   2. Link the application with `-lurcu-signal`
 

-Version of the library that requires a signal, typically `SIGUSR1`. Can
-be overridden with `-DSIGRCU` by modifying `Makefile.build.inc`.
-
+NOTE: The `liburcu-signal` flavor is *deprecated* and will be removed in the
+future. It is now identical to `liburcu-mb` at the exception of the symbols and
+public header files. It is therefore slower than previous versions. Users are
+encouraged to migrate to the `liburcu-memb` flavor.

 
 ### Usage of `liburcu-bp`
 
 
 ### Usage of `liburcu-bp`
 


@@ -434,6 +441,10 @@ 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.
 
 This option alters the rculfhash ABI. Make sure to compile both library
 and application with matching configuration.
 

+### Usage of `--enable-compiler-atomic-builtins`
+
+Building liburcu with `--enable-compiler-atomic-builtins` implements the uatomic
+API with the compiler atomic builtins if supported.

 
 Make targets
 ------------
 
 Make targets
 ------------