Re: [Qemu-devel] [PATCH] qom/object: fix 2 comment typos

[Cao jin <caoj.fnst@cn.fujitsu.com>]

On 11/02/2015 07:34 PM, Peter Maydell wrote:
> On 2 November 2015 at 09:04, Cao jin <caoj.fnst@cn.fujitsu.com> wrote:
>> Signed-off-by: Cao jin <caoj.fnst@cn.fujitsu.com>
>> ---
>>   include/qom/object.h | 2 +-
>>   qom/object.c         | 2 +-
>>   2 files changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/include/qom/object.h b/include/qom/object.h
>> index be7280c..9e5162a 100644
>> --- a/include/qom/object.h
>> +++ b/include/qom/object.h
>> @@ -511,7 +511,7 @@ struct TypeInfo
>>   /**
>>    * OBJECT_CLASS_CHECK:
>>    * @class: The C type to use for the return value.
>> - * @obj: A derivative of @type to cast.
>> + * @obj: A derivative class of @class to cast.
>>    * @name: the QOM typename of @class.
>
> I think this is right but not sufficient. Since OBJECT_CLASS_CHECK's
> second parameter is not an object but a class, the name "obj" is
> rather misleading and should be changed. My suggestion would be
> to use
>
>   * @classtype: The C type to use for the return value.
>   * @class: A derivative class of @classtype to cast.
>   * @name: the QOM typename of @class.
>
> (and the macro definition parameter names should change to match).
>

Yes, Agree. The comment seems just a copy of macro OBJECT_CHECK`s. Will 
modify it in v2:)

>>    *
>>    * A type safe version of @object_class_dynamic_cast_assert.  This macro is
>> diff --git a/qom/object.c b/qom/object.c
>> index 11cd86b..fc6e161 100644
>> --- a/qom/object.c
>> +++ b/qom/object.c
>> @@ -204,7 +204,7 @@ static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
>>   {
>>       assert(target_type);
>>
>> -    /* Check if typename is a direct ancestor of type */
>> +    /* Check if target_type is a direct ancestor of type */
>>       while (type) {
>>           if (type == target_type) {
>>               return true;
>
> This change is good.
>
> thanks
> -- PMM
>

-- 
Yours Sincerely,

Cao Jin