From: Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
Date: Mon, 12 Jul 2010 16:29:11 +0000 (-0400)
Subject: Lock-free stack: add comments
X-Git-Tag: v0.4.7~25
X-Git-Url: http://git.liburcu.org/?p=urcu.git;a=commitdiff_plain;h=1c1e940e005b8483982945b4a2a5f40dfeeb2f8c

Lock-free stack: add comments

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

diff --git a/urcu/rculfstack.h b/urcu/rculfstack.h
index f43c9d8..6df6d72 100644
--- 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)
 {