Document the JSPI extension too #15
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kayceesrk
reviewed
Dec 2, 2023
| One can enable the CPS transformation from `js_of_ocaml` by passing the | ||
| `--enable=effects` flag. Without the flag `wasm_of_ocaml` will instead emit code | ||
| utilizing | ||
| - [the JavaScript-Promise Integration extension](https://github.com/WebAssembly/js-promise-integration/blob/main/proposals/js-promise-integration/Overview.md) |
There was a problem hiding this comment.
It feels like we can name things better here. I understand reading this comment that effects are enabled by default and the choice here is whether to use jspi or cps. So --enable=effects option feels like a misnomer. Would it be better to change the behaviour such that there are two options --enable=effects_cps and --enable=effects_jspi with --enable=effects_jspi being the default behaviour?
There was a problem hiding this comment.
For now, I have just reused the flag that enables the CPS transformation in Js_of_ocaml.
But indeed, we should use a better name at some point. Probably even have a specific flag: --effects=cps/jspi/double-translation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The little PR documents the current 'effect handler' setup, including the JSPI extension.