Skip to content

Commit e1aa1ca

Browse files
authored
Add caveat about support for sync flags (#560)
Since sync flag functionality is entirely dependent on the host platform, add a caveat for each sync flag, warning that functions may return ENOTSUP if an unsupported sync flag is set.
1 parent 3e5d10e commit e1aa1ca

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

legacy/preview1/docs.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -663,7 +663,11 @@ Append mode: Data written to the file is always appended to the file's end.
663663
Bit: 0
664664

665665
- <a href="#fdflags.dsync" name="fdflags.dsync"></a> `dsync`: `bool`
666-
Write according to synchronized I/O data integrity completion. Only the data stored in the file is synchronized.
666+
Write according to synchronized I/O data integrity completion. Only the data
667+
stored in the file is synchronized. This feature is not available on all
668+
platforms and therefore [`path_open`](#path_open) and other such functions which
669+
accept [`fdflags`](#fdflags) may return [`errno.notsup`](#errno.notsup) in the
670+
case that this flag is set.
667671

668672
Bit: 1
669673

@@ -674,13 +678,20 @@ Bit: 2
674678

675679
- <a href="#fdflags.rsync" name="fdflags.rsync"></a> `rsync`: `bool`
676680
Synchronized read I/O operations.
681+
This feature is not available on all platforms and therefore
682+
[`path_open`](#path_open) and other such functions which accept
683+
[`fdflags`](#fdflags) may return [`errno.notsup`](#errno.notsup) in the case
684+
that this flag is set.
677685

678686
Bit: 3
679687

680688
- <a href="#fdflags.sync" name="fdflags.sync"></a> `sync`: `bool`
681-
Write according to synchronized I/O file integrity completion. In
682-
addition to synchronizing the data stored in the file, the implementation
683-
may also synchronously update the file's metadata.
689+
Write according to synchronized I/O file integrity completion. In addition to
690+
synchronizing the data stored in the file, the implementation may also
691+
synchronously update the file's metadata. This feature is not available on all
692+
platforms and therefore [`path_open`](#path_open) and other such functions which
693+
accept [`fdflags`](#fdflags) may return [`errno.notsup`](#errno.notsup) in the
694+
case that this flag is set.
684695

685696
Bit: 4
686697

0 commit comments

Comments
 (0)