Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Documentation: Wrong doc about Config::wasm_component_model #9694

Closed
ifsheldon opened this issue Nov 29, 2024 · 0 comments · Fixed by #9705
Closed

Documentation: Wrong doc about Config::wasm_component_model #9694

ifsheldon opened this issue Nov 29, 2024 · 0 comments · Fixed by #9705

Comments

@ifsheldon
Copy link
Contributor

wasmtime/crates/wasmtime/src/config.rs

Line 998 in 6691006

/// This is `false` by default.

Here, the documented default is wrong, because the default features of wasmtime include component-model

wasmtime/crates/wasmtime/Cargo.toml

Line 137 in 6691006

'component-model',

and the enabled features is determined at compile time by

wasmtime/crates/wasmtime/src/config.rs

Line 1999 in 6691006

features.set(

The documentation should be something like

This is `cfg!(feature = "component-model")` by default.
alexcrichton added a commit to alexcrichton/wasmtime that referenced this issue Dec 2, 2024
@alexcrichton
Update some Config defaults documentation
e6b47aa 
Indicate that the defaults are based on compilation and target settings
and document a few interactions on wasm proposals.

Closes bytecodealliance#9694
@alexcrichton alexcrichton mentioned this issue Dec 2, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue Dec 2, 2024
@alexcrichton @pchickey
Update some Config defaults documentation (#9705)
4761930 
* Update some `Config` defaults documentation

Indicate that the defaults are based on compilation and target settings
and document a few interactions on wasm proposals.

Closes #9694

* Apply suggestions from code review

Co-authored-by: Pat Hickey <[email protected]>

---------

Co-authored-by: Pat Hickey <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update some Config defaults documentation alexcrichton/wasmtime
1 participant
@ifsheldon