Skip to content

Commit bf4eb05

Browse files
bnoordhuisMoLow
authored andcommittedJul 6, 2023
doc: ntfs junction points must link to directories
Fixes: #40184 PR-URL: #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>
1 parent 52532c2 commit bf4eb05

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed
 

‎doc/api/fs.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1579,7 +1579,8 @@ Creates a symbolic link.
15791579
The `type` argument is only used on Windows platforms and can be one of `'dir'`,
15801580
`'file'`, or `'junction'`. Windows junction points require the destination path
15811581
to be absolute. When using `'junction'`, the `target` argument will
1582-
automatically be normalized to absolute path.
1582+
automatically be normalized to absolute path. Junction points on NTFS volumes
1583+
can only point to directories.
15831584
15841585
### `fsPromises.truncate(path[, len])`
15851586
@@ -4204,7 +4205,8 @@ It can be set to `'dir'`, `'file'`, or `'junction'`. If the `type` argument is
42044205
not a string, Node.js will autodetect `target` type and use `'file'` or `'dir'`.
42054206
If the `target` does not exist, `'file'` will be used. Windows junction points
42064207
require the destination path to be absolute. When using `'junction'`, the
4207-
`target` argument will automatically be normalized to absolute path.
4208+
`target` argument will automatically be normalized to absolute path. Junction
4209+
points on NTFS volumes can only point to directories.
42084210

42094211
Relative targets are relative to the link's parent directory.
42104212

0 commit comments

Comments
 (0)
Please sign in to comment.