From 51d1960955148edb1558d9936eadbba98a690f94 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sa=C3=BAl=20Ibarra=20Corretg=C3=A9?= Date: Fri, 13 May 2016 10:21:40 +0200 Subject: [PATCH] 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 --- doc/api/fs.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index c854755d6d01ae..7ccf5c4bd016bc 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -748,8 +748,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 @@ -758,9 +758,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).