Closed alexcrichton closed 3 weeks ago
cc @fitzgen
.github/subscribe-to-label.json
configuration file.
[Learn more.](https://github.com/bytecodealliance/subscribe-to-label-action)
It looks like you are changing Wasmtime's configuration options. Make sure to complete this check list:
[ ] If you added a new Config
method, you wrote extensive documentation for
it.
[ ] If you added a new Config
method, or modified an existing one, you
ensured that this configuration is exercised by the fuzz targets.
[ ] If you are enabling a configuration option by default, make sure that it has been fuzzed for at least two weeks before turning it on by default.
.github/label-messager/wasmtime-config.md
file.
To add new label messages or remove existing label messages, edit the
.github/label-messager.json
configuration file.
[Learn more.](https://github.com/bytecodealliance/label-messager-action)
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.