shaba/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-03-30 18:50:18 +03:00
Code Releases Activity

docs: Point to VIR_ERR_AGENT_COMMAND_TIMEOUT when setting timeout

Browse Source 
In addition to the error constant appearing add docs hinting that this
new error code can be produced on timeouts.

The most relevant place is to do it when setting the timeout.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
Peter Krempa 2025-03-20 15:44:35 +01:00
parent 54312df15b
commit 8b40067ece
2 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/manpages/virsh.rst
View File

@ -3068,6 +3068,9 @@ values:
libvirt daemon),
* 0 - do not wait at all,
In all guest-agent based APIs when a timeout happens if an actual command was
send to the guest agent the returned error code will be
VIR_ERR_AGENT_COMMAND_TIMEOUT.
guestinfo
---------

4
src/libvirt-domain.c
View File

@ -13522,6 +13522,10 @@ int virDomainSetLaunchSecurityState(virDomainPtr domain,
* VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT(0): does not wait.
* positive value: wait for @timeout seconds
*
* In all guest-agent based APIs when a timeout happens if an actual command
* was send to the guest agent the returned error code will be
* VIR_ERR_AGENT_COMMAND_TIMEOUT.
*
* Returns 0 on success, -1 on failure
*
* Since: 5.10.0