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 <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>

diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst
index 35ae6af547a89398f6b49c8c755c51a93a1758e4..b609b9647fb381de5074ba9afce953a581f7d829 100644 (file)
--- 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 05e675f67ab7672a2096679b238999eb8b8e8674..594aa6ed93397b27823b428e46fdecb750b8df39 100644 (file)
--- 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