diff options
| author | Phillip Alexander <git@phillipalexander.io> | 2013-10-26 13:13:56 -0700 |
|---|---|---|
| committer | Ben Noordhuis <info@bnoordhuis.nl> | 2013-10-27 21:02:19 +0100 |
| commit | 977c54adb5e5b7f083f02a294ca2825fe8eb7f2f (patch) | |
| tree | cf2cfbf68c37cc02eb57e192c7900c4d64ada1c4 | |
| parent | 5ac6f4de13bb2f18c264dfccfdcfea5a9118d43e (diff) | |
| download | node-977c54adb5e5b7f083f02a294ca2825fe8eb7f2f.tar.gz | |
doc: fs: clarify fs.symlink Windows specific args
| -rw-r--r-- | doc/api/fs.markdown | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/fs.markdown b/doc/api/fs.markdown index f940e6364..f886b73dc 100644 --- a/doc/api/fs.markdown +++ b/doc/api/fs.markdown @@ -197,8 +197,8 @@ Synchronous link(2). Asynchronous symlink(2). No arguments other than a possible exception are given to the completion callback. -`type` argument can be either `'dir'`, `'file'`, or `'junction'` (default is `'file'`). It is only -used on Windows (ignored on other platforms). +The `type` argument can be set to `'dir'`, `'file'`, or `'junction'` (default +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 `'junction'`, the `destination` argument will automatically be normalized to absolute path. |