Re: [Qemu-devel] [PATCH 0/7] add description field in ObjectProperty and PropertyInfo struct

[Gonglei (Arei)]

> From: Paolo Bonzini [mailto:address@hidden On Behalf Of Paolo
> Bonzini
> Sent: Wednesday, September 24, 2014 1:04 AM
> Subject: Re: [PATCH 0/7] add description field in ObjectProperty and
> PropertyInfo struct
> 
> Il 23/09/2014 15:08, address@hidden ha scritto:
> > From: Gonglei <address@hidden>
> >
> > PATCH 1 and PATCH 2 are bugfixes. PATCH 3~7 add a description
> > field in both ObjectProperty and PropertyInfo struct.
> > The descriptions can serve as documentation in the code,
> > and they can be used to provide better help. For example:
> >
> > Before this patch series:
> >
> > $./qemu-system-x86_64 -device virtio-blk-pci,?
> >
> > virtio-blk-pci.iothread=link<iothread>
> > virtio-blk-pci.x-data-plane=bool
> > virtio-blk-pci.scsi=bool
> > virtio-blk-pci.config-wce=bool
> > virtio-blk-pci.serial=str
> > virtio-blk-pci.secs=uint32
> > virtio-blk-pci.heads=uint32
> > virtio-blk-pci.cyls=uint32
> > virtio-blk-pci.discard_granularity=uint32
> > virtio-blk-pci.bootindex=int32
> > virtio-blk-pci.opt_io_size=uint32
> > virtio-blk-pci.min_io_size=uint16
> > virtio-blk-pci.physical_block_size=uint16
> > virtio-blk-pci.logical_block_size=uint16
> > virtio-blk-pci.drive=str
> > virtio-blk-pci.virtio-backend=child<virtio-blk-device>
> > virtio-blk-pci.command_serr_enable=on/off
> > virtio-blk-pci.multifunction=on/off
> > virtio-blk-pci.rombar=uint32
> > virtio-blk-pci.romfile=str
> > virtio-blk-pci.addr=pci-devfn
> > virtio-blk-pci.event_idx=on/off
> > virtio-blk-pci.indirect_desc=on/off
> > virtio-blk-pci.vectors=uint32
> > virtio-blk-pci.ioeventfd=on/off
> > virtio-blk-pci.class=uint32
> >
> > After:
> >
> > $./qemu-system-x86_64 -device virtio-blk-pci,?
> >
> > virtio-blk-pci.iothread=link<iothread>
> > virtio-blk-pci.x-data-plane=bool (on/off)
> > virtio-blk-pci.scsi=bool (on/off)
> > virtio-blk-pci.config-wce=bool (on/off)
> > virtio-blk-pci.serial=str
> > virtio-blk-pci.secs=uint32
> > virtio-blk-pci.heads=uint32
> > virtio-blk-pci.cyls=uint32
> > virtio-blk-pci.discard_granularity=uint32
> > virtio-blk-pci.bootindex=int32
> > virtio-blk-pci.opt_io_size=uint32
> > virtio-blk-pci.min_io_size=uint16
> > virtio-blk-pci.physical_block_size=uint16 (A power of two between 512 and
> 32768)
> > virtio-blk-pci.logical_block_size=uint16 (A power of two between 512 and
> 32768)
> > virtio-blk-pci.drive=str (ID of a drive to use as a backend)
> > virtio-blk-pci.virtio-backend=child<virtio-blk-device>
> > virtio-blk-pci.command_serr_enable=bool (on/off)
> > virtio-blk-pci.multifunction=bool (on/off)
> > virtio-blk-pci.rombar=uint32
> > virtio-blk-pci.romfile=str
> > virtio-blk-pci.addr=int32 (The slot number of a pci device)
> > virtio-blk-pci.event_idx=bool (on/off)
> > virtio-blk-pci.indirect_desc=bool (on/off)
> > virtio-blk-pci.vectors=uint32
> > virtio-blk-pci.ioeventfd=bool (on/off)
> > virtio-blk-pci.class=uint32
> >
> > Gonglei (7):
> >   qom: add error handler for object_property_print()
> >   qom: add error handler for object alias property
> >   qdev: add description field in PropertyInfo struct
> >   qom: add description field in ObjectProperty struct
> >   qdev: set the object property's description to the qdev property's.
> >   qmp: print descriptions of object properties
> >   qdev: drop legacy_name from qdev properties
> >
> >  hw/core/qdev-properties-system.c |  8 ++++----
> >  hw/core/qdev-properties.c        | 12 ++++++------
> >  hw/core/qdev.c                   |  3 +++
> >  include/hw/qdev-core.h           |  2 +-
> >  include/qom/object.h             | 15 +++++++++++++++
> >  qmp.c                            | 19 +++++++++++++++----
> >  qom/object.c                     | 33
> ++++++++++++++++++++++++++++++---
> >  target-ppc/translate_init.c      |  2 +-
> >  8 files changed, 75 insertions(+), 19 deletions(-)
> >
> 
> Just one comment on patch 5.  The description can be improved, I can do
> it tomorrow.
> 

Great! I'm looking forward to your reply. :)

Best regards,
-Gonglei

> Thanks!
> 
> Paolo