Skip to content

Commit

Permalink
Add some more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alexcrichton committed Nov 16, 2024
1 parent 9d06e35 commit bb8fa84
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
7 changes: 7 additions & 0 deletions crates/wasmtime/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,13 @@ std = [
'wasmtime-environ/std',
'object/std',
'once_cell',
# technically this isn't necessary but once you have the standard library you
# probably want things to go fast in which case you've probably got signal
# handlers and such so implicitly enable this. This also helps reduce the
# verbosity of others depending on `wasmtime` with `default-features = false`
# where frequently `std` is enabled and this feature will typically want to be
# enabled by default as well.
'signals-based-traps',
]

# Enables support for the `Store::call_hook` API which enables injecting custom
Expand Down
6 changes: 6 additions & 0 deletions crates/wasmtime/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,12 @@
//! with the same overhead as the `call-hook` feature where entries/exits into
//! WebAssembly will have more overhead than before.
//!
//! * `signals-based-traps` - Enabled by default, this enables support for using
//! host signal handlers to implement WebAssembly traps. For example virtual
//! memory is used to catch out-of-bounds accesses in WebAssembly that result
//! in segfaults. This is implicitly enabled by the `std` feature and is the
//! best way to get high-performance WebAssembly.
//!
//! More crate features can be found in the [manifest] of Wasmtime itself for
//! seeing what can be enabled and disabled.
//!
Expand Down

0 comments on commit bb8fa84

Please sign in to comment.