diff options
author | Ben Noordhuis <info@bnoordhuis.nl> | 2023-05-09 11:21:42 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-05-09 09:21:42 +0000 |
commit | ad7a9a1c79c46b1fb3007dd42be16b01c9b94e63 (patch) | |
tree | 8dd1b19149e79331c670b2ad45d864680644afdd | |
parent | b2f6eedb65cb9252879a7843ce43f3e3c5ff8da4 (diff) | |
download | node-new-ad7a9a1c79c46b1fb3007dd42be16b01c9b94e63.tar.gz |
doc: ntfs junction points must link to directories
Fixes: https://github.com/nodejs/node/issues/40184
PR-URL: https://github.com/nodejs/node/pull/47907
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Debadree Chatterjee <debadree333@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
-rw-r--r-- | doc/api/fs.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index 4c8b736be6..cc8bce4b04 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1596,7 +1596,8 @@ The `type` argument is only used on Windows platforms and can be one of `'dir'`, 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. +automatically be normalized to absolute path. Junction points on NTFS volumes +can only point to directories. ### `fsPromises.truncate(path[, len])` @@ -4265,7 +4266,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. |