doc: document how to get result of uv_fs_mkdtemp

PR-URL: https://github.com/libuv/libuv/pull/31 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2014-12-04 12:05:21 -06:00 · 2014-12-04 12:05:21 -06:00 · dfdcfc0c4d
commit dfdcfc0c4d
parent 484a3a92a8
1 changed files with 3 additions and 0 deletions
--- a/docs/src/fs.rst
+++ b/docs/src/fs.rst
@ -191,6 +191,9 @@ API

    Equivalent to ``mkdtemp(3)``.

+    .. note::
+        The result can be found as a null terminated string at `req->path`.
+
 .. c:function:: int uv_fs_rmdir(uv_loop_t* loop, uv_fs_t* req, const char* path, uv_fs_cb cb)

    Equivalent to ``rmdir(2)``.