[libvirt] [PATCH 1/5] qemu_domain: Document qemuDomainObjBeginJob

[John Ferlan]

On 06/07/2018 07:59 AM, Michal Privoznik wrote:
> Provide a small comment on the function and its parameters.
> 
> Signed-off-by: Michal Privoznik <mprivozn at redhat.com>
> ---
>  src/qemu/qemu_domain.c | 18 ++++++++++++++++--
>  1 file changed, 16 insertions(+), 2 deletions(-)
> 
> diff --git a/src/qemu/qemu_domain.c b/src/qemu/qemu_domain.c
> index c5237e4d41..97149613a2 100644
> --- a/src/qemu/qemu_domain.c
> +++ b/src/qemu/qemu_domain.c
> @@ -6334,8 +6334,22 @@ qemuDomainJobAllowed(qemuDomainObjPrivatePtr priv, qemuDomainJob job)
>  /* Give up waiting for mutex after 30 seconds */
>  #define QEMU_JOB_WAIT_TIME (1000ull * 30)
>  
> -/*
> - * obj must be locked before calling
> +/**
> + * qemuDomainObjBeginJobInternal:
> + * @driver: qemu driver
> + * @obj: domain object
> + * @job: qemuDomainJob to start
> + * @asyncJob: qemuDomainAsyncJob to start
> + *
> + * Acquires job over domain object which must be locked before

s/over/for a/ ?

> + * calling. If there's already a job running waits up to
> + * QEMU_JOB_WAIT_TIME after which the functions fails reporting
> + * an error.
> + *

Reviewed-by: John Ferlan <jferlan at redhat.com>

John

> + * Returns: 0 on success,
> + *         -2 if unable to start job because of timeout or
> + *            maxQueuedJobs limit,
> + *         -1 otherwise.
>   */
>  static int ATTRIBUTE_NONNULL(1)
>  qemuDomainObjBeginJobInternal(virQEMUDriverPtr driver,
>