From bc0d71c0ead1222502c62ec408ce8b65ed85a849 Mon Sep 17 00:00:00 2001
From: iwko <iwoczerniawski@gmail.com>
Date: Sun, 10 Jun 2018 15:28:00 +0200
Subject: [PATCH 1/7] doc: documentation of sync methods links now to async
 methods

---
 doc/api/fs.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/doc/api/fs.md b/doc/api/fs.md
index aa1a43f1ecc14c..01dbd3032a730b 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -1140,6 +1140,8 @@ changes:
 Synchronously changes the permissions of a file. Returns `undefined`.
 This is the synchronous version of [`fs.chmod()`][].
 
+For detailed information, see the documentation of [`fs.chmod()`][].
+
 See also: chmod(2).
 
 ## fs.chown(path, uid, gid, callback)
@@ -1570,10 +1572,13 @@ changes:
 Synchronous version of [`fs.exists()`][].
 Returns `true` if the path exists, `false` otherwise.
 
+For detailed information, see the documentation of [`fs.exists()`][].
+
 `fs.exists()` is deprecated, but `fs.existsSync()` is not. The `callback`
 parameter to `fs.exists()` accepts parameters that are inconsistent with other
 Node.js callbacks. `fs.existsSync()` does not use a callback.
 
+
 ## fs.fchmod(fd, mode, callback)
 <!-- YAML
 added: v0.4.7
@@ -1822,6 +1827,8 @@ added: v0.8.6
 
 Synchronous ftruncate(2). Returns `undefined`.
 
+For detailed information, see the documentation of [`fs.ftruncate()`][].
+
 ## fs.futimes(fd, atime, mtime, callback)
 <!-- YAML
 added: v0.4.2
@@ -2173,6 +2180,8 @@ added: v5.10.0
 The synchronous version of [`fs.mkdtemp()`][]. Returns the created
 folder path.
 
+For detailed information, see the documentation of [`fs.mkdtemp()`][].
+
 The optional `options` argument can be a string specifying an encoding, or an
 object with an `encoding` property specifying the character encoding to use.
 
@@ -2230,6 +2239,8 @@ changes:
 Synchronous version of [`fs.open()`][]. Returns an integer representing the file
 descriptor.
 
+For detailed information, see the documentation of [`fs.open()`][].
+
 ## fs.read(fd, buffer, offset, length, position, callback)
 <!-- YAML
 added: v0.0.2
@@ -2428,6 +2439,8 @@ changes:
 
 Synchronous version of [`fs.readFile()`][]. Returns the contents of the `path`.
 
+For detailed information, see the documentation of [`fs.readFile()`][].
+
 If the `encoding` option is specified then this function returns a
 string. Otherwise it returns a buffer.
 
@@ -2516,6 +2529,8 @@ changes:
 
 Synchronous version of [`fs.read()`][]. Returns the number of `bytesRead`.
 
+For detailed information, see the documentation of [`fs.read()`][].
+
 ## fs.realpath(path[, options], callback)
 <!-- YAML
 added: v0.1.31
@@ -2631,6 +2646,8 @@ changes:
 
 Synchronous version of [`fs.realpath()`][]. Returns the resolved pathname.
 
+For detailed information, see the documentation of [`fs.realpath()`][].
+
 ## fs.realpathSync.native(path[, options])
 <!-- YAML
 added: v9.2.0
@@ -2867,6 +2884,8 @@ changes:
 
 Synchronous symlink(2). Returns `undefined`.
 
+For detailed information, see the documentation of [`fs.symlink()`][].
+
 ## fs.truncate(path[, len], callback)
 <!-- YAML
 added: v0.8.6
@@ -3043,6 +3062,8 @@ changes:
 
 Synchronous version of [`fs.utimes()`][]. Returns `undefined`.
 
+For detailed information, see the documentation of [`fs.utimes()`][].
+
 ## fs.watch(filename[, options][, listener])
 <!-- YAML
 added: v0.5.10
@@ -3394,6 +3415,8 @@ changes:
 
 The synchronous version of [`fs.writeFile()`][]. Returns `undefined`.
 
+For detailed information, see the documentation of [`fs.writeFile()`][].
+
 ## fs.writeSync(fd, buffer[, offset[, length[, position]]])
 <!-- YAML
 added: v0.1.21
@@ -3430,6 +3453,8 @@ changes:
 
 Synchronous versions of [`fs.write()`][]. Returns the number of bytes written.
 
+For detailed information, see the documentation of [`fs.write()`][].
+
 ## fs Promises API
 
 > Stability: 1 - Experimental

From 651d11a849a51645cbe2b9fd52b72ce02bd6f2d5 Mon Sep 17 00:00:00 2001
From: iwko <iwoczerniawski@gmail.com>
Date: Mon, 11 Jun 2018 18:48:33 +0200
Subject: [PATCH 2/7] doc: Link fs.ftruncate and fs.symlink methods

---
 doc/api/fs.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/doc/api/fs.md b/doc/api/fs.md
index 01dbd3032a730b..08a46e011ab693 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -4617,6 +4617,7 @@ the file contents.
 [`fs.chown()`]: #fs_fs_chown_path_uid_gid_callback
 [`fs.copyFile()`]: #fs_fs_copyfile_src_dest_flags_callback
 [`fs.exists()`]: fs.html#fs_fs_exists_path_callback
+[`fs.ftruncate()`]: #fs_fs_ftruncate_fd_len_callback
 [`fs.fstat()`]: #fs_fs_fstat_fd_options_callback
 [`fs.futimes()`]: #fs_fs_futimes_fd_atime_mtime_callback
 [`fs.lstat()`]: #fs_fs_lstat_path_options_callback
@@ -4629,6 +4630,7 @@ the file contents.
 [`fs.realpath()`]: #fs_fs_realpath_path_options_callback
 [`fs.rmdir()`]: #fs_fs_rmdir_path_callback
 [`fs.stat()`]: #fs_fs_stat_path_options_callback
+[`fs.symlink()`]: #fs_fs_symlink_target_path_type_callback
 [`fs.utimes()`]: #fs_fs_utimes_path_atime_mtime_callback
 [`fs.watch()`]: #fs_fs_watch_filename_options_listener
 [`fs.write()`]: #fs_fs_write_fd_buffer_offset_length_position_callback

From 1dc060af4d9da83051aa6c774cecff0376508989 Mon Sep 17 00:00:00 2001
From: iwko <iwoczerniawski@gmail.com>
Date: Sat, 23 Jun 2018 10:28:18 +0200
Subject: [PATCH 3/7] doc: fs sync methods links now to async methods

---
 doc/api/fs.md | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/doc/api/fs.md b/doc/api/fs.md
index 08a46e011ab693..4c01f4dea425d2 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -1140,7 +1140,7 @@ changes:
 Synchronously changes the permissions of a file. Returns `undefined`.
 This is the synchronous version of [`fs.chmod()`][].
 
-For detailed information, see the documentation of [`fs.chmod()`][].
+For detailed information, see the documentation of the asynchronous version of this API: [`fs.chmod()`][].
 
 See also: chmod(2).
 
@@ -1572,7 +1572,7 @@ changes:
 Synchronous version of [`fs.exists()`][].
 Returns `true` if the path exists, `false` otherwise.
 
-For detailed information, see the documentation of [`fs.exists()`][].
+For detailed information, see the documentation of the asynchronous version of this API: [`fs.exists()`][].
 
 `fs.exists()` is deprecated, but `fs.existsSync()` is not. The `callback`
 parameter to `fs.exists()` accepts parameters that are inconsistent with other
@@ -1827,7 +1827,7 @@ added: v0.8.6
 
 Synchronous ftruncate(2). Returns `undefined`.
 
-For detailed information, see the documentation of [`fs.ftruncate()`][].
+For detailed information, see the documentation of the asynchronous version of this API: [`fs.ftruncate()`][].
 
 ## fs.futimes(fd, atime, mtime, callback)
 <!-- YAML
@@ -2180,7 +2180,7 @@ added: v5.10.0
 The synchronous version of [`fs.mkdtemp()`][]. Returns the created
 folder path.
 
-For detailed information, see the documentation of [`fs.mkdtemp()`][].
+For detailed information, see the documentation of the asynchronous version of this API: [`fs.mkdtemp()`][].
 
 The optional `options` argument can be a string specifying an encoding, or an
 object with an `encoding` property specifying the character encoding to use.
@@ -2239,7 +2239,7 @@ changes:
 Synchronous version of [`fs.open()`][]. Returns an integer representing the file
 descriptor.
 
-For detailed information, see the documentation of [`fs.open()`][].
+For detailed information, see the documentation of the asynchronous version of this API: [`fs.open()`][].
 
 ## fs.read(fd, buffer, offset, length, position, callback)
 <!-- YAML
@@ -2439,7 +2439,7 @@ changes:
 
 Synchronous version of [`fs.readFile()`][]. Returns the contents of the `path`.
 
-For detailed information, see the documentation of [`fs.readFile()`][].
+For detailed information, see the documentation of the asynchronous version of this API: [`fs.readFile()`][].
 
 If the `encoding` option is specified then this function returns a
 string. Otherwise it returns a buffer.
@@ -2529,7 +2529,7 @@ changes:
 
 Synchronous version of [`fs.read()`][]. Returns the number of `bytesRead`.
 
-For detailed information, see the documentation of [`fs.read()`][].
+For detailed information, see the documentation of the asynchronous version of this API: [`fs.read()`][].
 
 ## fs.realpath(path[, options], callback)
 <!-- YAML
@@ -2646,7 +2646,7 @@ changes:
 
 Synchronous version of [`fs.realpath()`][]. Returns the resolved pathname.
 
-For detailed information, see the documentation of [`fs.realpath()`][].
+For detailed information, see the documentation of the asynchronous version of this API: [`fs.realpath()`][].
 
 ## fs.realpathSync.native(path[, options])
 <!-- YAML
@@ -2884,7 +2884,7 @@ changes:
 
 Synchronous symlink(2). Returns `undefined`.
 
-For detailed information, see the documentation of [`fs.symlink()`][].
+For detailed information, see the documentation of the asynchronous version of this API: [`fs.symlink()`][].
 
 ## fs.truncate(path[, len], callback)
 <!-- YAML
@@ -3062,7 +3062,7 @@ changes:
 
 Synchronous version of [`fs.utimes()`][]. Returns `undefined`.
 
-For detailed information, see the documentation of [`fs.utimes()`][].
+For detailed information, see the documentation of the asynchronous version of this API: [`fs.utimes()`][].
 
 ## fs.watch(filename[, options][, listener])
 <!-- YAML
@@ -3415,7 +3415,7 @@ changes:
 
 The synchronous version of [`fs.writeFile()`][]. Returns `undefined`.
 
-For detailed information, see the documentation of [`fs.writeFile()`][].
+For detailed information, see the documentation of the asynchronous version of this API: [`fs.writeFile()`][].
 
 ## fs.writeSync(fd, buffer[, offset[, length[, position]]])
 <!-- YAML
@@ -3453,7 +3453,7 @@ changes:
 
 Synchronous versions of [`fs.write()`][]. Returns the number of bytes written.
 
-For detailed information, see the documentation of [`fs.write()`][].
+For detailed information, see the documentation of the asynchronous version of this API: [`fs.write()`][].
 
 ## fs Promises API
 

From 373e6fda5354ad2c75401ca4fd65c2ed00bf8a30 Mon Sep 17 00:00:00 2001
From: iwko <iwoczerniawski@gmail.com>
Date: Sat, 23 Jun 2018 16:12:03 +0200
Subject: [PATCH 4/7] doc: fix max line length in fs.md

---
 doc/api/fs.md | 36 ++++++++++++++++++++++++------------
 1 file changed, 24 insertions(+), 12 deletions(-)

diff --git a/doc/api/fs.md b/doc/api/fs.md
index 4c01f4dea425d2..eaaf53ecb02eea 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -1140,7 +1140,8 @@ changes:
 Synchronously changes the permissions of a file. Returns `undefined`.
 This is the synchronous version of [`fs.chmod()`][].
 
-For detailed information, see the documentation of the asynchronous version of this API: [`fs.chmod()`][].
+For detailed information, see the documentation of the asynchronous version of
+this API: [`fs.chmod()`][].
 
 See also: chmod(2).
 
@@ -1572,7 +1573,8 @@ changes:
 Synchronous version of [`fs.exists()`][].
 Returns `true` if the path exists, `false` otherwise.
 
-For detailed information, see the documentation of the asynchronous version of this API: [`fs.exists()`][].
+For detailed information, see the documentation of the asynchronous version of
+this API: [`fs.exists()`][].
 
 `fs.exists()` is deprecated, but `fs.existsSync()` is not. The `callback`
 parameter to `fs.exists()` accepts parameters that are inconsistent with other
@@ -1827,7 +1829,8 @@ added: v0.8.6
 
 Synchronous ftruncate(2). Returns `undefined`.
 
-For detailed information, see the documentation of the asynchronous version of this API: [`fs.ftruncate()`][].
+For detailed information, see the documentation of the asynchronous version of
+this API: [`fs.ftruncate()`][].
 
 ## fs.futimes(fd, atime, mtime, callback)
 <!-- YAML
@@ -2180,7 +2183,8 @@ added: v5.10.0
 The synchronous version of [`fs.mkdtemp()`][]. Returns the created
 folder path.
 
-For detailed information, see the documentation of the asynchronous version of this API: [`fs.mkdtemp()`][].
+For detailed information, see the documentation of the asynchronous version of
+this API: [`fs.mkdtemp()`][].
 
 The optional `options` argument can be a string specifying an encoding, or an
 object with an `encoding` property specifying the character encoding to use.
@@ -2239,7 +2243,8 @@ changes:
 Synchronous version of [`fs.open()`][]. Returns an integer representing the file
 descriptor.
 
-For detailed information, see the documentation of the asynchronous version of this API: [`fs.open()`][].
+For detailed information, see the documentation of the asynchronous version of
+this API: [`fs.open()`][].
 
 ## fs.read(fd, buffer, offset, length, position, callback)
 <!-- YAML
@@ -2439,7 +2444,8 @@ changes:
 
 Synchronous version of [`fs.readFile()`][]. Returns the contents of the `path`.
 
-For detailed information, see the documentation of the asynchronous version of this API: [`fs.readFile()`][].
+For detailed information, see the documentation of the asynchronous version of
+this API: [`fs.readFile()`][].
 
 If the `encoding` option is specified then this function returns a
 string. Otherwise it returns a buffer.
@@ -2529,7 +2535,8 @@ changes:
 
 Synchronous version of [`fs.read()`][]. Returns the number of `bytesRead`.
 
-For detailed information, see the documentation of the asynchronous version of this API: [`fs.read()`][].
+For detailed information, see the documentation of the asynchronous version of
+this API: [`fs.read()`][].
 
 ## fs.realpath(path[, options], callback)
 <!-- YAML
@@ -2646,7 +2653,8 @@ changes:
 
 Synchronous version of [`fs.realpath()`][]. Returns the resolved pathname.
 
-For detailed information, see the documentation of the asynchronous version of this API: [`fs.realpath()`][].
+For detailed information, see the documentation of the asynchronous version of
+this API: [`fs.realpath()`][].
 
 ## fs.realpathSync.native(path[, options])
 <!-- YAML
@@ -2884,7 +2892,8 @@ changes:
 
 Synchronous symlink(2). Returns `undefined`.
 
-For detailed information, see the documentation of the asynchronous version of this API: [`fs.symlink()`][].
+For detailed information, see the documentation of the asynchronous version of
+this API: [`fs.symlink()`][].
 
 ## fs.truncate(path[, len], callback)
 <!-- YAML
@@ -3062,7 +3071,8 @@ changes:
 
 Synchronous version of [`fs.utimes()`][]. Returns `undefined`.
 
-For detailed information, see the documentation of the asynchronous version of this API: [`fs.utimes()`][].
+For detailed information, see the documentation of the asynchronous version of
+this API: [`fs.utimes()`][].
 
 ## fs.watch(filename[, options][, listener])
 <!-- YAML
@@ -3415,7 +3425,8 @@ changes:
 
 The synchronous version of [`fs.writeFile()`][]. Returns `undefined`.
 
-For detailed information, see the documentation of the asynchronous version of this API: [`fs.writeFile()`][].
+For detailed information, see the documentation of the asynchronous version of
+this API: [`fs.writeFile()`][].
 
 ## fs.writeSync(fd, buffer[, offset[, length[, position]]])
 <!-- YAML
@@ -3453,7 +3464,8 @@ changes:
 
 Synchronous versions of [`fs.write()`][]. Returns the number of bytes written.
 
-For detailed information, see the documentation of the asynchronous version of this API: [`fs.write()`][].
+For detailed information, see the documentation of the asynchronous version of
+this API: [`fs.write()`][].
 
 ## fs Promises API
 

From c53f7f419d464f000f3e9115f9e345454ae71e5a Mon Sep 17 00:00:00 2001
From: iwko <iwoczerniawski@gmail.com>
Date: Wed, 27 Jun 2018 21:10:51 +0200
Subject: [PATCH 5/7] doc: Remove sentences like 'This is the synchronous
 version of..' from fs.md

---
 doc/api/fs.md | 24 ++++++++++--------------
 1 file changed, 10 insertions(+), 14 deletions(-)

diff --git a/doc/api/fs.md b/doc/api/fs.md
index eaaf53ecb02eea..0b5932ce893b1d 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -1138,7 +1138,6 @@ changes:
 * `mode` {integer}
 
 Synchronously changes the permissions of a file. Returns `undefined`.
-This is the synchronous version of [`fs.chmod()`][].
 
 For detailed information, see the documentation of the asynchronous version of
 this API: [`fs.chmod()`][].
@@ -1570,7 +1569,6 @@ changes:
 * `path` {string|Buffer|URL}
 * Returns: {boolean}
 
-Synchronous version of [`fs.exists()`][].
 Returns `true` if the path exists, `false` otherwise.
 
 For detailed information, see the documentation of the asynchronous version of
@@ -1827,7 +1825,7 @@ added: v0.8.6
 * `fd` {integer}
 * `len` {integer} **Default:** `0`
 
-Synchronous ftruncate(2). Returns `undefined`.
+Returns `undefined`.
 
 For detailed information, see the documentation of the asynchronous version of
 this API: [`fs.ftruncate()`][].
@@ -2180,8 +2178,7 @@ added: v5.10.0
   * `encoding` {string} **Default:** `'utf8'`
 * Returns: {string}
 
-The synchronous version of [`fs.mkdtemp()`][]. Returns the created
-folder path.
+Returns the created folder path.
 
 For detailed information, see the documentation of the asynchronous version of
 this API: [`fs.mkdtemp()`][].
@@ -2240,8 +2237,7 @@ changes:
 * `mode` {integer} **Default:** `0o666`
 * Returns: {number}
 
-Synchronous version of [`fs.open()`][]. Returns an integer representing the file
-descriptor.
+Returns an integer representing the file descriptor.
 
 For detailed information, see the documentation of the asynchronous version of
 this API: [`fs.open()`][].
@@ -2442,7 +2438,7 @@ changes:
   * `flag` {string} See [support of file system `flags`][]. **Default:** `'r'`.
 * Returns: {string|Buffer}
 
-Synchronous version of [`fs.readFile()`][]. Returns the contents of the `path`.
+Returns the contents of the `path`.
 
 For detailed information, see the documentation of the asynchronous version of
 this API: [`fs.readFile()`][].
@@ -2533,7 +2529,7 @@ changes:
 * `position` {integer}
 * Returns: {number}
 
-Synchronous version of [`fs.read()`][]. Returns the number of `bytesRead`.
+Returns the number of `bytesRead`.
 
 For detailed information, see the documentation of the asynchronous version of
 this API: [`fs.read()`][].
@@ -2651,7 +2647,7 @@ changes:
   * `encoding` {string} **Default:** `'utf8'`
 * Returns: {string|Buffer}
 
-Synchronous version of [`fs.realpath()`][]. Returns the resolved pathname.
+Returns the resolved pathname.
 
 For detailed information, see the documentation of the asynchronous version of
 this API: [`fs.realpath()`][].
@@ -2890,7 +2886,7 @@ changes:
 * `path` {string|Buffer|URL}
 * `type` {string} **Default:** `'file'`
 
-Synchronous symlink(2). Returns `undefined`.
+Returns `undefined`.
 
 For detailed information, see the documentation of the asynchronous version of
 this API: [`fs.symlink()`][].
@@ -3069,7 +3065,7 @@ changes:
 * `atime` {integer}
 * `mtime` {integer}
 
-Synchronous version of [`fs.utimes()`][]. Returns `undefined`.
+Returns `undefined`.
 
 For detailed information, see the documentation of the asynchronous version of
 this API: [`fs.utimes()`][].
@@ -3423,7 +3419,7 @@ changes:
   * `mode` {integer} **Default:** `0o666`
   * `flag` {string} See [support of file system `flags`][]. **Default:** `'w'`.
 
-The synchronous version of [`fs.writeFile()`][]. Returns `undefined`.
+Returns `undefined`.
 
 For detailed information, see the documentation of the asynchronous version of
 this API: [`fs.writeFile()`][].
@@ -3462,7 +3458,7 @@ changes:
 * `encoding` {string}
 * Returns: {number}
 
-Synchronous versions of [`fs.write()`][]. Returns the number of bytes written.
+Returns the number of bytes written.
 
 For detailed information, see the documentation of the asynchronous version of
 this API: [`fs.write()`][].

From 36a392e9d26aec58da7cb543f48fad607f56fa07 Mon Sep 17 00:00:00 2001
From: iwko <iwoczerniawski@gmail.com>
Date: Wed, 27 Jun 2018 21:12:05 +0200
Subject: [PATCH 6/7] doc: change fs.chmod() description

---
 doc/api/fs.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/api/fs.md b/doc/api/fs.md
index 0b5932ce893b1d..9a22da49c546df 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -1137,7 +1137,7 @@ changes:
 * `path` {string|Buffer|URL}
 * `mode` {integer}
 
-Synchronously changes the permissions of a file. Returns `undefined`.
+Returns `undefined`.
 
 For detailed information, see the documentation of the asynchronous version of
 this API: [`fs.chmod()`][].

From 9921a76e596d822e305aad12819c445155cdbb07 Mon Sep 17 00:00:00 2001
From: iwko <iwoczerniawski@gmail.com>
Date: Sun, 8 Jul 2018 22:44:35 +0200
Subject: [PATCH 7/7] doc: remove unnecessary info about returned value in
 fs.chmod.

---
 doc/api/fs.md | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/doc/api/fs.md b/doc/api/fs.md
index 9a22da49c546df..3f19ccc3cd526b 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -1137,8 +1137,6 @@ changes:
 * `path` {string|Buffer|URL}
 * `mode` {integer}
 
-Returns `undefined`.
-
 For detailed information, see the documentation of the asynchronous version of
 this API: [`fs.chmod()`][].
 
@@ -4625,8 +4623,8 @@ the file contents.
 [`fs.chown()`]: #fs_fs_chown_path_uid_gid_callback
 [`fs.copyFile()`]: #fs_fs_copyfile_src_dest_flags_callback
 [`fs.exists()`]: fs.html#fs_fs_exists_path_callback
-[`fs.ftruncate()`]: #fs_fs_ftruncate_fd_len_callback
 [`fs.fstat()`]: #fs_fs_fstat_fd_options_callback
+[`fs.ftruncate()`]: #fs_fs_ftruncate_fd_len_callback
 [`fs.futimes()`]: #fs_fs_futimes_fd_atime_mtime_callback
 [`fs.lstat()`]: #fs_fs_lstat_path_options_callback
 [`fs.mkdir()`]: #fs_fs_mkdir_path_mode_callback