Re: [PATCH] datatypes: Fix comments

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 03/04/2014 03:58 AM, Michael Chapman wrote:
> - As of commit 2ff4c137, all virGet*() functions in datatypes.c always
>   return pointers to new objects. Objects are not cached in a
>   per-connection hashtable.
> 

> - As of commit 46ec5f85, the conn.lock mutex does not need to be held
>   when calling any vir*Dispose() function in datatypes.c (via
>   virObjectUnref()).
> 

I've split out this part and pushed it.

> - Add comments for virGetStream(), virStreamDispose(),
>   virGetDomainSnapshot(), virDomainSnapshotDispose().
> 
> Signed-off-by: Michael Chapman <mike@xxxxxxxxxxxxxxxxx>
> ---
>  src/datatypes.c | 174 ++++++++++++++++++++++++++++++++------------------------
>  1 file changed, 99 insertions(+), 75 deletions(-)
> 
> 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.

Jan

Attachment: signature.asc
Description: OpenPGP digital signature

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list

[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]