summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorIgor Zinkovsky <igorzi@microsoft.com>2012-05-22 16:02:10 -0700
committerIgor Zinkovsky <igorzi@microsoft.com>2012-05-24 01:15:15 -0700
commit39e25528eb769c36e2f8fa534861a23822c819fb (patch)
tree1e74885094a3fb0a94cff227e99c60b31c8d1bb6 /doc
parenta2fcc47772546faecda1bca6140d87341246bff9 (diff)
downloadnode-new-39e25528eb769c36e2f8fa534861a23822c819fb.tar.gz
windows: enable creating directory junctions with fs.symlink
Diffstat (limited to 'doc')
-rw-r--r--doc/api/fs.markdown4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/api/fs.markdown b/doc/api/fs.markdown
index 0d62956d83..0554eef517 100644
--- a/doc/api/fs.markdown
+++ b/doc/api/fs.markdown
@@ -178,8 +178,10 @@ 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'` or `'file'` (default is `'file'`). It is only
+`type` argument can be either `'dir'`, `'file'`, or `'junction'` (default is `'file'`). It is only
used 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.
## fs.symlinkSync(destination, path, [type])