From nobody Fri Dec 19 18:47:29 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass(p=reject dis=none) header.from=lists.libvirt.org ARC-Seal: i=1; a=rsa-sha256; t=1742486768; cv=none; d=zohomail.com; s=zohoarc; b=EjAy0+ZbxIIWJfB2G6J8/ejz80C38Ps/emk+fX6aSPGSLiTiS5gfvNTrx8FZTgkxJOUWt85CVg4hmkDFJ9nj0vqnpmCZNGdePL7/wz5snR+Ngp7fJoJraaQzQDAgS6H2ErMIjJSi8VUHPLz1bhvqQYnbKqqOYTfuYWEz8tARbwA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1742486768; h=Content-Type:Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id:Cc; bh=gyB/1wqafo93nIlQ+JkvMJ58//Oqa/LN54vtoMkIYx4=; b=NvmkR0XS8d754bJWxoZ3sFmjSh/+pfr095n553MdUf1bPgfL6JPwfRXfvWdtLqIwyKXznfvkCMGyb3w15zDIrcinABOb0rZc7EfTJL23rWwEcfCsa1D3ne+/vRoEvP/wKZYS+ir2AQ4Kpce+EKuIrsTElgwJpMa6LpbMVnctccE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1742486768140504.0964887375901; Thu, 20 Mar 2025 09:06:08 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 8921415DF; Thu, 20 Mar 2025 12:06:07 -0400 (EDT) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id 4AE2215F2; Thu, 20 Mar 2025 12:04:44 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 996) id D09EE1274; Thu, 20 Mar 2025 12:04:16 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 51CDF1274 for ; Thu, 20 Mar 2025 12:04:16 -0400 (EDT) Received: from mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-610-xezWYDu8MAWC8MMagrK07g-1; Thu, 20 Mar 2025 12:04:14 -0400 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 14FFF180049D for ; Thu, 20 Mar 2025 16:04:14 +0000 (UTC) Received: from speedmetal.lan (unknown [10.45.242.6]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 1F34419373C4 for ; Thu, 20 Mar 2025 16:04:12 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.8 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2, RCVD_IN_VALIDITY_RPBL_BLOCKED,RCVD_IN_VALIDITY_SAFE_BLOCKED, SPF_HELO_NONE autolearn=unavailable autolearn_force=no version=3.4.4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1742486656; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=OnBIy30F3ykRtuIuXlpSSrmZVcSNhQK660bqc/0aOaQ=; b=fjmPbOy/YLKkhGieCum5R/2aGIHAoAPKknMu3sB515qEXxd61+kxAzXECEUrrsccC5zEoj GXQ5prIb99xZ9gfykgq25HU9ATW7eWF+2YXqtxNFSyjPScKiizqy5ROIKgWmH4yb9GMH47 a7LTb6E4Ynch+sPTHGflrTqpOpP6EPo= X-MC-Unique: xezWYDu8MAWC8MMagrK07g-1 X-Mimecast-MFC-AGG-ID: xezWYDu8MAWC8MMagrK07g_1742486654 To: devel@lists.libvirt.org Subject: [PATCH 4/8] docs: Point to VIR_ERR_AGENT_COMMAND_TIMEOUT when setting timeout Date: Thu, 20 Mar 2025 17:04:01 +0100 Message-ID: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: DUYKnZ4F_ij1AeQeNJjsYy-Upow_p9pZqYEoIi02BJE_1742486654 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: QYKYXIIB6GXWMSHHI2D6MN2LPEUNUFZX X-Message-ID-Hash: QYKYXIIB6GXWMSHHI2D6MN2LPEUNUFZX X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: From: Peter Krempa via Devel Reply-To: Peter Krempa X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1742486768962019000 Content-Type: text/plain; charset="utf-8" From: Peter Krempa 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 --- docs/manpages/virsh.rst | 3 +++ src/libvirt-domain.c | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst index baced15dec..6f31bd9ca3 100644 --- a/docs/manpages/virsh.rst +++ b/docs/manpages/virsh.rst @@ -2909,6 +2909,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 4e78c687d5..09c29df462 100644 --- a/src/libvirt-domain.c +++ b/src/libvirt-domain.c @@ -13519,6 +13519,10 @@ int virDomainSetLaunchSecurityState(virDomainPtr d= omain, * 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 comma= nd + * 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 --=20 2.48.1