Skip to content

Commit bf39f2d

Browse files
bnoordhuistargos
authored andcommitted
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 4293cc4 commit bf39f2d

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
@@ -1596,7 +1596,8 @@ The `type` argument is only used on Windows platforms and can be one of `'dir'`,
15961596
autodetect `target` type and use `'file'` or `'dir'`. If the `target` does not
15971597
exist, `'file'` will be used. Windows junction points require the destination
15981598
path to be absolute. When using `'junction'`, the `target` argument will
1599-
automatically be normalized to absolute path.
1599+
automatically be normalized to absolute path. Junction points on NTFS volumes
1600+
can only point to directories.
16001601
16011602
### `fsPromises.truncate(path[, len])`
16021603
@@ -4265,7 +4266,8 @@ It can be set to `'dir'`, `'file'`, or `'junction'`. If the `type` argument is
42654266
not a string, Node.js will autodetect `target` type and use `'file'` or `'dir'`.
42664267
If the `target` does not exist, `'file'` will be used. Windows junction points
42674268
require the destination path to be absolute. When using `'junction'`, the
4268-
`target` argument will automatically be normalized to absolute path.
4269+
`target` argument will automatically be normalized to absolute path. Junction
4270+
points on NTFS volumes can only point to directories.
42694271

42704272
Relative targets are relative to the link's parent directory.
42714273

0 commit comments

Comments
 (0)