Browse Source

doc: undocument fs.open's 'rs' mode

Using O_SYNC with O_RDONLY is basically a noop.

Closes: https://github.com/nodejs/node/issues/6730
PR-URL: https://github.com/nodejs/node/pull/6732
Reviewed-By: Ben Noorhduis <info@bnoordhuis.nl>
process-exit-stdio-flushing
Saúl Ibarra Corretgé 9 years ago
parent
commit
a661e26300
  1. 7
      doc/api/fs.md

7
doc/api/fs.md

@ -753,8 +753,8 @@ An exception occurs if the file does not exist.
* `'r+'` - Open file for reading and writing. * `'r+'` - Open file for reading and writing.
An exception occurs if the file does not exist. An exception occurs if the file does not exist.
* `'rs'` - Open file for reading in synchronous mode. Instructs the operating * `'rs+'` - Open file for reading and writing in synchronous mode. Instructs
system to bypass the local file system cache. 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 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 skip the potentially stale local cache. It has a very real impact on I/O
@ -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. 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()` 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. * `'w'` - Open file for writing.
The file is created (if it does not exist) or truncated (if it exists). The file is created (if it does not exist) or truncated (if it exists).

Loading…
Cancel
Save