]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
Adjust comments to describe on_poweroff and on_reboot action
authorJohn Ferlan <jferlan@redhat.com>
Tue, 23 Apr 2013 19:10:13 +0000 (15:10 -0400)
committerJohn Ferlan <jferlan@redhat.com>
Wed, 15 May 2013 10:25:36 +0000 (06:25 -0400)
src/libvirt.c

index 2b3515e32c5cc1706b4343f38a5aabf1bf8fa4b6..e6cb8de6da224773c58f750be845aab67068d6b9 100644 (file)
@@ -3181,9 +3181,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
+ * '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 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
@@ -3238,7 +3240,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
@@ -3297,9 +3301,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