aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorBen Noordhuis <info@bnoordhuis.nl>2025-02-21 23:08:15 +0100
committerGitHub <noreply@github.com>2025-02-21 23:08:15 +0100
commit85b526f56ac0ca5e76de5cbc0e1e9452f73a01d5 (patch)
treefc5ecdc70e38926c2afcf30b40c84aee47d99420 /docs/src
parent8a94b7b2ec23abc57c5a0bf36c808bc6dcc0ce4f (diff)
downloadlibuv-85b526f56ac0ca5e76de5cbc0e1e9452f73a01d5.tar.gz
libuv-85b526f56ac0ca5e76de5cbc0e1e9452f73a01d5.zip
unix,win: accept NAN/INFINITY as file timestamps (#4702)
Extend uv_fs_utime, uv_fs_futime and uv_fs_lutime to accept NAN and INFINITY, with NAN meaning "don't touch the timestamp" and INFINITY meaning "set to the current timestamp." Ugly, but it avoids having to add uv_fs_utime2, etc. UV_FS_UTIME_NOW and UV_FS_UTIME_OMIT constants have been added to make it more palatable. Fixes: https://github.com/libuv/libuv/issues/4665
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/fs.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/src/fs.rst b/docs/src/fs.rst
index 7bc8d0cb..01a48e8e 100644
--- a/docs/src/fs.rst
+++ b/docs/src/fs.rst
@@ -430,6 +430,12 @@ API
Equivalent to :man:`utime(2)`, :man:`futimes(3)` and :man:`lutimes(3)` respectively.
+ Passing `UV_FS_UTIME_NOW` as the atime or mtime sets the timestamp to the
+ current time.
+
+ Passing `UV_FS_UTIME_OMIT` as the atime or mtime leaves the timestamp
+ untouched.
+
.. note::
z/OS: `uv_fs_lutime()` is not implemented for z/OS. It can still be called but will return
``UV_ENOSYS``.