Update Documentation for Emscripten Builds #1621
Conversation
* update emsdk version information * link to `Tools/wasm/README.md` for usage instructions beyond what's shown here * add note about ccache * add note about minimum Python version for `Tools/wasm/emscripten build`
getting-started/setup-building.rst
Outdated
| CPython you're building: | ||
|
|
||
| * For building CPython 3.14, use ``emsdk`` version ``4.0.11``. | ||
| * For building CPython 3.13, use ``emsdk`` version ``4.0.5``. |
There was a problem hiding this comment.
I know this isn't correct... but I don't know what is correct. I'm fairly certian it's 3.something...
However, it might be better to leave this line off entirely. Emscripten isn't Tier 3 for 3.13. Having specific build instructions implies (to me) that it should work, and that definitely won't be the case.
There was a problem hiding this comment.
That sounds good to me; sorry for the error! Makes sense only to include it for 3.14+.
| It is possible (but not necessary) to enable ``ccache`` for Emscripten builds | ||
| by setting the ``EM_COMPILER_WRAPPER`` environment, but this step will only | ||
| take effect if it is done **after** ``emsdk_env.sh`` is sourced (otherwise, the | ||
| sourced script removes the environment variable): |
There was a problem hiding this comment.
@hoodmane This was the historical guidance for ccache... is it still required now that the --config-cache option is part of the emscripten build script?
There was a problem hiding this comment.
Yes, compilation cache and configure cache are different things.
|
I'll review this tomorrow. Thanks @adqm ! |
There was a problem hiding this comment.
I'll leave it to @hoodmane to provide final confirmation that this is all correct (including the EM_COMPILER_WRAPPER thing); but otherwise, I'm happy with this.
There was a problem hiding this comment.
Two minor updates following Hugo's agreement to allow bumping the EMSDK version for RC2.
@hoodmane - are you able to confirm the last details so we can merge this?
Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
| ``Tools/wasm/emscripten build`` command (which should be run with a recent | ||
| version of Python you have installed on your machine): | ||
| ``Tools/wasm/emscripten build`` command, which should be run with a recent | ||
| version of Python (3.13 or newer) already installed on your machine: |
There was a problem hiding this comment.
I've been running it with 3.12 but it's harmless to say 3.13 here.
This patch includes some updates to the instructions for building for Emscripten, based on discussion from python/cpython#137312 and python/cpython#137025, with the goal of reducing duplicated information between the dev guide and
Tools/wasm/README.mdin the CPython repo.Specifically, this patch makes the following changes:
updates emsdk version information
links to
Tools/wasm/README.mdfor usage instructions beyond what's shown hereadds a note about ccache
adds a note about minimum Python version required for
Tools/wasm/emscripten build📚 Documentation preview 📚: https://cpython-devguide--1621.org.readthedocs.build/