Repository navigation
docs(testing): list untried optional-group combinations as a scanner gap - #727
Merged
Merged
Conversation
The advised-command scanner tries each separate optional synopsis group on its own, never two together, so a command that only fails when flags from two such groups are combined is not caught. Say so in its Known gaps list. Signed-off-by: Roman Inflianskas <Roman.Inflianskas@amd.com>
tomastola
approved these changes
Oct 26, 2026
tomastola
left a comment
tomastola
left a comment
Collaborator
There was a problem hiding this comment.
The new bullet matches the scanner's behaviour: command_variants adds at most one optional group per variant, so side-by-side groups are never combined.
- Saying separate optional groups is what makes the bullet accurate:
synopsis_itemsalready expands a nested group ([--restart-services [--yes]]) into each prefix, so only side-by-side groups are never combined. - The example shows the gap is deliberate:
--demois declaredconflicts_with = "replay"(apps/rocm/src/main.rs:644), so trying every combination would report false failures. The wording also matches the doc comment oncommand_variants.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #535, from the non-blocking note in @juhovainio's approving review: the advised-command variant generator toggles one optional flag group at a time, so a bug that shows only when two optional flags are combined is not caught.
This adds that limitation to the scanner's "Known gaps" list in
docs/testing.md. The wording says separate groups, because a nested group such as[--restart-services [--yes]]is already tried with its inner part. The examplerocm dash [--demo] [--replay <file>]is the onecommand_variantsgives for why the groups are tried separately: those two flags conflict.This is docs only, so no scenario is needed.
docs/testing.mdis among the files the scanner reads, so I re-ran its tests on this change.Verified locally:
fmt
advised_commandstests: 20 passxtasktests: 317 passboth clippy invocations on Linux
Not a bug fix; no xfail rows apply.
No new subcommand or subsystem.
No user-facing message changed.