shaba/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-06-02 21:06:44 +03:00
Code Releases Activity

API: Clarify behaviour of autostart vs autostart once

Browse Source 
If either of the autostart settings is enabled the VM will be
autostarted. Attempt to clarify that.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
Peter Krempa 2025-05-05 16:33:32 +02:00
parent 6db8dc63bc
commit dd8573b3ea
1 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/libvirt-domain.c
View File

@ -7322,9 +7322,8 @@ virDomainCreateWithFiles(virDomainPtr domain, unsigned int nfiles,
* @domain: a domain object
* @autostart: the value returned
*
* Provides a boolean value indicating whether the domain
* configured to be automatically started when the host
* machine boots.
* Provides a boolean value indicating whether the domain is configured to be
* automatically started each time when the host machine boots.
*
* Returns -1 in case of error, 0 in case of success
*
@ -7366,8 +7365,8 @@ virDomainGetAutostart(virDomainPtr domain,
* @domain: a domain object
* @autostart: whether the domain should be automatically started 0 or 1
*
* Configure the domain to be automatically started
* when the host machine boots.
* Configure the domain to be automatically started each time when the host
* machine boots.
*
* Returns -1 in case of error, 0 in case of success
*
@ -7409,9 +7408,12 @@ virDomainSetAutostart(virDomainPtr domain,
* @domain: a domain object
* @autostart: the value returned
*
* Provides a boolean value indicating whether the domain
* is configured to be automatically started the next time
* the host machine boots only.
* Provides a boolean value indicating whether the domain is configured to be
* automatically started next time when the host machine boots.
*
* Note that autostart configured via the virDomain[Set|Get]AutostartOnce APIs
* is independent from the autostart configured via virDomain[Set|Get]Autostart.
* Enabling either of them will cause the VM to be started on the next boot.
*
* Returns -1 in case of error, 0 in case of success
*
@ -7453,8 +7455,12 @@ virDomainGetAutostartOnce(virDomainPtr domain,
* @domain: a domain object
* @autostart: whether the domain should be automatically started 0 or 1
*
* Configure the domain to be automatically started
* the next time the host machine boots only.
* Configure the domain to be automatically started the next when the host
* machine boots.
*
* Note that autostart configured via the virDomain[Set|Get]AutostartOnce APIs
* is independent from the autostart configured via virDomain[Set|Get]Autostart.
* Enabling either of them will cause the VM to be started on the next boot.
*
* Returns -1 in case of error, 0 in case of success
*