From c48950ed04e7fe3b5a1108265a8caf2ab759cfe2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sa=C3=BAl=20Ibarra=20Corretg=C3=A9?= Date: Wed, 8 Jul 2015 00:36:07 +0200 Subject: [PATCH] doc: add note about uv_fs_scandir The '.' and '..' entries are always skipped on Unix systems. Refs: https://github.com/libuv/libuv/issues/426 PR-URL: https://github.com/libuv/libuv/pull/427 Reviewed-By: Ben Noordhuis --- docs/src/fs.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/src/fs.rst b/docs/src/fs.rst index ec1b9c63..a46a07fa 100644 --- a/docs/src/fs.rst +++ b/docs/src/fs.rst @@ -211,6 +211,9 @@ API get `ent` populated with the next directory entry data. When there are no more entries ``UV_EOF`` will be returned. + .. note:: + Unlike `scandir(3)`, this function does not return the "." and ".." entries. + .. 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)