Lock-free stack: add comments

[urcu.git] / urcu / rculfstack.h

diff --git a/urcu/rculfstack.h b/urcu/rculfstack.h
index f43c9d8c1e679c344bdb289b445fdd99ed0c466d..6df6d725a584b0719ebfd6a2c70a9d7a98301789 100644 (file)
--- a/urcu/rculfstack.h
+++ b/urcu/rculfstack.h
@@ -62,6 +62,11 @@ void rcu_lfs_push(struct rcu_lfs_stack *s, struct rcu_lfs_node *node)
        }
 }
 
+/*
+ * The caller must wait for a grace period to pass before freeing the returned
+ * node.
+ * Returns NULL if stack is empty.
+ */
 struct rcu_lfs_node *
 rcu_lfs_pop(struct rcu_lfs_stack *s)
 {