From: Peter Krempa Date: Thu, 20 Mar 2025 14:44:35 +0000 (+0100) Subject: docs: Point to VIR_ERR_AGENT_COMMAND_TIMEOUT when setting timeout X-Git-Tag: v11.2.0-rc1~10 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=8b40067ece748669c050583f13f9a63af5ce6838;p=thirdparty%2Flibvirt.git docs: Point to VIR_ERR_AGENT_COMMAND_TIMEOUT when setting timeout 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 Reviewed-by: Ján Tomko --- diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst index 35ae6af547..b609b9647f 100644 --- a/docs/manpages/virsh.rst +++ b/docs/manpages/virsh.rst @@ -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 --------- diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c index 05e675f67a..594aa6ed93 100644 --- a/src/libvirt-domain.c +++ b/src/libvirt-domain.c @@ -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