doc: ntfs junction points must link to directories

Fixes: #40184 PR-URL: #47907 Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Debadree Chatterjee <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Jul 6, 2023 · bf4eb05 · bf4eb05
1 parent 52532c2
commit bf4eb05
Showing 1 changed file with 4 additions and 2 deletions.
diff --git 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.