lkml.org 
[lkml]   [2012]   [Sep]   [25]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH v5 19/25] rbtree.h: add doc comments for struct rb_node
Date
Signed-off-by: Daniel Santos <daniel.santos@pobox.com>
---
include/linux/rbtree.h | 13 +++++++++++++
1 files changed, 13 insertions(+), 0 deletions(-)

diff --git a/include/linux/rbtree.h b/include/linux/rbtree.h
index 3ef30b9..f1fbdea 100644
--- a/include/linux/rbtree.h
+++ b/include/linux/rbtree.h
@@ -100,6 +100,19 @@ static inline struct page * rb_insert_page_cache(struct inode * inode,
#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;
--
1.7.3.4


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