From 19d623e3fa0f0c11621e5a1c737d9f6bb65d4305 Mon Sep 17 00:00:00 2001 From: Ben Noordhuis Date: Tue, 9 May 2023 11:21:42 +0200 Subject: [PATCH] doc: ntfs junction points must link to directories MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes: https://github.com/nodejs/node/issues/40184 PR-URL: https://github.com/nodejs/node/pull/47907 Reviewed-By: Tobias Nießen Reviewed-By: Michaël Zasso Reviewed-By: Debadree Chatterjee Reviewed-By: Colin Ihrig Reviewed-By: Luigi Pinca --- doc/api/fs.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 4721364dedc4a6..fe592ffdac3951 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1579,7 +1579,8 @@ Creates a symbolic link. The `type` argument is only used on Windows platforms and can be one of `'dir'`, `'file'`, or `'junction'`. Windows junction points require the destination path to be absolute. When using `'junction'`, the `target` argument will -automatically be normalized to absolute path. +automatically be normalized to absolute path. Junction points on NTFS volumes +can only point to directories. ### `fsPromises.truncate(path[, len])` @@ -4204,7 +4205,8 @@ It can be set to `'dir'`, `'file'`, or `'junction'`. If the `type` argument is not a string, Node.js will autodetect `target` type and use `'file'` or `'dir'`. If the `target` does not exist, `'file'` will be used. Windows junction points require the destination path to be absolute. When using `'junction'`, the -`target` argument will automatically be normalized to absolute path. +`target` argument will automatically be normalized to absolute path. Junction +points on NTFS volumes can only point to directories. Relative targets are relative to the link's parent directory.