1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

win, doc: document per-drive current working dir

Browse Source 
Add note to fs.md and path.md about Windows using per-drive current
working directory.

Fixes: https://github.com/nodejs/node/issues/9378
PR-URL: https://github.com/nodejs/node/pull/13330
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
This commit is contained in:
Bartosz Sosnowski 2017-06-06 11:19:23 +02:00
parent f1199c2bb4
commit 422722ff67
2 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/api/fs.md
View File

@ -94,6 +94,12 @@ Error: EISDIR: illegal operation on a directory, read
<stack trace.> <stack trace.>
``` ```
*Note:* On Windows Node.js follows the concept of per-drive working directory.
This behavior can be observed when using a drive path without a backslash. For
example `fs.readdirSync('c:\\')` can potentially return a different result than
`fs.readdirSync('c:')`. For more information, see
[this MSDN page][MSDN-Rel-Path].
## WHATWG URL object support ## WHATWG URL object support
<!-- YAML <!-- YAML
added: v7.6.0 added: v7.6.0
@ -2835,6 +2841,7 @@ The following constants are meant for use with the [`fs.Stats`][] object's
[FS Constants]: #fs_fs_constants_1 [FS Constants]: #fs_fs_constants_1
[MDN-Date-getTime]: https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date/getTime [MDN-Date-getTime]: https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date/getTime
[MDN-Date]: https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date [MDN-Date]: https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date
[MSDN-Rel-Path]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247.aspx#fully_qualified_vs._relative_paths
[Readable Stream]: stream.html#stream_class_stream_readable [Readable Stream]: stream.html#stream_class_stream_readable
[Writable Stream]: stream.html#stream_class_stream_writable [Writable Stream]: stream.html#stream_class_stream_writable
[inode]: https://en.wikipedia.org/wiki/Inode [inode]: https://en.wikipedia.org/wiki/Inode

7
doc/api/path.md
View File

@ -54,6 +54,12 @@ path.posix.basename('/tmp/myfile.html');
// Returns: 'myfile.html' // Returns: 'myfile.html'
``` ```
*Note:* On Windows Node.js follows the concept of per-drive working directory.
This behavior can be observed when using a drive path without a backslash. For
example `path.resolve('c:\\')` can potentially return a different result than
`path.resolve('c:')`. For more information, see
[this MSDN page][MSDN-Rel-Path].
## path.basename(path[, ext]) ## path.basename(path[, ext])
<!-- YAML <!-- YAML
added: v0.1.25 added: v0.1.25
@ -550,3 +556,4 @@ of the `path` methods.
[`path.posix`]: #path_path_posix [`path.posix`]: #path_path_posix
[`path.sep`]: #path_path_sep [`path.sep`]: #path_path_sep
[`path.win32`]: #path_path_win32 [`path.win32`]: #path_path_win32
[MSDN-Rel-Path]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247.aspx#fully_qualified_vs._relative_paths