From nobody Mon Feb 9 12:11:36 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1669035484; cv=none; d=zohomail.com; s=zohoarc; b=bBCb/c2Wj4JYIchjddwr+hrQ71USkDJ6mBsWp8RkeuXv7rrRm84yWKzUoiX7Ye2Aorp9laJ/PjWt8toQW1TBwwz139uXQFjmhOqXdOOdl+YfA+XTENBBkKN39OrHIGxPedARBKrztDSKFTWxg+kXsMG1Ly8Wq1WQH2LoJ5HVKW4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1669035484; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=cAkLMTiNQh3XvPmudxe2itN9czXLuyl1G/Q1qf0vHbY=; b=Dh2ixnPVXSbHV/uLjnlNxe1nBIvQuhLF9Pq0aTZdOkXTKL8LyxXstf6TXOhc0AGa28OcD1k2SH79WOqnJ5bsbK+EhfMXj/R8mTwLOyds9+XyHnpFrIIg4xWPDBwL2qCIawEQeT10jhOiuWW6CvOApFAPv7iN7m3XIbhWjiaHmmA= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1669035484299700.3829782952914; Mon, 21 Nov 2022 04:58:04 -0800 (PST) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-643-bgsHCn5-NxqydGq4Buwoxg-1; Mon, 21 Nov 2022 07:57:16 -0500 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 0BB80101E153; Mon, 21 Nov 2022 12:57:14 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id E86A2C15BBC; Mon, 21 Nov 2022 12:57:13 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id F3511194658C; Mon, 21 Nov 2022 12:57:12 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 20B6F19465B5 for ; Mon, 21 Nov 2022 12:57:11 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id F349D40C6E13; Mon, 21 Nov 2022 12:57:10 +0000 (UTC) Received: from speedmetal.redhat.com (ovpn-208-20.brq.redhat.com [10.40.208.20]) by smtp.corp.redhat.com (Postfix) with ESMTP id 70D5840C6EC2 for ; Mon, 21 Nov 2022 12:57:10 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1669035483; h=from:from:sender:sender: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:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=cAkLMTiNQh3XvPmudxe2itN9czXLuyl1G/Q1qf0vHbY=; b=XoD1beaD55epw7kamj1g3lUm++mwQXHff6CDhuYSR35npUSJBL5cFNcbXPlrgnnm/3pcHW mOnmq1lECx2m2e4eqjghGfkoatt7CniHS9ENWyFoy9abyWMBfpDllpXXGaq634ndd/jnxW v8ZW8fe+K1dq1Q1zfIbwGn+7rq+e4uw= X-MC-Unique: bgsHCn5-NxqydGq4Buwoxg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 1/3] docs: drvqemu: Fix and improve docs about device override types Date: Mon, 21 Nov 2022 13:57:06 +0100 Message-Id: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.2 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.8 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1669035484505100002 Content-Type: text/plain; charset="utf-8" The 'number' override type didn't exist in the final version so change it to the corresponding 'signed' and 'unsigned'. Additionally clarify which override type is used for a corresponding qemu type and also that we use base 10 numbers so users will need to convert the numbers if needed. Signed-off-by: Peter Krempa --- docs/drvqemu.rst | 34 ++++++++++++++++++++++++++++++---- 1 file changed, 30 insertions(+), 4 deletions(-) diff --git a/docs/drvqemu.rst b/docs/drvqemu.rst index 7ee11e9deb..7bfb28ea9c 100644 --- a/docs/drvqemu.rst +++ b/docs/drvqemu.rst @@ -688,10 +688,36 @@ The individual properties are overridden by a ```` element. The ``name`` specifies the name of the property to override. In case when libv= irt doesn't configure the property a property with the name is added to the commandline. The ``type`` attribute specifies a type of the argument used.= The -type must correspond with the type that is expected by QEMU. Supported val= ues -for the type attribute are: ``string``, ``number``, ``bool`` (allowed valu= es for -``bool`` are ``true`` and ``false``) and ``remove``. The ``remove`` type is -special and instructs libvirt to remove the property without replacement. +type must correspond semantically (e.g use a numeric type when qemu expect= s a +number) with the type that is expected by QEMU. Supported values for the `= `type`` +attribute are: + + ``string`` + Used to override ``qemu`` properties of ``str`` type as well as any + enumeration type (e.g. ``OnOffAuto`` in which case the value can be on= e of + ``on``, ``off``, or ``auto``). + + ``unsigned`` + Used to override numeric properties with an non-negative value. Note t= hat + this can be used to also override signed values in qemu. + + Used for any numeric type of a ``qemu`` property such as ``uint32``, + ``int32``, ``size``, etc. + + The value is interpreted as a base 10 number, make sure to convert num= bers + if needed. + + ``signed`` + Same semantics as ``unsigned`` above but used when a negative value is + needed. + + ``bool`` + Used to override ``qemu`` properties of ``bool`` type. Allowed values = for + are ``true`` and ``false``. + + ``remove``. + The ``remove`` type is special and instructs libvirt to remove the pro= perty + without replacement. The overrides are applied only to initial device configuration passed to Q= EMU via the commandline. Later hotplug operations will not apply any modificat= ions. --=20 2.37.3