From 64d2fe5049ac34487f562c0e42bb74f6a1d57507 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Nie=C3=9Fen?= Date: Mon, 29 Jan 2024 15:45:38 +0000 Subject: [PATCH] doc: note that path.normalize deviates from POSIX PR-URL: https://github.com/nodejs/node/pull/51513 Refs: https://github.com/nodejs/node/issues/51345 Reviewed-By: Yagiz Nizipli Reviewed-By: Antoine du Hamel Reviewed-By: Luigi Pinca --- doc/api/path.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/api/path.md b/doc/api/path.md index d58fc044476bb9..c7a999cbb1ec22 100644 --- a/doc/api/path.md +++ b/doc/api/path.md @@ -361,6 +361,14 @@ instance of the platform-specific path segment separator (`/` on POSIX and If the `path` is a zero-length string, `'.'` is returned, representing the current working directory. +On POSIX, the types of normalization applied by this function do not strictly +adhere to the POSIX specification. For example, this function will replace two +leading forward slashes with a single slash as if it was a regular absolute +path, whereas a few POSIX systems assign special meaning to paths beginning with +exactly two forward slashes. Similarly, other substitutions performed by this +function, such as removing `..` segments, may change how the underlying system +resolves the path. + For example, on POSIX: ```js