Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

win, doc: document per-drive current working dir #13330

Closed
wants to merge 2 commits into from

Conversation

bzoz
Copy link
Contributor

@bzoz bzoz commented May 31, 2017

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

Fixes: #9378

Checklist
Affected core subsystem(s)

doc

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

Fixes: nodejs#9378
@bzoz bzoz added doc Issues and PRs related to the documentations. windows Issues and PRs related to the Windows platform. labels May 31, 2017
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label May 31, 2017
@mscdex mscdex added fs Issues and PRs related to the fs subsystem / file system. path Issues and PRs related to the path subsystem. labels May 31, 2017
doc/api/fs.md Outdated
@@ -94,6 +94,12 @@ Error: EISDIR: illegal operation on a directory, read
<stack trace.>
```

*Note:* On Windows Node follows the concept of per-drive working directory.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be Node.js although it's probably enough to just say Windows follows... as Node.js is not doing anything different from the OS behavior.

doc/api/path.md Outdated
@@ -54,6 +54,11 @@ path.posix.basename('/tmp/myfile.html');
// Returns: 'myfile.html'
```

*Note:* On Windows Node follows the concept of per-drive working directory.
This behavior can be observed when using a drive path without backslash, e.g.
`path.resolve('c:\\')` can potentially return different result than
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

return different -> return a different

doc/api/path.md Outdated
@@ -54,6 +54,11 @@ path.posix.basename('/tmp/myfile.html');
// Returns: 'myfile.html'
```

*Note:* On Windows Node follows the concept of per-drive working directory.
This behavior can be observed when using a drive path without backslash, e.g.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

without backslash -> without a backslash

doc/api/fs.md Outdated
@@ -94,6 +94,12 @@ Error: EISDIR: illegal operation on a directory, read
<stack trace.>
```

*Note:* On Windows Node follows the concept of per-drive working directory.
This behavior can be observed when using a drive path without backslash, e.g.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: , -> . and e.g. -> For example,.

doc/api/fs.md Outdated
@@ -94,6 +94,12 @@ Error: EISDIR: illegal operation on a directory, read
<stack trace.>
```

*Note:* On Windows Node follows the concept of per-drive working directory.
This behavior can be observed when using a drive path without backslash, e.g.
`fs.readdirSync('c:\\')` can potentially return different result than
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

return different result -> return a different result

doc/api/fs.md Outdated
*Note:* On Windows Node follows the concept of per-drive working directory.
This behavior can be observed when using a drive path without backslash, e.g.
`fs.readdirSync('c:\\')` can potentially return different result than
`fs.readdirSync('c:')`. For more information see
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

, after information

Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with (or without) nits addressed.

@bzoz
Copy link
Contributor Author

bzoz commented Jun 1, 2017

Updated, PTAL

@bzoz
Copy link
Contributor Author

bzoz commented Jun 6, 2017

Landed in 422722f

@bzoz bzoz closed this Jun 6, 2017
bzoz added a commit that referenced this pull request Jun 6, 2017
Add note to fs.md and path.md about Windows using per-drive current
working directory.

Fixes: #9378
PR-URL: #13330
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
@bzoz
Copy link
Contributor Author

bzoz commented Jun 6, 2017

@addaleax @cjihrig @Trott argh... I'm so sorry, I've missed your reviews in the commit metadata :(

jasnell pushed a commit that referenced this pull request Jun 7, 2017
Add note to fs.md and path.md about Windows using per-drive current
working directory.

Fixes: #9378
PR-URL: #13330
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
@gibfahn gibfahn mentioned this pull request Jun 15, 2017
3 tasks
@MylesBorins
Copy link
Contributor

This does not land cleanly in LTS. Please feel free to manually backport. Please also feel free to replace do-not-land if it is being backported

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. path Issues and PRs related to the path subsystem. windows Issues and PRs related to the Windows platform.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

readdirSync of drive letter lists items of cwd