tls-compat.h: document sigaltstack(2) limitation

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

diff --git a/urcu/tls-compat.h b/urcu/tls-compat.h
index 2f4023258c2cf658da196090a68d5757cc617753..601336b0db6599312bf4277a668f129c8e7c1645 100644 (file)
--- a/urcu/tls-compat.h
+++ b/urcu/tls-compat.h
@@ -59,6 +59,9 @@ extern "C" {
  * Example: In any thread, the first call of URCU_TLS(rcu_reader)
  * is called from rcu_register_thread(), so we can ensure all later
  * URCU_TLS(rcu_reader) in any thread is async-signal-safe.
+ *
+ * Moreover, URCU_TLS variables should not be touched from signal
+ * handlers setup with with sigaltstack(2).
  */
 
 # define DECLARE_URCU_TLS(type, name)  \