From f933b309f95a89bbeecddab345c660a9773e421c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sa=C3=BAl=20Ibarra=20Corretg=C3=A9?= <s@saghul.net>
Date: Thu, 30 May 2024 09:36:35 +0200
Subject: [PATCH] doc: clarify us_fs_open

---
 docs/src/fs.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/docs/src/fs.rst b/docs/src/fs.rst
index 6d7e55b6f..fc877e3bd 100644
--- a/docs/src/fs.rst
+++ b/docs/src/fs.rst
@@ -228,6 +228,17 @@ API
 
     Equivalent to :man:`open(2)`.
 
+    The `req->result` field contains the opened file descriptor, of < 0 for error.
+
+    The `flags` argument has different semantics depending on the OS:
+
+        - On Unix, they are directly passed to :man:`open(2)`.
+        - On Windows, the following flags are implemented, emulating Unix semantics: `UV_FS_O_APPEND`,
+          `UV_FS_O_CREAT`, `UV_FS_O_EXCL`, `UV_FS_O_FILEMAP`, `UV_FS_O_RANDOM`, `UV_FS_O_RDONLY`,
+          `UV_FS_O_RDWR`, `UV_FS_O_SEQUENTIAL`, `UV_FS_O_SHORT_LIVED`, `UV_FS_O_TEMPORARY`,
+          `UV_FS_O_TRUNC`, `UV_FS_O_WRONLY`, `UV_FS_O_DIRECT`, `UV_FS_O_DSYNC`, `UV_FS_O_EXLOCK`,
+          `UV_FS_O_SYNC`.
+
     .. note::
         On Windows libuv uses `CreateFileW` and thus the file is always opened
         in binary mode. Because of this the O_BINARY and O_TEXT flags are not