rculfhash: document use of caa_container_of()

[urcu.git] / urcu / rculfhash.h

diff --git a/urcu/rculfhash.h b/urcu/rculfhash.h
index 860ef3d1c2d05e3516ec4a8849c9d47b39f1371f..a08f0431af62d200bdd77d63f1d996853a8f74fb 100644 (file)
--- 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 */