From nobody Tue Mar 3 04:52:36 2026 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=1771871635; cv=none; d=zohomail.com; s=zohoarc; b=NflWCMZ+m7JYMwLzXBuO88h8D5+VqU0T5+AsOtA8tDxtXeMcICfc48xv+Xawszgl5/LiROeDbtCy4n5UuMT21Kv0Fnoa6uKuKyDvkqExua0aKXXRrnba7C3sOPy0uDKJV538KbLSjt0vaaHohKOfRD/1g1Mja+N9OPgNVTDF7bc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1771871635; h=Content-Type:Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Owner: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=j79ctdmpjUFEnPmL44ONQZsdVrE1ECbmbQg3CWFI6LM=; b=RXnygiUZn3KFYVaz6/hdci4nfG90vOpffXO3dtl1RyNyZRQp19RmdDx38tmKKlWLHUM6mTGTZN9o20EYWvi/kD9nmbJuuUHGR44JbUQ9aqi7SAi/L4S0NRLsm/2hU3yJjGSay6HLxnFNCH9t5A5dAOeNcOUI50teKDKc/n/GvW0= 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 1771871635123561.0806111964891; Mon, 23 Feb 2026 10:33:55 -0800 (PST) Received: by lists.libvirt.org (Postfix, from userid 993) id 4D40F41B3F; Mon, 23 Feb 2026 13:33:54 -0500 (EST) Received: from [172.19.199.9] (lists.libvirt.org [8.43.85.245]) by lists.libvirt.org (Postfix) with ESMTP id B46D641BB5; Mon, 23 Feb 2026 13:31:35 -0500 (EST) Received: by lists.libvirt.org (Postfix, from userid 993) id EC5B2419C7; Mon, 23 Feb 2026 13:31:30 -0500 (EST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (3072 bits) server-digest SHA256) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 60FFC419C0 for ; Mon, 23 Feb 2026 13:31:30 -0500 (EST) Received: from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-94-AlIoh8ZIMS6pMcMJ_d2jRg-1; Mon, 23 Feb 2026 13:31:28 -0500 Received: from mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.17]) (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-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 848661956075 for ; Mon, 23 Feb 2026 18:31:27 +0000 (UTC) Received: from kinshicho.usersys.redhat.com (unknown [10.44.32.20]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 9C1241955D71 for ; Mon, 23 Feb 2026 18:31:26 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 4.0.1 (2024-03-26) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HELO_MISC_IP,MAILING_LIST_MULTI,RCVD_IN_DNSWL_MED, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_PASS autolearn=unavailable autolearn_force=no version=4.0.1 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1771871490; 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=j79ctdmpjUFEnPmL44ONQZsdVrE1ECbmbQg3CWFI6LM=; b=bsp4Wn87b0uATguRIv58DT5RqpTkfQq4b869mJopDKAujynqAqCr1u71XUBD5zhb8SXEto l+bArhS1/sH86unjKlkJaI0p7szoqOJYWgSAhBGwYHW+fv8olspQeoGQi4BmOW2dSyqJ/D TFb2bFGV7l6jcqoF9wJpkjVI2eRyquU= X-MC-Unique: AlIoh8ZIMS6pMcMJ_d2jRg-1 X-Mimecast-MFC-AGG-ID: AlIoh8ZIMS6pMcMJ_d2jRg_1771871487 To: devel@lists.libvirt.org Subject: [PATCH v4 01/36] docs: Rename "BIOS bootloader" section to "guest firmware" Date: Mon, 23 Feb 2026 19:30:44 +0100 Message-ID: <20260223183119.501349-2-abologna@redhat.com> In-Reply-To: <20260223183119.501349-1-abologna@redhat.com> References: <20260223183119.501349-1-abologna@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.17 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: anVCaKrOz2AbXv8dxuQj8SYTodQ-8FM8O-H79rrKlRU_1771871487 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: VYVS3SBUNPEPJJUZ3OGF3LN4HZ2MKDZ2 X-Message-ID-Hash: VYVS3SBUNPEPJJUZ3OGF3LN4HZ2MKDZ2 X-MailFrom: abologna@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; header-match-devel.lists.libvirt.org-0; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: From: Andrea Bolognani via Devel Reply-To: Andrea Bolognani X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1771871635993158500 Content-Type: text/plain; charset="utf-8"; x-default="true" The new name is much more accurate since the documentation is applicable to firmware other than BIOS, notably UEFI. An empty container is used to keep old links working. Signed-off-by: Andrea Bolognani Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/formatcaps.rst | 2 +- docs/formatdomain.rst | 24 ++++++++++++++---------- docs/formatdomaincaps.rst | 19 ++++++++++++------- 3 files changed, 27 insertions(+), 18 deletions(-) diff --git a/docs/formatcaps.rst b/docs/formatcaps.rst index fa8ab5197f..9458e1289a 100644 --- a/docs/formatcaps.rst +++ b/docs/formatcaps.rst @@ -172,7 +172,7 @@ The ```` element will typically wrap up the fol= lowing elements: Emulator (device model) path, for use in `emulator `__ element of domain XML. ``loader`` - Loader path, for use in `loader `= __ + Loader path, for use in `loader `__ element of domain XML. ``machine`` Machine type, for use in diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 82788c15a2..db664857af 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -103,12 +103,16 @@ Operating system booting There are a number of different ways to boot virtual machines each with th= eir own pros and cons. =20 +Guest firmware +~~~~~~~~~~~~~~ =20 -BIOS bootloader -~~~~~~~~~~~~~~~ +.. container:: + :name: bios-bootloader + + .. this container only exists to keep old links working =20 -Booting via the BIOS is available for hypervisors supporting full -virtualization. In this case the BIOS has a boot order priority (floppy, +Booting via a guest firmware is available for hypervisors supporting full +virtualization. In this case the firmware has a boot order priority (flopp= y, harddisk, cdrom, network) determining where to obtain/find the boot image. =20 :: @@ -411,10 +415,10 @@ and full virtualized guests. =20 ``type`` This element has the same semantics as described earlier in the - `BIOS bootloader`_ section. + `guest firmware`_ section. ``loader`` This element has the same semantics as described earlier in the - `BIOS bootloader`_ section. + `guest firmware`_ section. ``kernel`` The contents of this element specify the fully-qualified path to the ke= rnel image in the host OS. @@ -3752,7 +3756,7 @@ paravirtualized driver is specified via the ``disk`` = element. attribute is an 8 character string which can be queried by guests on S3= 90 via sclp or diag 308. Linux guests on S390 can use ``loadparm`` to select a= boot entry. :since:`Since 3.5.0` The per-device ``boot`` elements cannot be = used - together with general boot elements in `BIOS bootloader`_ + together with general boot elements in `guest firmware`_ section. :since:`Since 0.8.8` ``encryption`` since:`Since 3.9.0` the ``encryption`` element is preferred @@ -4917,7 +4921,7 @@ or: Specifies that the device is bootable. The ``order`` attribute determin= es the order in which devices will be tried during boot sequence. The per-devi= ce ``boot`` elements cannot be used together with general boot elements in - `BIOS bootloader`_ section. :since:`Since 0.8.8` for PCI + `guest firmware`_ section. :since:`Since 0.8.8` for PCI devices, :since:`Since 1.0.1` for USB devices. ``rom`` The ``rom`` element is used to change how a PCI device's ROM is present= ed to @@ -5144,7 +5148,7 @@ USB device redirection through a character device is = supported Specifies that the device is bootable. The ``order`` attribute determin= es the order in which devices will be tried during boot sequence. The per-devi= ce ``boot`` elements cannot be used together with general boot elements in - `BIOS bootloader`_ section. ( :since:`Since 1.0.1` ) + `guest firmware`_ section. ( :since:`Since 1.0.1` ) ``redirfilter`` The\ ``redirfilter``\ element is used for creating the filter rule to f= ilter out certain devices from redirection. It uses sub-element ```` = to @@ -6400,7 +6404,7 @@ Specifying boot order For hypervisors which support this, you can set a specific NIC to be used = for network boot. The ``order`` attribute determines the order in which device= s will be tried during boot sequence. The per-device ``boot`` elements cannot be = used -together with general boot elements in `BIOS bootloader`_ +together with general boot elements in `guest firmware`_ section. :since:`Since 0.8.8` =20 Interface ROM BIOS configuration diff --git a/docs/formatdomaincaps.rst b/docs/formatdomaincaps.rst index cca827923c..22a6d5d067 100644 --- a/docs/formatdomaincaps.rst +++ b/docs/formatdomaincaps.rst @@ -72,11 +72,11 @@ The root element that emulator capability XML document = starts with has name Describes the `virtualization type `__ (or so called domain type). ``machine`` - The domain's `machine type `__. Sinc= e not + The domain's `machine type `__. Since= not every hypervisor has a sense of machine types this element might be omi= tted in such drivers. ``arch`` - The domain's `architecture `__. + The domain's `architecture `__. =20 CPU Allocation ~~~~~~~~~~~~~~ @@ -95,12 +95,17 @@ capabilities, e.g. virtual CPUs: ``vcpu`` The maximum number of supported virtual CPUs =20 -BIOS bootloader -~~~~~~~~~~~~~~~ +Guest firmware +~~~~~~~~~~~~~~ + +.. container:: + :name: bios-bootloader + + .. this container only exists to keep old links working =20 -Sometimes users might want to tweak some BIOS knobs or use UEFI. For cases= like -that, `os `__ element exposes what valu= es can -be passed to its children. +Exposes information about supported +`guest firmware `__ configurations for +domains. =20 :: =20 --=20 2.53.0