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 windows shell support #16104

Closed
wants to merge 5 commits into from
+6 −0
Closed

doc: document windows shell support #16104

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dcde949
doc: document windows shell support
yamalight Oct 9, 2017
de56d13
doc: clarify winpty in windows support section
yamalight Oct 9, 2017
013732e
doc: clarify winpty usage from Git Bash
yamalight Oct 9, 2017
d524f37
doc: simplify windows shell support explanation
yamalight Oct 9, 2017
e9ca96d
doc: clarify that mintty note is related to running on windows
yamalight Oct 9, 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
6 changes: 6 additions & 0 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,12 @@ note1 - The gcc4.8-libs package needs to be installed, because node
by Joyent. SmartOS images >= 16.4 are not supported because
GCC 4.8 runtime libraries are not available in their pkgsrc repository

*Note*: On Windows, running Node.js in windows terminal emulators like `mintty`
requires the usage of [winpty](https://github.com/rprichard/winpty) for
Node's tty channels to work correctly (e.g. `winpty node.exe script.js`).
In "Git bash" if you call the node shell wrapper (`node` without the `.exe`
extension), `winpty` is used automatically.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd avoid adding this note because this is an implementation detail of "Git Bash" that could change anytime.

Copy link
Member

Choose a reason for hiding this comment

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

But it's also a really odd thing that isn't documented anywhere else, and the difference between node and node.exe is very unobvious.

I think it's worth documenting that if you're on Git Bash, you should just use node without the .exe to get the required behaviour, so far I've only seen it documented in Github comments (including by you 😁 ) , e.g. #5620 (comment) and #3006 (comment).

this is an implementation detail of "Git Bash" that could change anytime.

🤷‍♂️ , if it changes we can change the docs, but I wouldn't call it an implementation detail, this is an alias Git Bash added to make life easier for Node users.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm ambivalent. I had both arguments in my head ("GfW quirk" vs. "Undocumented helper")...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

so, what's the final decision here? any changes needed from my side?

I personally think that it'd be better to mention it now and change later if needed, for all it's worth.


### Supported toolchains

Depending on host platform, the selection of toolchains may vary.
Expand Down