doc: add uv_fs_fsync() AIX limitations

Unlike other platforms, the fsync call on aix will not accept non-regular file file-descriptors. Refs: nodejs/node#21298 PR-URL: #1879 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Richard Lau <[email protected]>
libuv · Jun 19, 2018 · 8ab14e2 · 8ab14e2
1 parent 02fc109
commit 8ab14e2
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/src/fs.rst b/docs/src/fs.rst
@@ -234,6 +234,10 @@ API
 
     Equivalent to :man:`fsync(2)`.
 
+    .. note::
+        For AIX, `uv_fs_fsync` returns `UV_EBADF` on file descriptors referencing
+        non regular files.
+
 .. c:function:: int uv_fs_fdatasync(uv_loop_t* loop, uv_fs_t* req, uv_file file, uv_fs_cb cb)
 
     Equivalent to :man:`fdatasync(2)`.