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

doc,win: clarify WSL support #17008

Closed
Closed
Changes from 1 commit
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,12 @@ note1 - The gcc4.8-libs package needs to be installed, because node
In "Git bash" if you call the node shell alias (`node` without the `.exe`
extension), `winpty` is used automatically.

*Note*: The Windows Subsystem for Linux (WSL) is not directly supported, but
Copy link
Member

Choose a reason for hiding this comment

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

Nit: Perhaps remove *Note*: and let the paragraph stand on its own?

the GNU/Linux build process and binaries should work. The community will
only address issues that reproduce on native GNU/Linux systems, issues that
Copy link
Member

Choose a reason for hiding this comment

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

Nit: systems, issues that -> systems. Issues that

only reproduce on WSL should be reported in the
[WSL issue tracker](https://github.com/Microsoft/WSL/issues).
Copy link
Member

Choose a reason for hiding this comment

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

It would be good to mention executing node.exe in WSL is not supported either.

Copy link
Contributor

@refack refack Nov 14, 2017

Choose a reason for hiding this comment

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

Running the Windows binary (`node.exe`) in WSL is not supported, not recommended,
and will not work without adjustment (such as stdio standard stream redirection).


### Supported toolchains

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