]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: improve VIR_DOMAIN_AFFECT_CURRENT description
authorEric Blake <eblake@redhat.com>
Fri, 3 Jun 2011 16:06:33 +0000 (10:06 -0600)
committerEric Blake <eblake@redhat.com>
Tue, 14 Jun 2011 15:17:57 +0000 (09:17 -0600)
* include/libvirt/libvirt.h.in (virDomainModificationImpact): Reword.

include/libvirt/libvirt.h.in

index 3d8a0a1ad7e14586a130d059ad1a819686ec6e4e..75c6f603c931670dc8e3774274bfb232fb46b94b 100644 (file)
@@ -144,11 +144,16 @@ typedef enum {
 /**
  * virDomainModificationImpact:
  *
- * Several APIs take flags to determine whether a change to the domain
- * affects just the running instance, just the persistent definition,
- * or both.  The use of VIR_DOMAIN_AFFECT_CURRENT will resolve to
- * either VIR_DOMAIN_AFFECT_LIVE or VIR_DOMAIN_AFFECT_CONFIG according
- * to current domain state. VIR_DOMAIN_AFFECT_LIVE requires a running
+ * Several modification APIs take flags to determine whether a change
+ * to the domain affects just the running instance, just the
+ * persistent definition, or both at the same time.  The counterpart
+ * query APIs also take the same flags to determine whether to query
+ * the running instance or persistent definition, although both cannot
+ * be queried at once.
+ *
+ * The use of VIR_DOMAIN_AFFECT_CURRENT will resolve to either
+ * VIR_DOMAIN_AFFECT_LIVE or VIR_DOMAIN_AFFECT_CONFIG according to
+ * current domain state. VIR_DOMAIN_AFFECT_LIVE requires a running
  * domain, and VIR_DOMAIN_AFFECT_CONFIG requires a persistent domain
  * (whether or not it is running).
  */