urcu-memb,mb,signal: Implement grace period polling

[urcu.git] / README.md

diff --git a/README.md b/README.md
index 2fe14c3db756394d2cdf2c09ebe5e1b018c89324..ba5bb08deab9dd8f3a912b4d92835b37151c46d3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -250,6 +250,14 @@ protected pointer.
 After, `urcu_<flavor>_synchronize_rcu()` must be called. When it
 returns, the old values are not in usage anymore.
 
+As an alternative to `urcu_<flavor>_synchronize_rcu()`,
+it is also possible to use the urcu polling mechanism to wait for a
+grace period to elapse. This can be done by using
+`urcu_<flavor>_start_poll_synchronize_rcu()`
+to start the grace period polling, and then invoke
+`urcu_<flavor>_poll_state_synchronize_rcu()`, which returns true if
+the grace period has completed, false otherwise.
+
 
 ### Usage of `liburcu-defer`