Add a comment to search_rbtree().

diff --git a/osl.c b/osl.c
index 9e6de44f9b6192a465b172567737524dbef76f67..c92412fbce765444c7a0d713cdeeffca35d824c1 100644 (file)
--- a/osl.c
+++ b/osl.c
@@ -771,6 +771,10 @@ int get_mapped_object(const struct osl_table *t, unsigned col_num,
        return 1;
 }
 
+/*
+ * It's OK to call this with result = rb_node = NULL.  If result is not NULL,
+ * and rb key was not found, result points to the parent node.
+ */
 static int search_rbtree(const struct osl_object *obj,
                const struct osl_table *t, unsigned col_num,
                struct rb_node **result, struct rb_node ***rb_link)