Skip to content

Commit

Permalink
doc: undocument fs.open's 'rs' mode
Browse files Browse the repository at this point in the history
Using O_SYNC with O_RDONLY is basically a noop.

Closes: #6730
PR-URL: #6732
Reviewed-By: Ben Noorhduis <info@bnoordhuis.nl>
  • Loading branch information
saghul committed May 13, 2016
1 parent 9d445bc commit a661e26
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -753,8 +753,8 @@ An exception occurs if the file does not exist.
* `'r+'` - Open file for reading and writing.
An exception occurs if the file does not exist.

* `'rs'` - Open file for reading in synchronous mode. Instructs the operating
system to bypass the local file system cache.
* `'rs+'` - Open file for reading and writing in synchronous mode. Instructs
the operating system to bypass the local file system cache.

This is primarily useful for opening files on NFS mounts as it allows you to
skip the potentially stale local cache. It has a very real impact on I/O
Expand All @@ -763,9 +763,6 @@ An exception occurs if the file does not exist.
Note that this doesn't turn `fs.open()` into a synchronous blocking call.
If that's what you want then you should be using `fs.openSync()`

* `'rs+'` - Open file for reading and writing, telling the OS to open it
synchronously. See notes for `'rs'` about using this with caution.

* `'w'` - Open file for writing.
The file is created (if it does not exist) or truncated (if it exists).

Expand Down

0 comments on commit a661e26

Please sign in to comment.