docs: document proper enum for guest agent timeout

[libvirt PATCH] docs: document proper enum for guest agent timeout

Posted by Tomáš Golembiovský 3 years, 11 months ago

The documented enum and its values do not exits. The real enum has
slightly different name.

Signed-off-by: Tomáš Golembiovský <tgolembi@redhat.com>
---
 src/libvirt-domain.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index a12809c2d5..37f864b7b0 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -12550,13 +12550,13 @@ int virDomainGetLaunchSecurityInfo(virDomainPtr domain,
  * Set how long to wait for a response from guest agent commands. By default,
  * agent commands block forever waiting for a response.
  *
- * @timeout must be a value from virDomainAgentCommandTimeoutValues or
+ * @timeout must be a value from virDomainAgentResponseTimeoutValues or
  * positive:
  *
- *   VIR_DOMAIN_AGENT_COMMAND_TIMEOUT_BLOCK(-2): meaning to block forever
+ *   VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK(-2): meaning to block forever
  *      waiting for a result.
- *   VIR_DOMAIN_AGENT_COMMAND_TIMEOUT_DEFAULT(-1): use default timeout value.
- *   VIR_DOMAIN_AGENT_COMMAND_TIMEOUT_NOWAIT(0): does not wait.
+ *   VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT(-1): use default timeout value.
+ *   VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT(0): does not wait.
  *   positive value: wait for @timeout seconds
  *
  * Returns 0 on success, -1 on failure
-- 
2.25.0

Re: [libvirt PATCH] docs: document proper enum for guest agent timeout

Posted by Michal Privoznik 3 years, 11 months ago

On 5/15/20 12:30 PM, Tomáš Golembiovský wrote:
> The documented enum and its values do not exits. The real enum has
> slightly different name.
> 
> Signed-off-by: Tomáš Golembiovský <tgolembi@redhat.com>
> ---
>   src/libvirt-domain.c | 8 ++++----
>   1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
> index a12809c2d5..37f864b7b0 100644
> --- a/src/libvirt-domain.c
> +++ b/src/libvirt-domain.c
> @@ -12550,13 +12550,13 @@ int virDomainGetLaunchSecurityInfo(virDomainPtr domain,
>    * Set how long to wait for a response from guest agent commands. By default,
>    * agent commands block forever waiting for a response.
>    *
> - * @timeout must be a value from virDomainAgentCommandTimeoutValues or
> + * @timeout must be a value from virDomainAgentResponseTimeoutValues or
>    * positive:
>    *
> - *   VIR_DOMAIN_AGENT_COMMAND_TIMEOUT_BLOCK(-2): meaning to block forever
> + *   VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK(-2): meaning to block forever
>    *      waiting for a result.
> - *   VIR_DOMAIN_AGENT_COMMAND_TIMEOUT_DEFAULT(-1): use default timeout value.
> - *   VIR_DOMAIN_AGENT_COMMAND_TIMEOUT_NOWAIT(0): does not wait.
> + *   VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT(-1): use default timeout value.
> + *   VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT(0): does not wait.
>    *   positive value: wait for @timeout seconds
>    *
>    * Returns 0 on success, -1 on failure
> 

Oops.

Reviewed-by: Michal Privoznik <mprivozn@redhat.com>

Pushed.

Michal