[PATCH 3/3] Documentation/rbtree.txt: Mention rb_entry()

From: Ian Abbott
Date: Tue Sep 04 2012 - 12:28:27 EST


Mention that rb_entry() can be used as a synonym for the standard
container_of() macro.

Signed-off-by: Ian Abbott <abbotti@xxxxxxxxx>
---
Documentation/rbtree.txt | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/rbtree.txt b/Documentation/rbtree.txt
index 47a8cb5..55008c3 100644
--- a/Documentation/rbtree.txt
+++ b/Documentation/rbtree.txt
@@ -64,7 +64,8 @@ Data nodes in an rbtree tree are structures containing a struct rb_node member:
};

When dealing with a pointer to the embedded struct rb_node, the containing data
-structure may be accessed with the standard container_of() macro.
+structure may be accessed with the standard container_of() macro, or by the
+rb_entry() macro which is a synonym for container_of().

At the root of each rbtree is an rb_root structure, which is initialized to be
empty via:
--
1.7.12

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/