Update unix-instructions.md (dotnet/corefx#38703)
authorDan Moseley <danmose@microsoft.com>
Thu, 20 Jun 2019 01:56:10 +0000 (18:56 -0700)
committerGitHub <noreply@github.com>
Thu, 20 Jun 2019 01:56:10 +0000 (18:56 -0700)
* Update unix-instructions.md

* Update unix-instructions.md

Commit migrated from https://github.com/dotnet/corefx/commit/055052f451d01c6f00209a682cac6f354caaa888

docs/libraries/building/unix-instructions.md

index 5ae518c..ba3d358 100644 (file)
@@ -67,6 +67,18 @@ In addition to the above packages, the runtime versions of the packages listed
 in the native section should also be installed (this happens automatically on
 most systems when you install the development packages).
 
+### Windows Subsystem For Linux
+
+Generally building and testing should work fine on Windows Subsystem for Linux (WSL) and it can be convenient if you primarily work on Windows and want to run tests sometimes on Linux. 
+
+There is one caveat: you must set the LANG in your shell to something other than the default. For example,
+```sh
+export LANG=en_US.UTF-8
+```
+Otherwise you may get errors like `PackagingException: File not found: '/home/dan/git/corefx/LICENSE.TXT'`. More info in [this issue](https://github.com/dotnet/corefx/issues/38608). It is possible this may occur on other distros, if LANG is set as above.
+
+We have not tested on WSL2 yet. If you try it out, we'd welcome an update.
+
 ### macOS
 
 macOS 10.12 or higher is needed to build corefx 2.x.
@@ -116,4 +128,3 @@ If you see errors along the lines of `SendFailure (Error writing headers)` you m
 mozroots --import --sync
 ```
 
-Bash on Ubuntu on Windows issues are tracked by: [#11057](https://github.com/dotnet/corefx/issues/11057)