Skip to content

docs: document --disable-memory64 in the CLI pages - #321

Merged
hydai merged 1 commit into
WasmEdge:mainfrom
NopeCharon:docs/cli-memory64-option
Nov 2, 2026
Merged

hydai merged 1 commit into
WasmEdge:mainfrom
NopeCharon:docs/cli-memory64-option

Conversation

@NopeCharon

Copy link
Copy Markdown
Contributor

Explanation

This fixes the CLI reference pages. All wasmedge subcommands accept --disable-memory64, but the option lists for wasmedge, wasmedge parse, wasmedge validate and wasmedge instantiate do not mention it. The parse, validate and instantiate pages also still call Memory64 "currently not implemented", although it has been implemented and on by default since 0.17.0.

Related issue

Closes #319

What type of PR is this

/kind documentation

Proposed Changes

  • parse.md, validate.md, instantiate.md: drop "(currently not implemented)" from the Memory64 item under --wasm-3.
  • cli.md, parse.md, validate.md, instantiate.md: add --disable-memory64 after --disable-exception-handling. This follows the order in include/driver/options.h and the existing entry on aot.md.

Validation with the WasmEdge 0.18.1 release (Linux aarch64), using a module that declares (memory i64 1):

Command Default With --disable-memory64
wasmedge --reactor m64.wasm load prints 42 loading failed: integer too large
wasmedge run --reactor m64.wasm load prints 42 loading failed: integer too large
wasmedge parse m64.wasm exit 0 loading failed: integer too large
wasmedge validate m64.wasm exit 0 loading failed: integer too large
wasmedge instantiate m64.wasm exit 0 loading failed: integer too large

npm run build completes for all locales with no warnings.

The option lists for `wasmedge`, `wasmedge parse`, `wasmedge validate`
and `wasmedge instantiate` covered every `--disable-*` proposal flag
except `--disable-memory64`, although all of these commands accept it
(registered in include/driver/options.h and shown by `--help`). The
parse, validate and instantiate pages also still described Memory64 as
"currently not implemented", even though it has been implemented and
enabled by default since 0.17.0, as the proposals page states.

Drop the stale note and add the `--disable-memory64` item after
`--disable-exception-handling` on the four pages. This matches the
order in options.h and the existing entry on the `wasmedge compile`
page.

Checked with WasmEdge 0.18.1: a module with an i64 memory runs and
parses, validates and instantiates by default, and every one of these
commands rejects it once `--disable-memory64` is passed.

Fixes WasmEdge#319

Signed-off-by: NopeCharon <115794254+NopeCharon@users.noreply.github.com>
@hydai
hydai merged commit 4536aab into WasmEdge:main Nov 2, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] CLI pages miss --disable-memory64 and still call Memory64 unimplemented

2 participants