doc: fs: clarify fs.symlink Windows specific args

This commit is contained in:
Phillip Alexander 2013-10-26 13:13:56 -07:00 committed by Ben Noordhuis
parent 5ac6f4de13
commit 977c54adb5

View File

@ -197,8 +197,8 @@ Synchronous link(2).
Asynchronous symlink(2). No arguments other than a possible exception are given Asynchronous symlink(2). No arguments other than a possible exception are given
to the completion callback. to the completion callback.
`type` argument can be either `'dir'`, `'file'`, or `'junction'` (default is `'file'`). It is only The `type` argument can be set to `'dir'`, `'file'`, or `'junction'` (default
used on Windows (ignored on other platforms). is `'file'`) and is only available on Windows (ignored on other platforms).
Note that Windows junction points require the destination path to be absolute. When using Note that Windows junction points require the destination path to be absolute. When using
`'junction'`, the `destination` argument will automatically be normalized to absolute path. `'junction'`, the `destination` argument will automatically be normalized to absolute path.