lkml.org 
[lkml]   [2012]   [Sep]   [28]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH v6 5/10] rbtree.h: add doc comments for struct rb_node
Date
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


\
 
 \ /
  Last update: 2012-09-29 02:41    [W:0.140 / U:0.300 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site