Re: [Qemu-devel] Should the "props" be documented for QMP `object-add`?

[Kashyap Chamarthy]

On Wed, Jan 09, 2019 at 11:02:08AM +0000, Daniel P. Berrangé wrote:
> On Wed, Jan 09, 2019 at 09:51:13AM +0100, Kashyap Chamarthy wrote:

[...]

> > That said, in qapi/misc.json "@object-add" doesn't document any of the
> > "props".  Is it on purpose?  Maybe because it is a 1:1 mapping of the
> > command-line `-object` (which _is_ documented in qemu-doc.texi).
> > 
> > Is it a good idea to send a patch to document the "props" in
> > qapi/misc.json?  Or would it be needless duplication?
> 
> It is not practical at this time because object_add uses QOM object
> properties and these are exclusively defined in code, not QAPI schema.
> 
> There's a long term todo item to use QAPI schema to define QOM objects,
> which would then auto-generate the boilerplate QOM code, at which point
> it all becomes self-documenting. 

Didn't know about this; thanks for the background.  Then, I'll hold off
submitting any patch to qapi/misc.json.

> That's basically lacking dev resources to work on it though...

Noted.

[...]

-- 
/kashyap