From 319ff98203a227ee8713d97e9afb3bed617187fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sa=C3=BAl=20Ibarra=20Corretg=C3=A9?= Date: Thu, 30 May 2024 09:28:34 +0200 Subject: [PATCH] doc: clarify uv_fs_req_cleanup --- docs/src/fs.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/src/fs.rst b/docs/src/fs.rst index 84b0a020..6d7e55b6 100644 --- a/docs/src/fs.rst +++ b/docs/src/fs.rst @@ -215,8 +215,10 @@ API .. c:function:: void uv_fs_req_cleanup(uv_fs_t* req) - Cleanup request. Must be called after a request is finished to deallocate - any memory libuv might have allocated. + Cleanup request. Must be called after a request is finished to cleanup + any resources libuv might have allocated. + + It must be called for all requests, regardless of success or failure. .. c:function:: int uv_fs_close(uv_loop_t* loop, uv_fs_t* req, uv_file file, uv_fs_cb cb)