[Qemu-trivial] [PATCH 1/3] object.h: spelling fix

[Qemu-trivial] [PATCH 1/3] object.h: spelling fix

[Marc-André Lureau]

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
 include/qom/object.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/qom/object.h b/include/qom/object.h
index 5ecc2d166d..c5e6fc1f5d 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -432,7 +432,7 @@ struct Object
  * @class_base_init: This function is called for all base classes after all
  *   parent class initialization has occurred, but before the class itself
  *   is initialized.  This is the function to use to undo the effects of
- *   memcpy from the parent class to the descendents.
+ *   memcpy from the parent class to the descendants.
  * @class_finalize: This function is called during class destruction and is
  *   meant to release and dynamic parameters allocated by @class_init.
  * @class_data: Data to pass to the @class_init, @class_base_init and
-- 
2.11.0

[Qemu-trivial] [PATCH 2/3] object.h: improve OBJECT/OBJECT_CLASS doc

[Marc-André Lureau]

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
 include/qom/object.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/qom/object.h b/include/qom/object.h
index c5e6fc1f5d..c5456db05d 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -467,7 +467,7 @@ struct TypeInfo
  * OBJECT:
  * @obj: A derivative of #Object
  *
- * Converts an object to a #Object.  Since all objects are #Objects,
+ * Converts an object to a #Object.  Since all objects are #Object,
  * this function will always succeed.
  */
 #define OBJECT(obj) \
@@ -477,8 +477,8 @@ struct TypeInfo
  * OBJECT_CLASS:
  * @class: A derivative of #ObjectClass.
  *
- * Converts a class to an #ObjectClass.  Since all objects are #Objects,
- * this function will always succeed.
+ * Converts a class to an #ObjectClass.  Since all classes are
+ * #ObjectClass, this function will always succeed.
  */
 #define OBJECT_CLASS(class) \
     ((ObjectClass *)(class))
-- 
2.11.0

Re: [Qemu-trivial] [PATCH 2/3] object.h: improve OBJECT/OBJECT_CLASS doc

[Michael Tokarev]

12.12.2016 20:31, Marc-André Lureau wrote:
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> ---
>  include/qom/object.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/include/qom/object.h b/include/qom/object.h
> index c5e6fc1f5d..c5456db05d 100644
> --- a/include/qom/object.h
> +++ b/include/qom/object.h
> @@ -467,7 +467,7 @@ struct TypeInfo
>   * OBJECT:
>   * @obj: A derivative of #Object
>   *
> - * Converts an object to a #Object.  Since all objects are #Objects,
> + * Converts an object to a #Object.  Since all objects are #Object,
>   * this function will always succeed.

I'm not sure this is a good change. Yes the type name is "Object"
(singular), but we refer to multiple objectS (plural), so... :)
If we had some coloring, we'd wrote it like, eg, #<b>Object</b>s,
with "s" being outside of the type name.

Thanks,

/mjt

Re: [Qemu-trivial] [Qemu-devel] [PATCH 2/3] object.h: improve OBJECT/OBJECT_CLASS doc

[Peter Maydell]

On 12 January 2017 at 10:46, Michael Tokarev <mjt@tls.msk.ru> wrote:
> 12.12.2016 20:31, Marc-André Lureau wrote:
>> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
>> ---
>>  include/qom/object.h | 6 +++---
>>  1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/include/qom/object.h b/include/qom/object.h
>> index c5e6fc1f5d..c5456db05d 100644
>> --- a/include/qom/object.h
>> +++ b/include/qom/object.h
>> @@ -467,7 +467,7 @@ struct TypeInfo
>>   * OBJECT:
>>   * @obj: A derivative of #Object
>>   *
>> - * Converts an object to a #Object.  Since all objects are #Objects,
>> + * Converts an object to a #Object.  Since all objects are #Object,
>>   * this function will always succeed.
>
> I'm not sure this is a good change. Yes the type name is "Object"
> (singular), but we refer to multiple objectS (plural), so... :)
> If we had some coloring, we'd wrote it like, eg, #<b>Object</b>s,
> with "s" being outside of the type name.

Mmm, but doc-comment parsers won't be able to figure out that
#Objects should refer to the #Object type. You could rephrase
as "Since every object is an #Object" to get around that.

thanks
-- PMM

[Qemu-trivial] [PATCH 3/3] object: make some funcs static

[Marc-André Lureau]

There is no need to have those functions as public API.

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
 qom/object.c         |  4 ++--
 include/qom/object.h | 24 ------------------------
 2 files changed, 2 insertions(+), 26 deletions(-)

diff --git a/qom/object.c b/qom/object.c
index 7a05e35ed9..eb3d0f64e4 100644
--- a/qom/object.c
+++ b/qom/object.c
@@ -351,7 +351,7 @@ static void object_post_init_with_type(Object *obj, TypeImpl *ti)
     }
 }
 
-void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
+static void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
 {
     Object *obj = data;
 
@@ -467,7 +467,7 @@ static void object_finalize(void *data)
     }
 }
 
-Object *object_new_with_type(Type type)
+static Object *object_new_with_type(Type type)
 {
     Object *obj;
 
diff --git a/include/qom/object.h b/include/qom/object.h
index c5456db05d..e9791a210e 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -586,18 +586,6 @@ struct InterfaceClass
  */
 Object *object_new(const char *typename);
 
-/**
- * object_new_with_type:
- * @type: The type of the object to instantiate.
- *
- * This function will initialize a new object using heap allocated memory.
- * The returned object has a reference count of 1, and will be freed when
- * the last reference is dropped.
- *
- * Returns: The newly allocated and instantiated object.
- */
-Object *object_new_with_type(Type type);
-
 /**
  * object_new_with_props:
  * @typename:  The name of the type of the object to instantiate.
@@ -726,18 +714,6 @@ int object_set_propv(Object *obj,
                      Error **errp,
                      va_list vargs);
 
-/**
- * object_initialize_with_type:
- * @data: A pointer to the memory to be used for the object.
- * @size: The maximum size available at @data for the object.
- * @type: The type of the object to instantiate.
- *
- * This function will initialize an object.  The memory for the object should
- * have already been allocated.  The returned object has a reference count of 1,
- * and will be finalized when the last reference is dropped.
- */
-void object_initialize_with_type(void *data, size_t size, Type type);
-
 /**
  * object_initialize:
  * @obj: A pointer to the memory to be used for the object.
-- 
2.11.0

Re: [Qemu-trivial] [PATCH 3/3] object: make some funcs static

[Michael Tokarev]

12.12.2016 20:31, Marc-André Lureau wrote:
> There is no need to have those functions as public API.

Were "some" being object_initialize_with_type() and
object_new_with_type().

I'm applying this to -trivial, and Cc'ing Andreas, maybe
he will say more.

Thanks,

> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> ---
>  qom/object.c         |  4 ++--
>  include/qom/object.h | 24 ------------------------
>  2 files changed, 2 insertions(+), 26 deletions(-)
> 
> diff --git a/qom/object.c b/qom/object.c
> index 7a05e35ed9..eb3d0f64e4 100644
> --- a/qom/object.c
> +++ b/qom/object.c
> @@ -351,7 +351,7 @@ static void object_post_init_with_type(Object *obj, TypeImpl *ti)
>      }
>  }
>  
> -void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
> +static void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
>  {
>      Object *obj = data;
>  
> @@ -467,7 +467,7 @@ static void object_finalize(void *data)
>      }
>  }
>  
> -Object *object_new_with_type(Type type)
> +static Object *object_new_with_type(Type type)
>  {
>      Object *obj;
>  
> diff --git a/include/qom/object.h b/include/qom/object.h
> index c5456db05d..e9791a210e 100644
> --- a/include/qom/object.h
> +++ b/include/qom/object.h
> @@ -586,18 +586,6 @@ struct InterfaceClass
>   */
>  Object *object_new(const char *typename);
>  
> -/**
> - * object_new_with_type:
> - * @type: The type of the object to instantiate.
> - *
> - * This function will initialize a new object using heap allocated memory.
> - * The returned object has a reference count of 1, and will be freed when
> - * the last reference is dropped.
> - *
> - * Returns: The newly allocated and instantiated object.
> - */
> -Object *object_new_with_type(Type type);
> -
>  /**
>   * object_new_with_props:
>   * @typename:  The name of the type of the object to instantiate.
> @@ -726,18 +714,6 @@ int object_set_propv(Object *obj,
>                       Error **errp,
>                       va_list vargs);
>  
> -/**
> - * object_initialize_with_type:
> - * @data: A pointer to the memory to be used for the object.
> - * @size: The maximum size available at @data for the object.
> - * @type: The type of the object to instantiate.
> - *
> - * This function will initialize an object.  The memory for the object should
> - * have already been allocated.  The returned object has a reference count of 1,
> - * and will be finalized when the last reference is dropped.
> - */
> -void object_initialize_with_type(void *data, size_t size, Type type);
> -
>  /**
>   * object_initialize:
>   * @obj: A pointer to the memory to be used for the object.
> 

Re: [Qemu-trivial] [PATCH 3/3] object: make some funcs static

[Paolo Bonzini]

On 12/01/2017 11:48, Michael Tokarev wrote:
> 12.12.2016 20:31, Marc-André Lureau wrote:
>> There is no need to have those functions as public API.
> 
> Were "some" being object_initialize_with_type() and
> object_new_with_type().
> 
> I'm applying this to -trivial, and Cc'ing Andreas, maybe
> he will say more.

The idea here was to allow caching the type and speed up things.  But I
guess that QOM objects are very heavyweight, and thus we won't have for
example SCSIRequest as a QOM object.

Paolo

> Thanks,
> 
>> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
>> ---
>>  qom/object.c         |  4 ++--
>>  include/qom/object.h | 24 ------------------------
>>  2 files changed, 2 insertions(+), 26 deletions(-)
>>
>> diff --git a/qom/object.c b/qom/object.c
>> index 7a05e35ed9..eb3d0f64e4 100644
>> --- a/qom/object.c
>> +++ b/qom/object.c
>> @@ -351,7 +351,7 @@ static void object_post_init_with_type(Object *obj, TypeImpl *ti)
>>      }
>>  }
>>  
>> -void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
>> +static void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
>>  {
>>      Object *obj = data;
>>  
>> @@ -467,7 +467,7 @@ static void object_finalize(void *data)
>>      }
>>  }
>>  
>> -Object *object_new_with_type(Type type)
>> +static Object *object_new_with_type(Type type)
>>  {
>>      Object *obj;
>>  
>> diff --git a/include/qom/object.h b/include/qom/object.h
>> index c5456db05d..e9791a210e 100644
>> --- a/include/qom/object.h
>> +++ b/include/qom/object.h
>> @@ -586,18 +586,6 @@ struct InterfaceClass
>>   */
>>  Object *object_new(const char *typename);
>>  
>> -/**
>> - * object_new_with_type:
>> - * @type: The type of the object to instantiate.
>> - *
>> - * This function will initialize a new object using heap allocated memory.
>> - * The returned object has a reference count of 1, and will be freed when
>> - * the last reference is dropped.
>> - *
>> - * Returns: The newly allocated and instantiated object.
>> - */
>> -Object *object_new_with_type(Type type);
>> -
>>  /**
>>   * object_new_with_props:
>>   * @typename:  The name of the type of the object to instantiate.
>> @@ -726,18 +714,6 @@ int object_set_propv(Object *obj,
>>                       Error **errp,
>>                       va_list vargs);
>>  
>> -/**
>> - * object_initialize_with_type:
>> - * @data: A pointer to the memory to be used for the object.
>> - * @size: The maximum size available at @data for the object.
>> - * @type: The type of the object to instantiate.
>> - *
>> - * This function will initialize an object.  The memory for the object should
>> - * have already been allocated.  The returned object has a reference count of 1,
>> - * and will be finalized when the last reference is dropped.
>> - */
>> -void object_initialize_with_type(void *data, size_t size, Type type);
>> -
>>  /**
>>   * object_initialize:
>>   * @obj: A pointer to the memory to be used for the object.
>>
> 
> 
> 

Re: [Qemu-trivial] [PATCH 1/3] object.h: spelling fix

[Michael Tokarev]

12.12.2016 20:31, Marc-André Lureau wrote:
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> ---
>  include/qom/object.h | 2 +-

Applied to -trivial, thanks!

/mjt