Skip to content

docs(project-overview): the documented benchmark commands are unknown options #1227

Closed

Description

@Chemaclass

Problem

docs/project-overview.md "Running tests" tells a new contributor to run:

./bashunit -s -b tests           # Benchmark tests
./bashunit --simple --bench tests # Benchmark tests

Both are rejected:

$ ./bashunit -s -b .
Error: unknown option '-b'. Run 'bashunit test --help' to list the available options.

$ ./bashunit --simple --bench .
Error: unknown option '--bench'. Run 'bashunit test --help' to list the available options.

git log -S '"--bench"' -- src/ finds nothing, so this was never a flag. Benchmarks are a subcommand: bashunit bench [path], which --help advertises. bashunit bench --simple . and bashunit bench -s . both work and preserve what the doc was trying to show.

The neighbouring test commands (-s -p, --simple --parallel) are correct, which makes the broken pair easy to miss — they sit in the same code-group, two lines apart.

This is the page that orients new contributors, so the first benchmark command they copy fails.

Suggested fix

Use the subcommand form in both the Quick and Complete tabs.

Verified correct in the same guide

Everything else was executed and holds:

  • all six claimed top-level directories exist
  • src/ has no loose files, and every module directory has an index.sh
  • the module table matches disk exactly — 16 documented, all present; the only extra is dev, which the prose calls out separately
  • every index.sh contains nothing but source lines, comments and blanks
  • dev really is excluded from the built binary: bashunit::dump and bashunit::dd appear zero times in bin/bashunit (the "debug" matches there are all extdebug)
  • the released binary is a single file with zero source lines
  • -s -p and --simple --parallel both work
  • ADR-011 and .github/CONTRIBUTING.md both exist, and docs/package.json defines the dev and build scripts the page tells contributors to run

Activity

  1. self-assigned this
    on Aug 14, 2026
  2. Chemaclass commented on Aug 14, 2026

    @Chemaclass
    MemberAuthor

    Done in #1228 (merged).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions