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

Re: [libvirt] [PATCH 1/4] Fix docs for PM event callbacks



On Thu, Sep 6, 2012 at 10:09 AM, Jiri Denemark <jdenemar redhat com> wrote:
> PM{Suspend,Wakeup} event callbacks were designed with a reason parameter
> which could be used in the future. However, we do not transfer the
> reason over RPC and thus we can never use it in the future. Make it
> explicit in the docs.
> ---
>  include/libvirt/libvirt.h.in | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
>
> diff --git a/include/libvirt/libvirt.h.in b/include/libvirt/libvirt.h.in
> index cfe5047..44c1649 100644
> --- a/include/libvirt/libvirt.h.in
> +++ b/include/libvirt/libvirt.h.in
> @@ -3902,8 +3902,7 @@ typedef void (*virConnectDomainEventTrayChangeCallback)(virConnectPtr conn,
>   * virConnectDomainEventPMWakeupCallback:
>   * @conn: connection object
>   * @dom: domain on which the event occurred
> - * @reason: reason why the callback was called, unused currently,
> - *          always passes 0
> + * @reason: unused, will always be 0
>   * @opaque: application specified data
>   *
>   * This callback occurs when the guest is waken up.
> @@ -3920,8 +3919,7 @@ typedef void (*virConnectDomainEventPMWakeupCallback)(virConnectPtr conn,
>   * virConnectDomainEventPMSuspendCallback:
>   * @conn: connection object
>   * @dom: domain on which the event occurred
> - * @reason: reason why the callback was called, unused currently,
> - *          always passes 0
> + * @reason: unused, will always be 0
>   * @opaque: application specified data
>   *
>   * This callback occurs when the guest is waken up.
> --

ACK. unused is unused after all.

-- 
Doug Goldstein


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