osl.c: Fix assertion in create_table_index().

[osl.git] / osl.h.in

diff --git a/osl.h.in b/osl.h.in
index cd39a3b2f355384902b208a47f17181ce2074e16..90585bc4b345c3c59a26a752bb5362aecef8655f 100644 (file)
--- a/osl.h.in
+++ b/osl.h.in
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2007-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2007-2009 Andre Noll <maan@tuebingen.mpg.de>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -78,7 +78,7 @@ struct osl_row;
  * specified. Such a function always takes pointers to the two objects to be
  * compared. It must return -1, zero, or 1, if the first argument is considered
  * to  be  respectively less than, equal to, or greater than the second. If two
- * members compare as equal, their order in the sorted array is undefined.
+ * members compare as equal, their order in the rbtree is undefined.
  */
 typedef int osl_compare_func(const struct osl_object *obj1,
        const struct osl_object *obj2);
@@ -116,7 +116,7 @@ struct osl_column_description {
        osl_compare_func *compare_function;
        /**
         * If the \a OSL_FIXED_SIZE flag is set for this column, this value
-        * determines the fixed size of all objects of this column. It is
+        * describes the number of bytes of each object of this column. It is
         * ignored, if \a OSL_FIXED_SIZE is not set.
         */
        uint32_t data_size;
@@ -126,7 +126,10 @@ struct osl_column_description {
  * Describes one osl table.
  */
 struct osl_table_description {
-       /** The directory which contains all files of this table. */
+       /**
+        * The directory which contains all files of this table. This may be
+        * either relative to the cwd or an absolute path.
+        */
        const char *dir;
        /**
         * The table name. A subdirectory of \a dir called \a name is created
@@ -445,8 +448,8 @@ int osl_rbtree_last_row(const struct osl_table *t, unsigned col_num,
  * \param result Row is returned here.
  *
  * Retrieve the n-th order statistic with respect to the compare function
- * of the rbtree column \a col_num. In other words, get that row with
- * \a n th greatest value in column \a col_num. It's an error if
+ * of the rbtree column \a col_num. In other words, get the row with
+ * \a n th greatest value in column \a col_num. It is an error if
  * \a col_num is not a rbtree column, or if \a n is larger than the
  * number of rows in the table.
  *