Messages in this thread Patch in this message | | | From | Daniel Santos <> | Subject | [PATCH v6 5/10] rbtree.h: add doc comments for struct rb_node | Date | Fri, 28 Sep 2012 18:40:20 -0500 |
| |
Signed-off-by: Daniel Santos <daniel.santos@pobox.com> --- include/linux/rbtree.h | 14 ++++++++++++++ 1 files changed, 14 insertions(+), 0 deletions(-)
diff --git a/include/linux/rbtree.h b/include/linux/rbtree.h index 5f10915..c815b5e 100644 --- a/include/linux/rbtree.h +++ b/include/linux/rbtree.h @@ -35,6 +35,20 @@ #include <linux/bug.h> #include <linux/kconfig.h> +/** + * struct rb_node + * @__rb_parent_color: Contains the color in the lower 2 bits (although only + * bit zero is currently used) and the address of the + * parent in the rest (lower 2 bits of address should + * always be zero on any arch supported). If the node is + * initialized and not a member of any tree, the parent + * point to its self. If the node belongs to a tree, but + * is the root element, the parent will be NULL. + * Otherwise, parent will always point to the parent node + * in the tree. + * @rb_right: Pointer to the right element. + * @rb_left: Pointer to the left element. + */ struct rb_node { unsigned long __rb_parent_color; struct rb_node *rb_right; -- 1.7.3.4
| |