X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=urcu%2Frculfhash.h;h=a08f0431af62d200bdd77d63f1d996853a8f74fb;hb=ae62aa6a78193cb15ff51b9611e1438047f94d3f;hp=860ef3d1c2d05e3516ec4a8849c9d47b39f1371f;hpb=4dd4a47355d9d870d482248786b4adf8b1317bfe;p=urcu.git

diff --git a/urcu/rculfhash.h b/urcu/rculfhash.h
index 860ef3d..a08f043 100644
--- a/urcu/rculfhash.h
+++ b/urcu/rculfhash.h
@@ -42,6 +42,11 @@ struct _cds_lfht_node {
 	unsigned long reverse_hash;
 } __attribute__((aligned(4)));
 
+/*
+ * struct cds_lfht_node can be embedded into a structure (as a field).
+ * caa_container_of() can be used to get the structure from the struct
+ * cds_lfht_node after a lookup.
+ */
 struct cds_lfht_node {
 	/* cache-hot for iteration */
 	struct _cds_lfht_node p;          /* needs to be first field */