[libvirt] [PATCH 2/4] Adjust comments to describe on_poweroff and on_reboot action

[Michal Privoznik]

On 24.04.2013 13:40, John Ferlan wrote:
> ---
>  src/libvirt.c | 15 +++++++++++----
>  1 file changed, 11 insertions(+), 4 deletions(-)
> 
> diff --git a/src/libvirt.c b/src/libvirt.c
> index c236152..4bd6c9a 100644
> --- a/src/libvirt.c
> +++ b/src/libvirt.c
> @@ -3184,9 +3184,11 @@ error:
>   * virDomainShutdown:
>   * @domain: a domain object
>   *
> - * Shutdown a domain, the domain object is still usable thereafter but
> + * Shutdown a domain, the domain object is still usable thereafter, but
>   * the domain OS is being stopped. Note that the guest OS may ignore the
> - * request.  For guests that react to a shutdown request, the differences
> + * request.  Additionally, the hypervisor may check and support the domain

Can we kill this double space when touching this? I've noticed vim
sometimes insert two spaces when re-aligning text, so it's really just a
suggestion ...

> + * 'on_poweroff' XML setting resulting in a domain that reboots instead of
> + * shutting down. For guests that react to a shutdown request, the differences

Here we have exactly one space.

>   * from virDomainDestroy() are that the guests disk storage will be in a
>   * stable state rather than having the (virtual) power cord pulled, and
>   * this command returns as soon as the shutdown request is issued rather
> @@ -3241,7 +3243,9 @@ error:
>   *
>   * Shutdown a domain, the domain object is still usable thereafter but
>   * the domain OS is being stopped. Note that the guest OS may ignore the
> - * request.  For guests that react to a shutdown request, the differences
> + * request.  Additionally, the hypervisor may check and support the domain
> + * 'on_poweroff' XML setting resulting in a domain that reboots instead of
> + * shutting down. For guests that react to a shutdown request, the differences
>   * from virDomainDestroy() are that the guest's disk storage will be in a
>   * stable state rather than having the (virtual) power cord pulled, and
>   * this command returns as soon as the shutdown request is issued rather
> @@ -3300,9 +3304,12 @@ error:
>   * @domain: a domain object
>   * @flags: bitwise-OR of virDomainRebootFlagValues
>   *
> - * Reboot a domain, the domain object is still usable there after but
> + * Reboot a domain, the domain object is still usable thereafter, but
>   * the domain OS is being stopped for a restart.
>   * Note that the guest OS may ignore the request.
> + * Additionally, the hypervisor may check and support the domain
> + * 'on_reboot' XML setting resulting in a domain that shuts down instead
> + * of rebooting.
>   *
>   * If @flags is set to zero, then the hypervisor will choose the
>   * method of shutdown it considers best. To have greater control
>