On 04/24/2013 01:39 PM, Eric Blake wrote: > On 04/24/2013 12:20 PM, Luiz Capitulino wrote: >> On Thu, 25 Apr 2013 01:33:24 +0800 >> Amos Kong <ak...@redhat.com> wrote: >> >>> Libvirt has no way to probe if an option or property is supported, >>> This patch introdues a new qmp command to query configuration schema >>> information. hmp command isn't added because it's not needed. >>> >>> +## >>> +# @ConfigParamType: >>> +# >>> +# JSON representation of values of QEMUOptionParType, may grow in future > > I see why you used this text (it's straight copy-and-paste from my email > suggestion); but it's rather geared towards someone that cares about the > internals of qemu. On the other hand, qapi-schema is the public > interface that should tell you how to interact with qemu without having > to open include/qemu/option.h or even know about the C type > QEMUOptionParType in the first place. Also, we've never mentioned that > enums are subject to future growth elsewhere - it's kind of implicit. I > think the following would be better text (and sorry for leading you in > the wrong direction; in my mail, I was trying to justify WHY I suggested > the type, not HOW it should be documented).
That said, while the public document need not refer to the C api, you SHOULD patch include/qemu/option.h to document that any additions to the C API should be reflected back into the public QMP type name. -- Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
signature.asc
Description: OpenPGP digital signature
