cli: Add documentation for the --fuel option (#3893)

This commit is contained in:
Nick Fitzgerald
2022-03-09 13:57:16 -08:00
committed by GitHub
parent 6b4e84f2e3
commit ae4d86804d

View File

@@ -234,7 +234,14 @@ struct CommonOptions {
#[structopt(long)] #[structopt(long)]
enable_cranelift_nan_canonicalization: bool, enable_cranelift_nan_canonicalization: bool,
#[structopt(long)] /// Enable execution fuel with N units fuel, where execution will trap after
/// running out of fuel.
///
/// Most WebAssembly instructions consume 1 unit of fuel. Some instructions,
/// such as `nop`, `drop`, `block`, and `loop`, consume 0 units, as any
/// execution cost associated with them involves other instructions which do
/// consume fuel.
#[structopt(long, value_name = "N")]
fuel: Option<u64>, fuel: Option<u64>,
/// Executing wasm code will yield when a global epoch counter /// Executing wasm code will yield when a global epoch counter