External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-22 04:25:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve VIR_DOMAIN_AFFECT_CURRENT description

Browse Source 
* include/libvirt/libvirt.h.in (virDomainModificationImpact): Reword.
This commit is contained in:
Eric Blake 2011-06-03 10:06:33 -06:00
parent c0980a3a6e
commit ccf7c4b9ed
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
include/libvirt/libvirt.h.in
View File

@ -144,11 +144,16 @@ typedef enum {
/** /**
* virDomainModificationImpact: * virDomainModificationImpact:
* *
* Several APIs take flags to determine whether a change to the domain * Several modification APIs take flags to determine whether a change
* affects just the running instance, just the persistent definition, * to the domain affects just the running instance, just the
* or both. The use of VIR_DOMAIN_AFFECT_CURRENT will resolve to * persistent definition, or both at the same time. The counterpart
* either VIR_DOMAIN_AFFECT_LIVE or VIR_DOMAIN_AFFECT_CONFIG according * query APIs also take the same flags to determine whether to query
* to current domain state. VIR_DOMAIN_AFFECT_LIVE requires a running * 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 * domain, and VIR_DOMAIN_AFFECT_CONFIG requires a persistent domain
* (whether or not it is running). * (whether or not it is running).
*/ */