incus icon indicating copy to clipboard operation
incus copied to clipboard

Port `pci` device documentation to `gendoc`

Open stgraber opened this issue 1 year ago • 3 comments

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 https://github.com/lxc/incus/pull/847 for an example.

stgraber avatar Mar 17 '25 20:03 stgraber

Hello, @pgupta2005 and I are University students at the University of Texas at Austin, we would like to take on this issue as part of our Virtualization class with Professor Vijay Chidambaram

DinglyCoder avatar Apr 22 '25 19:04 DinglyCoder

Hello, we are excited to resolve the issue!

parthgupta2005 avatar Apr 22 '25 19:04 parthgupta2005

Assigned the two of you, thanks!

stgraber avatar Apr 22 '25 20:04 stgraber