diff options
| author | Bob Burger <rgburger@beckman.com> | 2018-04-02 12:48:49 -0400 |
|---|---|---|
| committer | Santiago Gimeno <santiago.gimeno@gmail.com> | 2018-04-06 08:53:30 +0200 |
| commit | 1d1287d764ee3a67debcf5f20e3f75815e29f89e (patch) | |
| tree | a8d68ed1d13ee4de3db3c185656e63c3877c09b6 /docs/src | |
| parent | 00d13c5b9f68c06a241461fd5f0f94776b9d438f (diff) | |
| download | libuv-1d1287d764ee3a67debcf5f20e3f75815e29f89e.tar.gz libuv-1d1287d764ee3a67debcf5f20e3f75815e29f89e.zip | |
doc,fs: improve documentation
Update description of `uv_fs_readlink` and `uv_fs_realpath` to describe
where the resulting string goes.
Fixes: https://github.com/libuv/libuv/issues/1771
PR_URL: https://github.com/libuv/libuv/pull/1786
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/fs.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/src/fs.rst b/docs/src/fs.rst index 29227be0..8e8fc2f1 100644 --- a/docs/src/fs.rst +++ b/docs/src/fs.rst @@ -148,8 +148,8 @@ Public members .. c:member:: void* uv_fs_t.ptr - Stores the result of :c:func:`uv_fs_readlink` and serves as an alias to - `statbuf`. + Stores the result of :c:func:`uv_fs_readlink` and + :c:func:`uv_fs_realpath` and serves as an alias to `statbuf`. .. seealso:: The :c:type:`uv_req_t` members also apply. @@ -311,10 +311,12 @@ API .. c:function:: int uv_fs_readlink(uv_loop_t* loop, uv_fs_t* req, const char* path, uv_fs_cb cb) Equivalent to :man:`readlink(2)`. + The resulting string is stored in `req->ptr`. .. c:function:: int uv_fs_realpath(uv_loop_t* loop, uv_fs_t* req, const char* path, uv_fs_cb cb) Equivalent to :man:`realpath(3)` on Unix. Windows uses `GetFinalPathNameByHandle <https://msdn.microsoft.com/en-us/library/windows/desktop/aa364962(v=vs.85).aspx>`_. + The resulting string is stored in `req->ptr`. .. warning:: This function has certain platform-specific caveats that were discovered when used in Node. |