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.

Sign up for GitHub

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

Jump to bottom

Port pci device documentation to gendoc #1789

Open
stgraber opened this issue Mar 17, 2025 · 0 comments
Open

Port pci device documentation to gendoc #1789

stgraber opened this issue Mar 17, 2025 · 0 comments
Labels
Easy Good for new contributors
Milestone
soon

Comments

@stgraber
Copy link
Member

The PCI device documentation (doc/reference/devices_pci.md) currently uses a static table of valid options. This should be moved to an auto-generated table using gendoc.

This is typically done in two steps:

  1. Add the required gendoc comments where the configuration options are defined (usually alongside their validator)
  2. Generate the new config metadata (make update-metadata)
  3. Update the documentation to use the generated metadata

See #847 for an example.
@stgraber stgraber added the Easy Good for new contributors label Mar 17, 2025
@stgraber stgraber added this to the soon milestone Mar 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Easy Good for new contributors
Milestone
soon
Development

No branches or pull requests
1 participant
@stgraber