Re: [Qemu-devel] [PATCH v4 2/5] qom: add description field in ObjectProperty struct

["Michael S. Tsirkin" <mst@redhat.com>]

On Tue, Sep 30, 2014 at 11:02:36AM +0800, arei.gonglei@huawei.com wrote:
> From: Gonglei <arei.gonglei@huawei.com>
> 
> The descriptions can serve as documentation in the code,
> and they can be used to provide better help.
> 
> When we call object_property_add_alias() adding alias properties to
> the source object on the target Object, set the object property's
> description to the source object property's.


I think by the above you mean "Copy property descriptions when copying alias
properties"?

> Cc: Paolo Bonzini <pbonzini@redhat.com>
> Cc: Michael S. Tsirkin <mst@redhat.com>
> Cc: Markus Armbruster <armbru@redhat.com>
> Signed-off-by: Gonglei <arei.gonglei@huawei.com>
> ---
>  include/qom/object.h | 15 +++++++++++++++
>  qom/object.c         | 20 ++++++++++++++++++++
>  2 files changed, 35 insertions(+)
> 
> diff --git a/include/qom/object.h b/include/qom/object.h
> index 8a05a81..ddc600d 100644
> --- a/include/qom/object.h
> +++ b/include/qom/object.h
> @@ -338,6 +338,7 @@ typedef struct ObjectProperty
>  {
>      gchar *name;
>      gchar *type;
> +    gchar *description;
>      ObjectPropertyAccessor *get;
>      ObjectPropertyAccessor *set;
>      ObjectPropertyResolve *resolve;
> @@ -1274,6 +1275,20 @@ void object_property_add_alias(Object *obj, const char *name,
>                                 Object *target_obj, const char *target_name,
>                                 Error **errp);
>  
> +

Avoid duplicate empty lines please.

> +/**
> + * object_property_set_description:
> + * @obj: the object to set a property's description to

do you mean "the object owning the property"?

> + * @name: the name of the property
> + * @description: the description of the property on the object
> + * @errp: if an error occurs, a pointer to an area to store the error
> + *
> + * Set an object property's description.
> + *
> + */
> +void object_property_set_description(Object *obj, const char *name,
> +                                     const char *description, Error **errp);
> +
>  /**
>   * object_child_foreach:
>   * @obj: the object whose children will be navigated
> diff --git a/qom/object.c b/qom/object.c
> index 575291f..a751367 100644
> --- a/qom/object.c
> +++ b/qom/object.c
> @@ -369,6 +369,7 @@ static void object_property_del_all(Object *obj)
>  
>          g_free(prop->name);
>          g_free(prop->type);
> +        g_free(prop->description);
>          g_free(prop);
>      }
>  }
> @@ -803,6 +804,7 @@ void object_property_del(Object *obj, const char *name, Error **errp)
>  
>      g_free(prop->name);
>      g_free(prop->type);
> +    g_free(prop->description);
>      g_free(prop);
>  }
>  
> @@ -1672,10 +1674,28 @@ void object_property_add_alias(Object *obj, const char *name,
>      }
>      op->resolve = property_resolve_alias;
>  
> +    object_property_set_description(obj, name,
> +                                    target_prop->description,
> +                                    &error_abort);
> +
>  out:
>      g_free(prop_type);
>  }
>  
> +void object_property_set_description(Object *obj, const char *name,
> +                                     const char *description, Error **errp)
> +{
> +    ObjectProperty *op;
> +
> +    op = object_property_find(obj, name, errp);
> +    if (!op) {
> +        return;
> +    }
> +
> +    g_free(op->description);
> +    op->description = g_strdup(description);
> +}
> +
>  static void object_instance_init(Object *obj)
>  {
>      object_property_add_str(obj, "type", qdev_get_type, NULL, NULL);
> -- 
> 2.0.4
>