summaryrefslogtreecommitdiff
path: root/BUILDING.md
diff options
context:
space:
mode:
authorJoão Reis <reis@janeasystems.com>2017-11-14 02:44:25 +0000
committerJoão Reis <reis@janeasystems.com>2017-11-17 17:41:20 +0000
commitd8debd8448a1d325a564c42e5639655973b7641b (patch)
tree671ff3ceb9c68319c4d972a2300b3bc9efab6e21 /BUILDING.md
parent9b4ab1452da677fe6979de336a0f157ba1c2f528 (diff)
downloadandroid-node-v8-d8debd8448a1d325a564c42e5639655973b7641b.tar.gz
android-node-v8-d8debd8448a1d325a564c42e5639655973b7641b.tar.bz2
android-node-v8-d8debd8448a1d325a564c42e5639655973b7641b.zip
doc,win: clarify WSL support
Fixes: https://github.com/nodejs/node/issues/13471 PR-URL: https://github.com/nodejs/node/pull/17008 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Hitesh Kanwathirtha <hiteshk@microsoft.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'BUILDING.md')
-rw-r--r--BUILDING.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/BUILDING.md b/BUILDING.md
index 52c11aa08e..cd819b4b47 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -66,6 +66,14 @@ 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.
+The Windows Subsystem for Linux (WSL) is not directly supported, but the
+GNU/Linux build process and binaries should work. The community will only
+address issues that reproduce on native GNU/Linux systems. Issues that only
+reproduce on WSL should be reported in the
+[WSL issue tracker](https://github.com/Microsoft/WSL/issues). Running the
+Windows binary (`node.exe`) in WSL is not recommended, and will not work
+without adjustment (such as stdio redirection).
+
### Supported toolchains
Depending on host platform, the selection of toolchains may vary.