Update documentation on -sEXIT_RUNTIME. #25218
Open
Conversation
This file contains hidden or 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
sbc100
reviewed
Sep 8, 2025
| If 1, then completing main() will by default call exit(), unless a refcount | ||
| keeps the runtime alive. Call emscripten_exit_with_live_runtime() to finish | ||
| main() while keeping the runtime alive. Calling exit() will shut down the | ||
| runtime, invoking atexit()s, and flushing stdio streams. |
There was a problem hiding this comment.
Actually, I think calling exit() won't do this while the refcount is non-zero.
If you want to override the refcount you would need to call emscripten_force_exit().
Also, maybe mention emscripten_runtime_keepalive_push() alongside emscripten_exit_with_live_runtime() which is basically the same thing but without the unwind.
There was a problem hiding this comment.
We do have docs for emscripten_force_exit and emscripten_exit_with_live_runtime so maybe just say something like See docs for ... rather than duplicating?
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.
Closes #25217
Update documentation to reflect the current state of affairs for the meaning of
-sEXIT_RUNTIME.