Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

openvmm command line doc improvements #286

Open
4 tasks
jstarks opened this issue Nov 9, 2024 · 0 comments
Open
4 tasks

openvmm command line doc improvements #286

jstarks opened this issue Nov 9, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jstarks
Copy link
Member

jstarks commented Nov 9, 2024

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 foo option 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.
@smalis-msft smalis-msft added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants