Clarify documentation of osl_table_description->dir.
authorAndre Noll <maan@systemlinux.org>
Sat, 22 Jan 2011 13:16:41 +0000 (14:16 +0100)
committerAndre Noll <maan@systemlinux.org>
Sat, 22 Jan 2011 13:16:41 +0000 (14:16 +0100)
osl.h.in

index d5a7d1d..388664e 100644 (file)
--- a/osl.h.in
+++ b/osl.h.in
@@ -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