Re: [Qemu-devel] qdev device documentation (Re: [PATCH 0/2] usb-linux: physical port handling.)

[Anthony Liguori]

On 05/12/2011 02:32 PM, Alon Levy wrote:
> We could have a (just picking up the Spice example) spice-docs file
> that was checked in and updated periodically by generation by the maintainer.
> It's error prone, you could still update the source but forget to checkin the 
> spice-docs
> and get an old version, but at least it would still be auto-generated, and it 
> would
> not prevent the docs builder from working.

It's not just Spice though.  There are still a number of devices that 
only get built with certain targets.

Doing it right is actually fairly complicated.  It's far easier to use a 
central doc file, and then add mechanisms to ensure things don't get out 
of sync.

Regards,

Anthony Liguori

> > -- PMM