aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorSaúl Ibarra Corretgé <saghul@gmail.com>2015-07-17 09:26:08 +0200
committerSaúl Ibarra Corretgé <saghul@gmail.com>2015-07-17 09:26:08 +0200
commitb3fde348e4345866fb18b350bc86aec71bbd4336 (patch)
tree755c34551ec995bbfe60723ee1b33f0a547f7a71 /docs/src
parent085b877ccbc5ccfc1416c5aadfd9d845f1cef5cf (diff)
downloadlibuv-b3fde348e4345866fb18b350bc86aec71bbd4336.tar.gz
libuv-b3fde348e4345866fb18b350bc86aec71bbd4336.zip
doc: add a note about uv_dirent_t.type
On Linux getting the type is only supported by some filesystems, check getdents(2).
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/fs.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/src/fs.rst b/docs/src/fs.rst
index a46a07fa..33c04406 100644
--- a/docs/src/fs.rst
+++ b/docs/src/fs.rst
@@ -214,6 +214,10 @@ API
.. note::
Unlike `scandir(3)`, this function does not return the "." and ".." entries.
+ .. note::
+ On Linux, getting the type of an entry is only supported by some filesystems (btrfs, ext2,
+ ext3 and ext4 at the time of this writing), check the :man:`getdents(2)` man page.
+
.. c:function:: int uv_fs_stat(uv_loop_t* loop, uv_fs_t* req, const char* path, uv_fs_cb cb)
.. c:function:: int uv_fs_fstat(uv_loop_t* loop, uv_fs_t* req, uv_file file, uv_fs_cb cb)
.. c:function:: int uv_fs_lstat(uv_loop_t* loop, uv_fs_t* req, const char* path, uv_fs_cb cb)