diff --git a/doc/api/fs.md b/doc/api/fs.md index c3aa16ac2515ef..435cc56d18dffe 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2481,7 +2481,7 @@ changes: Asynchronously computes the canonical pathname by resolving `.`, `..` and symbolic links. -Note that "canonical" does not mean "unique": hard links and bind mounts can +A canonical pathname is not necessarily unique. Hard links and bind mounts can expose a file system entity through many pathnames. This function behaves like realpath(3), with some exceptions: @@ -2556,26 +2556,7 @@ changes: * `encoding` {string} **Default:** `'utf8'` * Returns: {string|Buffer} -Synchronously computes the canonical pathname by resolving `.`, `..` and -symbolic links. - -Note that "canonical" does not mean "unique": hard links and bind mounts can -expose a file system entity through many pathnames. - -This function behaves like realpath(3), with some exceptions: - -1. No case conversion is performed on case-insensitive file systems. - -2. The maximum number of symbolic links is platform-independent and generally - (much) higher than what the native realpath(3) implementation supports. - -The optional `options` argument can be a string specifying an encoding, or an -object with an `encoding` property specifying the character encoding to use for -the returned value. If the `encoding` is set to `'buffer'`, the path returned -will be passed as a `Buffer` object. - -If `path` resolves to a socket or a pipe, the function will return a system -dependent name for that object. +Synchronous version of [`fs.realpath()`][]. Returns the resolved pathname. ## fs.realpathSync.native(path[, options])