From 8969ae68d9de3581e53eb8bf30f1af85ab359493 Mon Sep 17 00:00:00 2001 From: Pavel Savara Date: Mon, 12 Apr 2021 17:17:20 +0200 Subject: [PATCH] make emsdk installation instructions clear on which version need to be installed (#51071) * make emsdk installation instructions clear on which version need to be installed * whitespace * Radek's feedback --- .../building/libraries/webassembly-instructions.md | 5 ++++- src/mono/wasm/README.md | 9 ++++++--- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/workflow/building/libraries/webassembly-instructions.md b/docs/workflow/building/libraries/webassembly-instructions.md index 315611d1ded..42004629c15 100644 --- a/docs/workflow/building/libraries/webassembly-instructions.md +++ b/docs/workflow/building/libraries/webassembly-instructions.md @@ -4,7 +4,10 @@ If you haven't already done so, please read [this document](../../README.md#Build_Requirements) to understand the build requirements for your operating system. -The Emscripten SDK (emsdk) needs to be installed. Follow the installation guide [here](https://emscripten.org/docs/getting_started/downloads.html#sdk-download-and-install) or run `make -C src/mono/wasm provision-wasm` to install emsdk into `src/mono/wasm/emsdk`. +The **correct version** of Emscripten SDK (emsdk) needs to be installed. +* Run `make -C src/mono/wasm provision-wasm` to install emsdk into `src/mono/wasm/emsdk`. +* Alternatively follow the [installation guide](https://emscripten.org/docs/getting_started/downloads.html#sdk-download-and-install). +Do not install `latest` but rather specific version e.g. `./emsdk install 2.0.12`. See [emscripten-version.txt](..\..\..\..\src\mono\wasm\emscripten-version.txt) Once installed the `EMSDK_PATH` environment variable needs to be set: diff --git a/src/mono/wasm/README.md b/src/mono/wasm/README.md index e2101b64b20..3e90f47d18d 100644 --- a/src/mono/wasm/README.md +++ b/src/mono/wasm/README.md @@ -4,9 +4,7 @@ This depends on `emsdk` to be installed. ## emsdk -* You can either install it yourself (https://emscripten.org/docs/getting_started/downloads.html), and set `EMSDK_PATH` to that. Make sure to have this set whenever building, or running tests for wasm. - -* Or you can run `make provision-wasm`, which will install it to `$reporoot/src/mono/wasm/emsdk`. +* You can run `make provision-wasm`, which will install it to `$reporoot/src/mono/wasm/emsdk`. Note: Irrespective of `$(EMSDK_PATH)`'s value, `provision-wasm` will always install into `$reporoot/src/mono/wasm/emsdk`. `EMSDK_PATH` is set to `$reporoot/src/mono/wasm/emsdk` by default, by the Makefile. @@ -14,6 +12,11 @@ Note: Irrespective of `$(EMSDK_PATH)`'s value, `provision-wasm` will always inst Note: `EMSDK_PATH` is set by default in `src/mono/wasm/Makefile`, so building targets from that will have it set. But you might need to set it manually if you are directly using the `dotnet build`, or `build.sh`. +* Alternatively you can install **correct version** yourself from the [Emscripten SDK guide](https://emscripten.org/docs/getting_started/downloads.html). +Do not install `latest` but rather specific version e.g. `./emsdk install 2.0.12`. See [emscripten-version.txt](./emscripten-version.txt) + +Make sure to set `EMSDK_PATH` variable, whenever building, or running tests for wasm. + ### Windows dependencies Windows build [requirements](https://github.com/dotnet/runtime/blob/main/docs/workflow/requirements/windows-requirements.md) -- GitLab