openvmm_entry: --help needs to be fixed in order to dynamically generate output text and keep the output in sync with the actual supported types
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.9k
- Forks
- 238
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 100
Description
The current help text for CLI arguments (--disk) is hardcoded in cli_args.rs, which can easily get out of sync with the actual argument parsing logic. For example, running cargo run -- --help and searching for "delay" yields no results, even though it's a valid disk type.
This issue proposes:
Investigating ways to dynamically generate the help text from the actual DiskCliKind enum so that the help text stays in sync with future changes.
One possible option to investigate is using macros or other compile-time mechanisms to ensure the help text stays in sync.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in openvmm/openvmm_entry/src/cli_args.rs at the hardcoded --disk help text, then inspect the DiskCliKind enum and argument parsing logic. Run cargo run -- --help and check that the generated help lists every supported disk type, including delay, and stays synchronized with the enum.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100