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.

Sign up for GitHub

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

doc: document opening hidden files on Windows #15409

Closed
wants to merge 5 commits into from
Closed

doc: document opening hidden files on Windows #15409

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4d5ea77
doc: document opening hidden files on Windows
bzoz Sep 14, 2017
becc0b4
reword
bzoz Sep 18, 2017
876d70d
fixup: clarify truncate call
bzoz Oct 2, 2017
ada4383
fixup: only r+
bzoz Oct 3, 2017
8734b99
fixup: ftruncate instead of truncate
bzoz Oct 3, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,11 @@ example `fs.readdirSync('c:\\')` can potentially return a different result than
`fs.readdirSync('c:')`. For more information, see
[this MSDN page][MSDN-Rel-Path].

*Note:* On Windows opening existing hidden file using the `w` flag (either
Copy link
Member

Choose a reason for hiding this comment

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

nit: comma after On Windows

through `fs.open` or `fs.writeFile`) will fail with `EPERM`. You can work
Copy link
Contributor

Choose a reason for hiding this comment

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

A nit: fs.open(), fs.writeFile() and fs.ftruncate()?

Copy link
Contributor

Choose a reason for hiding this comment

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

Should be either opening an existing hidden file or opening existing hidden files.

Copy link
Member

Choose a reason for hiding this comment

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

Please avoid the use of informal pronouns like you in the docs

around this by opening the file with the `a` flag and then using `fs.ftruncate`
to clear the file contents.
Copy link
Contributor

Choose a reason for hiding this comment

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

Does ftruncate rewind the current file position to the beginning?


## Threadpool Usage

Note that all file system APIs except `fs.FSWatcher()` and those that are
Expand Down