8d2da0bba7
- qemu_firmware: Drop support for kernel descriptors (RHEL-82645) - qemu_firmware: Drop 'nvram' local variable (RHEL-82645) - qemu_firmware: Move format=raw compat exception (RHEL-82645) - qemu_firmware: Move copying of nvram.format to loader.format (RHEL-82645) - tests: Add firmware-manual-efi-rw-nvram (RHEL-82645) - domain_validate: Reject NVRAM with read/write firmware (RHEL-82645) - tests: Add firmware-auto-bios-rw (RHEL-82645) - tests: Add firmware-manual-bios-rw (RHEL-82645) - domain_validate: Reject read/write ROMs (RHEL-82645) - tests: Add firmware-auto-efi-format-loader-qcow2-rom (RHEL-82645) - domain_validate: Reject ROMs with format other than raw (RHEL-82645) - qemu_firmware: Ignore stateless/combined when NVRAM is configured (RHEL-82645) - qemu_firmware: Drop fallback for absent nvramTemplateFormat (RHEL-82645) - schemas: Allow templateFormat without template path (RHEL-82645) - tests: Add firmware-manual-efi-nvram-template-nonstandard-format (RHEL-82645) - tests: Add firmware-manual-efi-nvram-template-nonstandard-legacy-paths (RHEL-82645) - tests: Add firmware-auto-efi-format-nvram-raw (RHEL-82645) - tests: Add firmware-auto-efi-format-nvram-raw-loader-path (RHEL-82645) - tests: Add firmware-auto-efi-format-nvram-raw-nvramtemplate-path (RHEL-82645) - tests: Add firmware-auto-efi-format-nvramtemplate-qcow2 (RHEL-82645) - tests: Add firmware-auto-efi-format-mismatch-nvramtemplate (RHEL-82645) - qemu_firmware: Introduce qemuFirmwareFillDomainCustom() (RHEL-82645) - qemu_firmware: Set templateFormat for custom paths (RHEL-82645) - qemu_firmware: Simplify handling of legacy paths (RHEL-82645) - qemu_firmware: Refactor setting NVRAM format (RHEL-82645) - qemu_firmware: Prefer template format to loader format (RHEL-82645) - qemu_firmware: Retain user-specified NVRAM format (RHEL-82645) - qemu_firmware: Take templateFormat into account when matching (RHEL-82645) - qemu_firmware: Take NVRAM format into account when matching (RHEL-82645) - qemu_firmware: Remove NVRAM to loader format copy hack (RHEL-82645) - tests: Add firmware-manual-efi-sev-snp (RHEL-82645) - tests: Add firmware-manual-efi-tdx (RHEL-82645) - qemu_firmware: ROM firmware is always in raw format (RHEL-82645) - qemu_firmware: Don't skip autoselection for ROM (RHEL-82645) - qemu_firmware: Allow matching both UEFI and BIOS for ROM loader (RHEL-82645) - schema: Add firmwareFeatures element for domaincaps (RHEL-82645) - conf: Add firmwareFeatures element for domaincaps (RHEL-82645) - qemu: Fill in firmwareFeature element for domaincaps (RHEL-82645) - docs: Document firmwareFeature element for domaincaps (RHEL-82645) - docs: Rename "BIOS bootloader" section to "guest firmware" (RHEL-82645) - docs: Improvement related to firmware selection (RHEL-82645) - qemu_firmware: Only set format for custom loader if path is present (RHEL-82645) - conf: Move type=rom default for loader to drivers (RHEL-82645) - tests: Rename custom JSON firmware descriptors (RHEL-82645) - schema: Introduce osnvram define (RHEL-82645) - conf: Parse and format varstore element (RHEL-82645) - conf: Update validation to consider varstore element (RHEL-82645) - qemu_capabilities: Introduce QEMU_CAPS_DEVICE_UEFI_VARS (RHEL-82645) - qemu: Validate presence of uefi-vars device (RHEL-82645) - tests: Add firmware-manual-efi-varstore-q35 (RHEL-82645) - tests: Add firmware-manual-efi-varstore-aarch64 (RHEL-82645) - tests: Add firmware-auto-efi-varstore-q35 (RHEL-82645) - tests: Add firmware-auto-efi-varstore-aarch64 (RHEL-82645) - tests: Add firmware-auto-efi-enrolled-keys-aarch64 (RHEL-82645) - qemu_firmware: Parse host-uefi-vars firmware feature (RHEL-82645) - qemu_firmware: Split sanity check (RHEL-82645) - qemu_firmware: Consider host-uefi-vars feature in sanity check (RHEL-82645) - qemu_firmware: Support extended syntax for ROM firmware descriptors (RHEL-82645) - qemu_firmware: Report NVRAM template path for ROMs (RHEL-82645) - conf: Include varstore element in domcaps (RHEL-82645) - qemu: Fill in varstore element in domcaps (RHEL-82645) - qemu_firmware: Use of NVRAM implies stateful firmware (RHEL-82645) - qemu_firmware: Allow matching stateful ROMs (RHEL-82645) - qemu_firmware: Fill in varstore information (RHEL-82645) - qemu: Introduce varstoreDir (RHEL-82645) - qemu_firmware: Generate varstore path when necessary (RHEL-82645) - qemu: Introduce qemuPrepareNVRAMFileCommon() (RHEL-82645) - qemu: Create and delete varstore file (RHEL-82645) - security: Mark ROMs as read only when using AppArmor (RHEL-82645) - security: Handle varstore file (RHEL-82645) - tests: Add firmware descriptors for uefi-vars builds (RHEL-82645) - qemu_command: Use uefi-vars device where appropriate (RHEL-82645) - include: Mention varstore where applicable (RHEL-82645) - virsh: Update for varstore handling (RHEL-82645) - domain_conf: initialize network hostdev private data (RHEL-151916) - qemu_hotplug: enter monitor in order to rollback passed FD (RHEL-151916) Resolves: RHEL-151916, RHEL-82645
160 lines
6.5 KiB
Diff
160 lines
6.5 KiB
Diff
From 807dfc5b7ce3d77d7343b896082d2ae3395b3fdc Mon Sep 17 00:00:00 2001
|
|
Message-ID: <807dfc5b7ce3d77d7343b896082d2ae3395b3fdc.1772815313.git.jdenemar@redhat.com>
|
|
From: Andrea Bolognani <abologna@redhat.com>
|
|
Date: Mon, 23 Feb 2026 14:55:20 +0100
|
|
Subject: [PATCH] docs: Rename "BIOS bootloader" section to "guest firmware"
|
|
MIME-Version: 1.0
|
|
Content-Type: text/plain; charset=UTF-8
|
|
Content-Transfer-Encoding: 8bit
|
|
|
|
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 <abologna@redhat.com>
|
|
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
|
|
Acked-by: Gerd Hoffmann <kraxel@redhat.com>
|
|
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
|
|
(cherry picked from commit 38379f59c0d26d006414a1fd92bdf332dadd1ddd)
|
|
|
|
https://issues.redhat.com/browse/RHEL-82645
|
|
|
|
Signed-off-by: Andrea Bolognani <abologna@redhat.com>
|
|
---
|
|
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 ``<guest/>`` element will typically wrap up the following elements:
|
|
Emulator (device model) path, for use in
|
|
`emulator <formatdomain.html#devices>`__ element of domain XML.
|
|
``loader``
|
|
- Loader path, for use in `loader <formatdomain.html#bios-bootloader>`__
|
|
+ Loader path, for use in `loader <formatdomain.html#guest-firmware>`__
|
|
element of domain XML.
|
|
``machine``
|
|
Machine type, for use in
|
|
diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
|
|
index 31232deb3c..152fd7f530 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 their
|
|
own pros and cons.
|
|
|
|
+Guest firmware
|
|
+~~~~~~~~~~~~~~
|
|
|
|
-BIOS bootloader
|
|
-~~~~~~~~~~~~~~~
|
|
+.. container::
|
|
+ :name: bios-bootloader
|
|
|
|
-Booting via the BIOS is available for hypervisors supporting full
|
|
-virtualization. In this case the BIOS has a boot order priority (floppy,
|
|
+ .. this container only exists to keep old links working
|
|
+
|
|
+Booting via a guest firmware is available for hypervisors supporting full
|
|
+virtualization. In this case the firmware has a boot order priority (floppy,
|
|
harddisk, cdrom, network) determining where to obtain/find the boot image.
|
|
|
|
::
|
|
@@ -411,10 +415,10 @@ and full virtualized guests.
|
|
|
|
``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 kernel
|
|
image in the host OS.
|
|
@@ -3732,7 +3736,7 @@ paravirtualized driver is specified via the ``disk`` element.
|
|
attribute is an 8 character string which can be queried by guests on S390 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
|
|
@@ -4897,7 +4901,7 @@ or:
|
|
Specifies that the device is bootable. The ``order`` attribute determines the
|
|
order in which devices will be tried during boot sequence. The per-device
|
|
``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 presented to
|
|
@@ -5121,7 +5125,7 @@ USB device redirection through a character device is supported
|
|
Specifies that the device is bootable. The ``order`` attribute determines the
|
|
order in which devices will be tried during boot sequence. The per-device
|
|
``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 filter
|
|
out certain devices from redirection. It uses sub-element ``<usbdev>`` to
|
|
@@ -6377,7 +6381,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 devices 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`
|
|
|
|
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 <formatdomain.html#element-and-attribute-overview>`__ (or so
|
|
called domain type).
|
|
``machine``
|
|
- The domain's `machine type <formatdomain.html#bios-bootloader>`__. Since not
|
|
+ The domain's `machine type <formatdomain.html#guest-firmware>`__. Since not
|
|
every hypervisor has a sense of machine types this element might be omitted
|
|
in such drivers.
|
|
``arch``
|
|
- The domain's `architecture <formatdomain.html#bios-bootloader>`__.
|
|
+ The domain's `architecture <formatdomain.html#guest-firmware>`__.
|
|
|
|
CPU Allocation
|
|
~~~~~~~~~~~~~~
|
|
@@ -95,12 +95,17 @@ capabilities, e.g. virtual CPUs:
|
|
``vcpu``
|
|
The maximum number of supported virtual CPUs
|
|
|
|
-BIOS bootloader
|
|
-~~~~~~~~~~~~~~~
|
|
+Guest firmware
|
|
+~~~~~~~~~~~~~~
|
|
|
|
-Sometimes users might want to tweak some BIOS knobs or use UEFI. For cases like
|
|
-that, `os <formatdomain.html#bios-bootloader>`__ element exposes what values can
|
|
-be passed to its children.
|
|
+.. container::
|
|
+ :name: bios-bootloader
|
|
+
|
|
+ .. this container only exists to keep old links working
|
|
+
|
|
+Exposes information about supported
|
|
+`guest firmware <formatdomain.html#guest-firmware>`__ configurations for
|
|
+domains.
|
|
|
|
::
|
|
|
|
--
|
|
2.53.0
|