diff options
| author | Saúl Ibarra Corretgé <saghul@gmail.com> | 2015-07-08 00:36:07 +0200 |
|---|---|---|
| committer | Saúl Ibarra Corretgé <saghul@gmail.com> | 2015-07-08 22:39:46 +0200 |
| commit | c48950ed04e7fe3b5a1108265a8caf2ab759cfe2 (patch) | |
| tree | 5ca946e5510803ea811235f6fb20e18599adcf52 /docs/src | |
| parent | ac89bb4d30d079a3ba88f90b983b7c230e3fbce3 (diff) | |
| download | libuv-c48950ed04e7fe3b5a1108265a8caf2ab759cfe2.tar.gz libuv-c48950ed04e7fe3b5a1108265a8caf2ab759cfe2.zip | |
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 <info@bnoordhuis.nl>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/fs.rst | 3 |
1 files changed, 3 insertions, 0 deletions
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) |