Skip to content

docs(man): add four flags missing from bats(1) OPTIONS#1201

Open
truffle-dev wants to merge 1 commit intobats-core:masterfrom
truffle-dev:docs/man-add-missing-flags
Open

docs(man): add four flags missing from bats(1) OPTIONS#1201
truffle-dev wants to merge 1 commit intobats-core:masterfrom
truffle-dev:docs/man-add-missing-flags

Conversation

@truffle-dev
Copy link
Copy Markdown


The bats(1) man page is missing OPTIONS entries for four flags that exist in bats --help and have working implementations in libexec/bats-core/bats:

flag added in
--abort 2025-10-12 (commit 2153e6a)
--errexit 2025-07-26 (commit 185f268)
--negative-filter 2025-07-16 (commit 9e6627e, #1114)
--parallel-binary-name 2023-05-28 (commit 2c31eb3)

bats.1.ronn was last touched in November 2022, before any of these landed, so the gap accumulated quietly.

The descriptions added here mirror the wording of bats --help so the two stay in sync. To verify the gap is closed:

diff <(bin/bats --help | grep -oE '(^|[^-])--?[a-z][a-z-]*' | tr -d ' ' | sort -u) \
     <(grep -oE '`--[a-z-]+`' man/bats.1.ronn | tr -d '`' | sort -u)

Only bats.1.ronn is touched in this PR. bats.1 was not regenerated because the Ronn-NG version available locally would have introduced unrelated header noise. Happy to regen with whichever toolchain version a maintainer prefers.

The bats(1) man page is missing OPTIONS entries for four flags
that exist in `bats --help` and have working implementations in
`libexec/bats-core/bats`:

  * `--abort`                  (added 2025-10-12, commit 2153e6a)
  * `--errexit`                (added 2025-07-26, commit 185f268)
  * `--negative-filter`        (added 2025-07-16, commit 9e6627e, bats-core#1114)
  * `--parallel-binary-name`   (added 2023-05-28, commit 2c31eb3)

`bats.1.ronn` was last touched in November 2022, before any of
these landed. The descriptions added here mirror the wording of
`bats --help` so the two stay in sync.

Verified with `comm -23` of help-flags vs man-flags before and
after; the gap is now empty in both directions.

Only `bats.1.ronn` is touched. `bats.1` was not regenerated
because the toolchain version available locally would have
introduced unrelated header noise; happy to regen with a specific
Ronn-NG version if a maintainer prefers.
@truffle-dev truffle-dev requested a review from a team as a code owner April 20, 2026 06:09
truffle-dev added a commit to truffle-dev/contributions that referenced this pull request Apr 20, 2026
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.

1 participant