From: Daniel Bevenius <redacted>
Date: Fri, 9 May 2025 13:42:45 +0000 (+0200)
Subject: wasm : add note about worker.js file generation [no ci] (#3133)
X-Git-Url: https://git.djapps.eu/?a=commitdiff_plain;h=97916476537245463d47c25cf800dd2275c76fcd;p=pkg%2Fggml%2Fsources%2Fwhisper.cpp

wasm : add note about worker.js file generation [no ci] (#3133)

This commit updates the documentation for the WASM examples to include a
note about the generation of the `worker.js` file. As of Emscripten
3.1.58 (April 2024), separate worker.js files are no longer generated
and the worker is embedded in the main JS file.

The motivation for this change is to inform users about the new behavior
of Emscripten and why the `worker.js` file may not be present.

Refs: https://github.com/ggml-org/whisper.cpp/issues/3123
---

diff --git a/examples/bench.wasm/README.md b/examples/bench.wasm/README.md
index 2b7a95d3..726d4d08 100644
--- a/examples/bench.wasm/README.md
+++ b/examples/bench.wasm/README.md
@@ -28,5 +28,10 @@ to the server's HTTP path:
 ```
 # copy the produced page to your HTTP path
 cp bin/bench.wasm/*       /path/to/html/
+cp bin/libbench.js        /path/to/html/
 cp bin/libbench.worker.js /path/to/html/
 ```
+
+> 📝 **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no
+> longer generated and the worker is embedded in the main JS file. So the worker
+> file will not be geneated for versions later than `3.1.58`.
diff --git a/examples/command.wasm/README.md b/examples/command.wasm/README.md
index 3e55dd0d..78d8776f 100644
--- a/examples/command.wasm/README.md
+++ b/examples/command.wasm/README.md
@@ -28,5 +28,10 @@ To run the example in a different server, you need to copy the following files
 to the server's HTTP path:
 ```
 cp bin/command.wasm/*       /path/to/html/
+cp bin/libcommand.js        /path/to/html/
 cp bin/libcommand.worker.js /path/to/html/
 ```
+
+> 📝 **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no
+> longer generated and the worker is embedded in the main JS file. So the worker
+> file will not be geneated for versions later than `3.1.58`.
diff --git a/examples/stream.wasm/README.md b/examples/stream.wasm/README.md
index 26912c49..f3c0c3d7 100644
--- a/examples/stream.wasm/README.md
+++ b/examples/stream.wasm/README.md
@@ -26,5 +26,10 @@ to the server's HTTP path:
 ```
 # copy the produced page to your HTTP path
 cp bin/stream.wasm/*       /path/to/html/
+cp bin/libstream.js        /path/to/html/
 cp bin/libstream.worker.js /path/to/html/
 ```
+
+> 📝 **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no
+> longer generated and the worker is embedded in the main JS file. So the worker
+> file will not be geneated for versions later than `3.1.58`.
diff --git a/examples/whisper.wasm/README.md b/examples/whisper.wasm/README.md
index 1309cf36..f1bb7cad 100644
--- a/examples/whisper.wasm/README.md
+++ b/examples/whisper.wasm/README.md
@@ -48,5 +48,10 @@ to the server's HTTP path:
 ```
 # copy the produced page to your HTTP path
 cp bin/whisper.wasm/*    /path/to/html/
+cp bin/libmain.js        /path/to/html/
 cp bin/libmain.worker.js /path/to/html/
 ```
+
+> 📝 **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no
+> longer generated and the worker is embedded in the main JS file. So the worker
+> file will not be geneated for versions later than `3.1.58`.