summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSaúl Ibarra Corretgé <saghul@gmail.com>2016-05-13 10:21:40 +0200
committerSaúl Ibarra Corretgé <saghul@gmail.com>2016-05-13 12:08:02 +0200
commita661e263005f6c403659be93b7e64b09e373f913 (patch)
treea1796f40dd8b56405dac7a7703e0dad49954c7ee /doc
parent9d445bce07df082e74f60d59e4543e36c7cfae3c (diff)
downloadandroid-node-v8-a661e263005f6c403659be93b7e64b09e373f913.tar.gz
android-node-v8-a661e263005f6c403659be93b7e64b09e373f913.tar.bz2
android-node-v8-a661e263005f6c403659be93b7e64b09e373f913.zip
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>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/fs.md7
1 files changed, 2 insertions, 5 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md
index 895d5c5e93..84da81fa2f 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -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
@@ -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).