From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:56150) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XXTrc-0007Fn-Tz for qemu-devel@nongnu.org; Fri, 26 Sep 2014 07:39:10 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XXTrW-0007dY-Ks for qemu-devel@nongnu.org; Fri, 26 Sep 2014 07:39:04 -0400 Received: from mail-wi0-x232.google.com ([2a00:1450:400c:c05::232]:48174) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XXTrW-0007d9-AO for qemu-devel@nongnu.org; Fri, 26 Sep 2014 07:38:58 -0400 Received: by mail-wi0-f178.google.com with SMTP id z2so11329002wiv.5 for ; Fri, 26 Sep 2014 04:38:52 -0700 (PDT) Sender: Paolo Bonzini Message-ID: <54255048.3030804@redhat.com> Date: Fri, 26 Sep 2014 13:38:48 +0200 From: Paolo Bonzini MIME-Version: 1.0 References: <1411610662-9720-1-git-send-email-arei.gonglei@huawei.com> <1411610662-9720-7-git-send-email-arei.gonglei@huawei.com> In-Reply-To: <1411610662-9720-7-git-send-email-arei.gonglei@huawei.com> Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: 7bit Subject: Re: [Qemu-devel] [PATCH v2 6/7] qmp: print descriptions of object properties List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: arei.gonglei@huawei.com, qemu-devel@nongnu.org Cc: weidong.huang@huawei.com, stefanha@redhat.com, mst@redhat.com, luonengjun@huawei.com, peter.huangpeng@huawei.com, armbru@redhat.com, aliguori@amazon.com, lcapitulino@redhat.com, afaerber@suse.de Il 25/09/2014 04:04, arei.gonglei@huawei.com ha scritto: > From: Gonglei > > The descriptions can serve as documentation in the code, > and they can be used to provide better help. For example: > > $./qemu-system-x86_64 -device virtio-blk-pci,? > > Before this patch: > > virtio-blk-pci.iothread=link > 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-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: > > virtio-blk-pci.iothread=link > 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-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 (Slot and function number, example: 06.0) > 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 > > Cc: Paolo Bonzini > Cc: Michael S. Tsirkin > Cc: Markus Armbruster > Signed-off-by: Gonglei > --- > qmp.c | 19 +++++++++++++++---- > 1 file changed, 15 insertions(+), 4 deletions(-) > > diff --git a/qmp.c b/qmp.c > index c6767c4..20f501b 100644 > --- a/qmp.c > +++ b/qmp.c > @@ -442,7 +442,8 @@ ObjectTypeInfoList *qmp_qom_list_types(bool has_implements, > */ > static DevicePropertyInfo *make_device_property_info(ObjectClass *klass, > const char *name, > - const char *default_type) > + const char *default_type, > + const char *description) > { > DevicePropertyInfo *info; > Property *prop; > @@ -465,7 +466,12 @@ static DevicePropertyInfo *make_device_property_info(ObjectClass *klass, > > info = g_malloc0(sizeof(*info)); > info->name = g_strdup(prop->name); > - info->type = g_strdup(prop->info->legacy_name ?: prop->info->name); > + if (prop->info->description) { > + info->type = g_strdup_printf("%s (%s)", prop->info->name, > + prop->info->description); > + } else { > + info->type = g_strdup(prop->info->name); > + } > return info; > } > klass = object_class_get_parent(klass); > @@ -474,7 +480,11 @@ static DevicePropertyInfo *make_device_property_info(ObjectClass *klass, > /* Not a qdev property, use the default type */ > info = g_malloc0(sizeof(*info)); > info->name = g_strdup(name); > - info->type = g_strdup(default_type); > + if (description) { > + info->type = g_strdup_printf("%s (%s)", default_type, description); Please add a new "description" field to DevicePropertyInfo, and format it in qdev_device_help. You can send v3 of just this patch. Thanks, Paolo > + } else { > + info->type = g_strdup(default_type); > + } > return info; > } > > @@ -521,7 +531,8 @@ DevicePropertyInfoList *qmp_device_list_properties(const char *typename, > continue; > } > > - info = make_device_property_info(klass, prop->name, prop->type); > + info = make_device_property_info(klass, prop->name, prop->type, > + prop->description); > if (!info) { > continue; > } >