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

[Anthony Liguori]

On 05/12/2011 10:56 AM, Markus Armbruster wrote:
> Gerd Hoffmann<address@hidden>  writes:
>
> >    Hi,
> >
> > > > What is the status of the qdev documentation patches btw.?
> > >
> > > http://lists.gnu.org/archive/html/qemu-devel/2011-02/msg02169.html
> >
> > What is the problem with the empty strings btw?
>
> Anthony ;)

1) It doesn't help us get good written documentation without 
non-existent magic to extract a qdev schema.

2) It makes the documentation hidden in random places in the tree making 
it hard to audit what is undocumented.

3) It guarantees that documentation will vary drastically in language 
and quality.

4) I greatly fear that we're embarking down yet another "introduce a new 
API that never gets fully converted" path.

I've sent a quick patch out with what I think is a significantly better 
approach.

Regards,

Anthony Liguori

> [...]