Re: [Qemu-trivial] [PATCH v2] qdev: Clean up around properties

[Paolo Bonzini <pbonzini@redhat.com>]

Just comments, so

Cc: qemu-trivial@nongnu.org

On 17/04/2016 09:45, Cao jin wrote:
> include:
> 1. remove unnecessary declaration of static function
> 2. fix inconsistency between comment and function name, and typo OOM->QOM
> 2. update comments of functions, use uniform format(GTK-Doc style)
> 
> Signed-off-by: Cao jin <caoj.fnst@cn.fujitsu.com>
> ---
> changelog:
> 1. Use uniform comment format. (Markus)
> 2. Update function comments. (Markus & Paolo)
> 
> comments of qdev_add_legacy_property maybe need polishing, Maintainer who will
> take this patch can touch that comment directly:)
> 
>  hw/core/qdev.c               | 30 +++++++++++++++++++-----------
>  include/hw/qdev-properties.h | 10 ++++++++--
>  2 files changed, 27 insertions(+), 13 deletions(-)
> 
> diff --git a/hw/core/qdev.c b/hw/core/qdev.c
> index db41aa1..204f77b 100644
> --- a/hw/core/qdev.c
> +++ b/hw/core/qdev.c
> @@ -58,9 +58,6 @@ const char *qdev_fw_name(DeviceState *dev)
>      return object_get_typename(OBJECT(dev));
>  }
>  
> -static void qdev_property_add_legacy(DeviceState *dev, Property *prop,
> -                                     Error **errp);
> -
>  static void bus_remove_child(BusState *bus, DeviceState *child)
>  {
>      BusChild *kid;
> @@ -908,13 +905,20 @@ static void qdev_get_legacy_property(Object *obj, Visitor *v,
>  }
>  
>  /**
> - * @qdev_add_legacy_property - adds a legacy property
> + * qdev_property_add_legacy:
> + * @dev: Device to add the property to.
> + * @prop: The qdev property definition.
> + * @errp: location to store error information.
> + *
> + * Add a legacy QOM property to @dev for qdev property @prop.
> + * On error, store error in @errp.
>   *
> - * Do not use this is new code!  Properties added through this interface will
> - * be given names and types in the "legacy" namespace.
> + * Legacy properties are string versions of QOM properties.  The format of
> + * the string depends on the property type.  Legacy properties are only
> + * needed for "info qtree".
>   *
> - * Legacy properties are string versions of other OOM properties.  The format
> - * of the string depends on the property type.
> + * Do not use this is new code!  QOM Properties added through this interface
> + * will be given names in the "legacy" namespace.
>   */
>  static void qdev_property_add_legacy(DeviceState *dev, Property *prop,
>                                       Error **errp)
> @@ -937,10 +941,14 @@ static void qdev_property_add_legacy(DeviceState *dev, Property *prop,
>  }
>  
>  /**
> - * @qdev_property_add_static - add a @Property to a device.
> + * qdev_property_add_static:
> + * @dev: Device to add the property to.
> + * @prop: The qdev property definition.
> + * @errp: location to store error information.
>   *
> - * Static properties access data in a struct.  The actual type of the
> - * property and the field depends on the property type.
> + * Add a static QOM property to @dev for qdev property @prop.
> + * On error, store error in @errp.  Static properties access data in a struct.
> + * The type of the QOM property is derived from prop->info.
>   */
>  void qdev_property_add_static(DeviceState *dev, Property *prop,
>                                Error **errp)
> diff --git a/include/hw/qdev-properties.h b/include/hw/qdev-properties.h
> index 0586cac..034b75a 100644
> --- a/include/hw/qdev-properties.h
> +++ b/include/hw/qdev-properties.h
> @@ -197,8 +197,14 @@ void error_set_from_qdev_prop_error(Error **errp, int ret, DeviceState *dev,
>                                      Property *prop, const char *value);
>  
>  /**
> - * @qdev_property_add_static - add a @Property to a device referencing a
> - * field in a struct.
> + * qdev_property_add_static:
> + * @dev: Device to add the property to.
> + * @prop: The qdev property definition.
> + * @errp: location to store error information.
> + *
> + * Add a static QOM property to @dev for qdev property @prop.
> + * On error, store error in @errp.  Static properties access data in a struct.
> + * The type of the QOM property is derived from prop->info.
>   */
>  void qdev_property_add_static(DeviceState *dev, Property *prop, Error **errp);
>  
>