summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Ipsum <richardipsum@fastmail.co.uk>2017-05-09 22:31:13 +0100
committerRichard Ipsum <richardipsum@fastmail.co.uk>2017-05-10 22:54:40 +0100
commit64429e538beebca7559935862b6d70b0386b1e4b (patch)
tree7bff16a42355c76972df4c730de43165d267de75
parent24cab850eb11336730abd23c923b14ec2ed0b83e (diff)
downloadluxio-64429e538beebca7559935862b6d70b0386b1e4b.tar.bz2
docs: Directories
Add more details to Directories section.
-rw-r--r--luxio.c8
1 files changed, 5 insertions, 3 deletions
diff --git a/luxio.c b/luxio.c
index eaedec0..e778d07 100644
--- a/luxio.c
+++ b/luxio.c
@@ -916,8 +916,6 @@ luxio_unsetenv(lua_State *L) /* POSIX.1-2001 */
/* TODO: sysconf() 4.8.1 */
/*** Directories.
-readdir() is a hideous API. As such, we need to be reasonably high-level here,
-otherwise everything is just too painful.
@section dir
*/
@@ -1065,7 +1063,7 @@ luxio_closedir(lua_State *L) /* 5.1.2 */
Returned by @{readdir}. Some fields are OS-specific.
@field d_ino inode number
@field d_name file name
-@field d_type file type
+@field d_type file type _Note: `d_type` is not supported by all filesystems._
@table dirent
*/
@@ -1128,6 +1126,9 @@ luxio_rewinddir(lua_State *L) /* 5.1.2 */
*/
/*** Change working directory.
+
+Returns zero on success, or -1 on error with errno set appropriately.
+
@tparam string path
@treturn number return value
@treturn errno errno
@@ -1145,6 +1146,7 @@ luxio_chdir(lua_State *L) /* 5.2.1 */
}
/*** Get the current working directory.
+
@treturn string|nil path or nil on error
@treturn errno
@function getcwd