From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:50937) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1c3mUf-0005W3-79 for qemu-devel@nongnu.org; Mon, 07 Nov 2016 11:09:58 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1c3mUa-0004JJ-N2 for qemu-devel@nongnu.org; Mon, 07 Nov 2016 11:09:57 -0500 Received: from mx1.redhat.com ([209.132.183.28]:47956) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1c3mUa-0004H9-Er for qemu-devel@nongnu.org; Mon, 07 Nov 2016 11:09:52 -0500 Date: Mon, 7 Nov 2016 16:09:48 +0000 From: "Daniel P. Berrange" Message-ID: <20161107160948.GA19422@redhat.com> Reply-To: "Daniel P. Berrange" References: <20161020112829.14589-1-lma@suse.com> <20161020112829.14589-5-lma@suse.com> <87eg2suygy.fsf@dusky.pond.sub.org> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline In-Reply-To: <87eg2suygy.fsf@dusky.pond.sub.org> Subject: Re: [Qemu-devel] [PATCH v4 4/5] backends: add description for enum class properties List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Markus Armbruster Cc: Lin Ma , pbonzini@redhat.com, qemu-devel@nongnu.org, afaerber@suse.de On Thu, Nov 03, 2016 at 08:58:53PM +0100, Markus Armbruster wrote: > Lin Ma writes: > > > Signed-off-by: Lin Ma > > --- > > backends/hostmem.c | 4 ++++ > > crypto/secret.c | 4 ++++ > > crypto/tlscreds.c | 4 ++++ > > net/filter.c | 4 ++++ > > 4 files changed, 16 insertions(+) > > > > diff --git a/backends/hostmem.c b/backends/hostmem.c > > index 4256d24..25f303d 100644 > > --- a/backends/hostmem.c > > +++ b/backends/hostmem.c > > @@ -377,6 +377,10 @@ host_memory_backend_class_init(ObjectClass *oc, void *data) > > HostMemPolicy_lookup, > > host_memory_backend_get_policy, > > host_memory_backend_set_policy, &error_abort); > > + object_class_property_set_description(oc, "policy", > > + "Data format: one of " > > + HostMemPolicy_value_str, > > + &error_abort); > > } > > > > static const TypeInfo host_memory_backend_info = { > > diff --git a/crypto/secret.c b/crypto/secret.c > > index 285ab7a..71d06e3 100644 > > --- a/crypto/secret.c > > +++ b/crypto/secret.c > > @@ -382,6 +382,10 @@ qcrypto_secret_class_init(ObjectClass *oc, void *data) > > qcrypto_secret_prop_get_format, > > qcrypto_secret_prop_set_format, > > NULL); > > + object_class_property_set_description(oc, "format", > > + "Data format: one of " > > + QCryptoSecretFormat_value_str, > > + &error_abort); > > object_class_property_add_str(oc, "data", > > qcrypto_secret_prop_get_data, > > qcrypto_secret_prop_set_data, > > diff --git a/crypto/tlscreds.c b/crypto/tlscreds.c > > index a896553..d3af38a 100644 > > --- a/crypto/tlscreds.c > > +++ b/crypto/tlscreds.c > > @@ -237,6 +237,10 @@ qcrypto_tls_creds_class_init(ObjectClass *oc, void *data) > > qcrypto_tls_creds_prop_get_endpoint, > > qcrypto_tls_creds_prop_set_endpoint, > > NULL); > > + object_class_property_set_description(oc, "endpoint", > > + "Data format: one of " > > + QCryptoTLSCredsEndpoint_value_str, > > + &error_abort); > > object_class_property_add_str(oc, "priority", > > qcrypto_tls_creds_prop_get_priority, > > qcrypto_tls_creds_prop_set_priority, > > diff --git a/net/filter.c b/net/filter.c > > index 1dfd2ca..205fb49 100644 > > --- a/net/filter.c > > +++ b/net/filter.c > > @@ -182,6 +182,10 @@ static void netfilter_init(Object *obj) > > NetFilterDirection_lookup, > > netfilter_get_direction, netfilter_set_direction, > > NULL); > > + object_property_set_description(obj, "queue", > > + "Data format: one of " > > + NetFilterDirection_value_str, > > + &error_abort); > > object_property_add_str(obj, "status", > > netfilter_get_status, netfilter_set_status, > > NULL); > > After each > > object_class_property_add_enum(OC, PROP_NAME", ENUM_NAME, ...); > > you add > > object_class_property_set_description(OC, PROP_NAME, > "Data format: one of " > ENUM_NAME_value_str, > &error_abort); > > Whenever somebody adds another object_class_property_add_enum(), he > should also add an object_class_property_set_description(). Easily > forgotten. > > Why not do it in object_class_property_add_enum() automatically? > We got strings[] there... We could make every single object_property_add_* method accept a description, but it'd be a huge code-churn to retrofit. Regards, Daniel -- |: http://berrange.com -o- http://www.flickr.com/photos/dberrange/ :| |: http://libvirt.org -o- http://virt-manager.org :| |: http://entangle-photo.org -o- http://search.cpan.org/~danberr/ :|