[libvirt PATCH 0/4] Some documentation fixes

I encountered some references to a cpu_map.xml file which was moved to a subdirectory in commit 3ecbac95cd and split up in to different files in 2c127947ae and e6d7be38b9. This series removes all remaining references to this file and fixes an unrelated minor issue in the description of the "feature" element in the section about "cpu". Tim Wiederhake (4): tests: Remove references to "cpu_map.xml" in the code qemu: Remove references to "cpu_map.xml" in the code docs: Remove references to "cpu_map.xml" in the documentation doc: Fix element name in description of "feature" docs/formatdomain.rst | 14 +++++++------- src/qemu/qemu_capabilities.c | 2 +- tests/cputest.c | 4 ++-- 3 files changed, 10 insertions(+), 10 deletions(-) -- 2.26.2

"cpu_map.xml" was moved to a directory "cpu_map" and split up into several files. Signed-off-by: Tim Wiederhake <twiederh@redhat.com> --- tests/cputest.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/cputest.c b/tests/cputest.c index bf5ce84aa7..87ad5825b8 100644 --- a/tests/cputest.c +++ b/tests/cputest.c @@ -817,8 +817,8 @@ cpuTestUpdateLive(const void *arg) if (!(expected = cpuTestLoadXML(data->arch, expectedFile))) goto cleanup; - /* In case the host CPU signature does not exactly match any CPU model from - * cpu_map.xml, the CPU model we detect from CPUID may differ from the one + /* In case the host CPU signature does not exactly match any CPU model in + * src/cpu_map, the CPU model we detect from CPUID may differ from the one * we compute by asking QEMU. Since this test expands both CPU models and * compares their features, we can try to translate the 'actual' CPU to * use the CPU model from 'expected'. -- 2.26.2

"cpu_map.xml" was moved to a directory "cpu_map" and split up into several files. Signed-off-by: Tim Wiederhake <twiederh@redhat.com> --- src/qemu/qemu_capabilities.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/qemu/qemu_capabilities.c b/src/qemu/qemu_capabilities.c index 38b901a6c4..02136fd3b3 100644 --- a/src/qemu/qemu_capabilities.c +++ b/src/qemu/qemu_capabilities.c @@ -3072,7 +3072,7 @@ virQEMUCapsProbeQMPHostCPU(virQEMUCapsPtr qemuCaps, cpu->model = g_strdup(model); - /* Some x86_64 features defined in cpu_map.xml use spelling which differ + /* Some x86_64 features defined in src/cpu_map/ use spelling which differ * from the one preferred by QEMU. Static expansion would give us only the * preferred spelling. With new QEMU we always use the QEMU's canonical * names of all features and translate between them and our names. But for -- 2.26.2

"cpu_map.xml" was moved to a directory "cpu_map" and split up into several files. Signed-off-by: Tim Wiederhake <twiederh@redhat.com> --- docs/formatdomain.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index cc4f91d4ea..0ffb1b7196 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -1361,7 +1361,7 @@ In case no restrictions need to be put on CPU model and its features, a simpler ``model`` The content of the ``model`` element specifies CPU model requested by the guest. The list of available CPU models and their definition can be found in - ``cpu_map.xml`` file installed in libvirt's data directory. If a hypervisor + directory ``cpu_map``, installed in libvirt's data directory. If a hypervisor is not able to use the exact CPU model, libvirt automatically falls back to a closest model supported by the hypervisor while maintaining the list of CPU features. :since:`Since 0.9.10` , an optional ``fallback`` attribute can be @@ -1376,7 +1376,7 @@ In case no restrictions need to be put on CPU model and its features, a simpler :since:`Since 0.8.3` the content of the ``vendor`` element specifies CPU vendor requested by the guest. If this element is missing, the guest can be run on a CPU matching given features regardless on its vendor. The list of - supported vendors can be found in ``cpu_map.xml``. + supported vendors can be found in ``cpu_map/*_vendors.xml``. ``topology`` The ``topology`` element specifies requested topology of virtual CPU provided to the guest. Four attributes, ``sockets``, ``dies``, ``cores``, and -- 2.26.2

Actual change is "s/``elements``/``feature`` elements/", rest is reflow. Signed-off-by: Tim Wiederhake <twiederh@redhat.com> --- docs/formatdomain.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 0ffb1b7196..df5ac28028 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -1388,11 +1388,11 @@ In case no restrictions need to be put on CPU model and its features, a simpler of vCPUs specified by the ``cpus`` element equals to the number of vcpus resulting from the topology. ``feature`` - The ``cpu`` element can contain zero or more ``elements`` used to fine-tune - features provided by the selected CPU model. The list of known feature names - can be found in the same file as CPU models. The meaning of each ``feature`` - element depends on its ``policy`` attribute, which has to be set to one of - the following values: + The ``cpu`` element can contain zero or more ``feature`` elements used to + fine-tune features provided by the selected CPU model. The list of known + feature names can be found in the same file as CPU models. The meaning of + each ``feature`` element depends on its ``policy`` attribute, which has to be + set to one of the following values: ``force`` The virtual CPU will claim the feature is supported regardless of it being -- 2.26.2

On Fri, Oct 09, 2020 at 12:47:16 +0200, Tim Wiederhake wrote:
I encountered some references to a cpu_map.xml file which was moved to a subdirectory in commit 3ecbac95cd and split up in to different files in 2c127947ae and e6d7be38b9. This series removes all remaining references to this file and fixes an unrelated minor issue in the description of the "feature" element in the section about "cpu".
Tim Wiederhake (4): tests: Remove references to "cpu_map.xml" in the code qemu: Remove references to "cpu_map.xml" in the code docs: Remove references to "cpu_map.xml" in the documentation doc: Fix element name in description of "feature"
docs/formatdomain.rst | 14 +++++++------- src/qemu/qemu_capabilities.c | 2 +- tests/cputest.c | 4 ++-- 3 files changed, 10 insertions(+), 10 deletions(-)
-- 2.26.2
Reviewed-by: Jiri Denemark <jdenemar@redhat.com> and pushed, thanks.
participants (2)
-
Jiri Denemark
-
Tim Wiederhake