WebAssembly / WebAssembly/binaryen

wrong documentation when using `scripts/fuzz_opt.py --help`

Open
#7,419 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
WebAssembly
Stars
8.6k
Forks
885
Avg merge
1d 19h
Merged PRs (30d)
69

Description

Hi,

When running the command below, the output is mentioning a check.py file and it seems wrong

$ scripts/fuzz_opt.py --help
usage: fuzz_opt.py [-h] [--torture] [--no-torture] [--abort-on-first-failure] [--no-abort-on-first-failure]
                   [--binaryen-bin BINARYEN_BIN] [--binaryen-lib BINARYEN_LIB] [--binaryen-root BINARYEN_ROOT]
                   [--out-dir OUT_DIR] [--valgrind VALGRIND] [--valgrind-full-leak-check] [--spec-test SPEC_TESTS]
                   [--list-suites] [--filter TEST_NAME_FILTER] [--no-auto-initial-contents]
                   [TEST_SUITE ...]

usage: 'python check.py [options]' Runs the Binaryen test suite.

positional arguments:
  TEST_SUITE            Names specific test suites to run. Use --list-suites to see a list of all test suites

options:
  -h, --help            show this help message and exit
  --torture             Chooses whether to run the torture testcases. Default: true.
  --no-torture          Disables running the torture testcases.
  --abort-on-first-failure
                        Specifies whether to halt test suite execution on first test error. Default: true.
  --no-abort-on-first-failure
                        If set, the whole test suite will run to completion independent of earlier errors.
  --binaryen-bin BINARYEN_BIN
                        Specifies the path to the Binaryen executables in the CMake build directory. Default: bin/ of current
                        directory (i.e. assume an in-tree build). If not specified, the environment variable BINARYEN_ROOT=
                        can also be used to adjust this.
  --binaryen-lib BINARYEN_LIB
                        Specifies a path to where the built Binaryen shared library resides at. Default: ./lib relative to
                        bin specified above.
  --binaryen-root BINARYEN_ROOT
                        Specifies a path to the root of the Binaryen repository tree. Default: the directory where this file
                        check.py resides.
  --out-dir OUT_DIR     Specifies a path to the output directory for temp files, which is also where the test runner changes
                        directory into. Default:. out/test under the binaryen root.
  --valgrind VALGRIND   Specifies a path to Valgrind tool, which will be used to validate execution if specified. (Pass
                        --valgrind=valgrind to search in PATH)
  --valgrind-full-leak-check
                        If specified, all unfreed (but still referenced) pointers at the end of execution are considered
                        memory leaks. Default: disabled.
  --spec-test SPEC_TESTS
                        Names specific spec tests to run.
  --list-suites         List the test suites that can be run.
  --filter TEST_NAME_FILTER
                        Specifies a filter. Only tests whose paths contains this substring will be run
  --no-auto-initial-contents
                        Select important initial contents automaticaly in fuzzer. Default: disabled.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Run scripts/fuzz_opt.py --help and inspect scripts/fuzz_opt.py alongside the referenced check.py help text. Update the stale usage description so it identifies fuzz_opt.py correctly, then rerun the command and verify the rest of the options remain unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, wasm
Domain
documentation, tooling
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.