On Thu, Jul 03, 2025 at 17:24:54 +0200, Hector CAO wrote:
From: Hector Cao <hector.cao(a)canonical.com>
Add documentation on the way libvirt displays the Host CPU
model and capabilities (features). There is an implicit
expection from users to get the CPU model name matching the
CPU model they are running on, however, this does not happen
most of the time. As a consequence, having a documentation
is useful both for users to align their expectation and for
us to point to a place where the situation is clearly explained.
Signed-off-by: Hector Cao <hector.cao(a)canonical.com>
---
docs/formatcaps.rst | 43 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 43 insertions(+)
diff --git a/docs/formatcaps.rst b/docs/formatcaps.rst
index 7e525487e7..bb2284471c 100644
--- a/docs/formatcaps.rst
+++ b/docs/formatcaps.rst
@@ -371,3 +371,46 @@ capabilities enabled in the chip and BIOS you will see:
</guest>
</capabilities>
+
+Host CPU model and features
+~~~~~~~~~~~~~~~~~
+
+As described in the (`Host capabilities`_) section, libvirt exposes to users the list of
Host CPU features. Libvirt has a special way to expose this list: Instead of providing the
full - and thereby often very long - set of features, libvirt specifies a CPU model name
as baseline and additional features on top of it.
Note that 'formatcaps.rst' as well as other documents (or at least the
prose paragraphs in those files) are linebroken at 80 columns, so please
make sure that your additions do the same.