[PATCH v6 5/10] rbtree.h: add doc comments for struct rb_node

2012-09-28 Thread Daniel Santos 
Signed-off-by: Daniel Santos 
---
 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 
 #include 
 
+/**
+ * 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

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

[PATCH v6 5/10] rbtree.h: add doc comments for struct rb_node

2012-09-28 Thread Daniel Santos 
Signed-off-by: Daniel Santos daniel.san...@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

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