Skip to content

Commit

Permalink
add to wasm-tools validate docs (#1090)
Browse files Browse the repository at this point in the history
+ Adds where to find available wasm feature options
+ Adds how to see more verbose output in case folks
want to see more details of what is being validated

Signed-off-by: Michelle Dhanani <michelle@fermyon.com>
  • Loading branch information
michelleN authored Jun 28, 2023
1 parent 36c4eb8 commit e18dc3d
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/bin/wasm-tools/validate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ use wasmparser::{FuncValidatorAllocations, Parser, ValidPayload, Validator, Wasm
/// # Validate `foo.wasm` with the default Wasm feature proposals.
/// $ wasm-tools validate foo.wasm
///
/// # Validate `foo.wasm` with more verbose output
/// $ wasm-tools validate -vv foo.wasm
///
/// # Validate `fancy.wasm` with all Wasm feature proposals enabled.
/// $ wasm-tools validate --features all fancy.wasm
///
Expand All @@ -30,6 +33,9 @@ pub struct Opts {
/// The placeholder "all" can be used to enable all wasm features. If a "-"
/// character is present in front of a feature it will disable that feature.
/// For example "all,-simd" would enable everything but simd.
///
/// Available feature options can be found in the wasmparser crate:
/// https://github.com/bytecodealliance/wasm-tools/blob/main/crates/wasmparser/src/validator.rs
#[clap(long, short = 'f', value_parser = parse_features)]
features: Option<WasmFeatures>,

Expand Down

0 comments on commit e18dc3d

Please sign in to comment.