-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove static/dynamic memories from public docs #9545
Remove static/dynamic memories from public docs #9545
Conversation
Subscribe to Label Actioncc @fitzgen
This issue or pull request has been labeled: "fuzzing", "wasmtime:api", "wasmtime:c-api", "wasmtime:config"
Thus the following users have been cc'd because of the following labels:
To subscribe or unsubscribe from this label, edit the |
Label Messager: wasmtime:configIt looks like you are changing Wasmtime's configuration options. Make sure to
To modify this label's message, edit the To add new label messages or remove existing label messages, edit the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Some bike shedding inline below, interested in what you think.
This commit removes the terminology of "static" and "dynamic" memories from the public-facing documentation of Wasmtime, notably on the `Config` structure and its various configuration settings. The goal of this commit is in the same vein as bytecodealliance#9543 which is to simplify the memory settings of Wasmtime for users in this case. This change doesn't actually have any code changes beyond renames (and handling now-deprecated CLI options). The goal of this commit is to basically rewrite how we document the effect of various settings of Wasmtime. Notably: * `Config::static_memory_maximum_size` is now `memory_reservation`. * `Config::static_memory_forced` is now `memory_reservation_is_maximum`. * `Config::dynamic_memory_reserved_for_growth` is now `memory_reservation_for_growth`. Documentation for all of these options has been rewritten and updated to take into account the removal of "dynamic" and "static" terminology. Additionally more words have been written about the various effects of each setting and how things related to wasm features such as index type sizes and custom page sizes. The rewritten documentation is intended to basically already match what Wasmtime does today. I believe that all of these settings are useful in one form or another so none have been dropped but the updated documentation is intended to help simplify the mental model for how they're processed internally and how they affect allocations and such.
64cfa53
to
6b21001
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nitpicks on docs wording below, but lgtm
Wasmtime release notes: https://github.com/bytecodealliance/wasmtime/releases/tag/v28.0.0 - Changed `LinearMemory` trait API, [code](bytecodealliance/wasmtime#9577) - Changed static/dynamic memory config, removed `static_memory_maximum_size` [code](bytecodealliance/wasmtime#9545) --------- Co-authored-by: Andriy Berestovskyy <[email protected]> Co-authored-by: IDX GitHub Automation <[email protected]>
Wasmtime release notes: https://github.com/bytecodealliance/wasmtime/releases/tag/v28.0.0 - Changed `LinearMemory` trait API, [code](bytecodealliance/wasmtime#9577) - Changed static/dynamic memory config, removed `static_memory_maximum_size` [code](bytecodealliance/wasmtime#9545) --------- Co-authored-by: Andriy Berestovskyy <[email protected]> Co-authored-by: IDX GitHub Automation <[email protected]>
This commit removes the terminology of "static" and "dynamic" memories from the public-facing documentation of Wasmtime, notably on the
Config
structure and its various configuration settings. The goal of this commit is in the same vein as #9543 which is to simplify the memory settings of Wasmtime for users in this case.This change doesn't actually have any code changes beyond renames (and handling now-deprecated CLI options). The goal of this commit is to basically rewrite how we document the effect of various settings of Wasmtime. Notably:
Config::static_memory_maximum_size
is nowmemory_reservation
.Config::static_memory_forced
is nowmemory_may_move
.Config::dynamic_memory_reserved_for_growth
is nowmemory_reservation_for_growth
.Documentation for all of these options has been rewritten and updated to take into account the removal of "dynamic" and "static" terminology. Additionally more words have been written about the various effects of each setting and how things related to wasm features such as index type sizes and custom page sizes.
The rewritten documentation is intended to basically already match what Wasmtime does today. I believe that all of these settings are useful in one form or another so none have been dropped but the updated documentation is intended to help simplify the mental model for how they're processed internally and how they affect allocations and such.