[libvirt] [PATCH] datatypes: Fix comments
Michael Chapman
mike at very.puzzling.org
Tue Mar 11 03:15:38 UTC 2014
On Thu, 6 Mar 2014, Ján Tomko wrote:
> On 03/04/2014 03:58 AM, Michael Chapman wrote:
>> diff --git a/src/datatypes.c b/src/datatypes.c
>> index 73f17e7..aafa54b 100644
>> --- a/src/datatypes.c
>> +++ b/src/datatypes.c
>> @@ -96,9 +96,8 @@ VIR_ONCE_GLOBAL_INIT(virDataTypes)
>> /**
>> * virGetConnect:
>> *
>> - * Allocates a new hypervisor connection structure
>> - *
>> - * Returns a new pointer or NULL in case of error.
>> + * Allocates and returns a pointer to a new hypervisor connection object.
>> + * Returns NULL on error.
>
> As someone pointed out to me in person, 'Returns' is a special keyword for our
> API docs builder script. Even if we aren't building docs out of this file, it
> would be nice to stick to that style.
Oh, wow, I wasn't aware of this. I'll send an updated patch with the
comments reworded accordingly -- they're still talking about a
no-longer-existent hash table.
Thanks for pushing the other parts of this patch.
Regards,
Michael
More information about the libvir-list
mailing list