openvmm command line doc improvements
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- Rust
- Stars
- 1.9k
- Forks
- 238
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 100
Description
Main issue for tracking openvmm CLI --help improvements:
- Get rid of the escaped
\<text, which are caused by clap not parsing markdown but rustdoc requiring valid markdown. - Reduce duplication between related options (e.g., --com1, --com2)
- Add useful error output when a complex option fails to parse (e.g., print a summary of serial options when an invalid
--com1 foooption is passed). - Consider having some way to explicitly get the extended help for serial ports, disks, etc. As we add more backends for these, and as the backend list becomes dynamic, this will be increasingly useful.
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 with the openvmm CLI --help output and the clap definitions for --com1, --com2, serial ports, and disks. Reproduce the escaped text and invalid --com1 foo behavior, then review how extended help and dynamic backend lists are represented. Done means each checklist item has corresponding help or error-output changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100