From a96d1c90832b639c81f6cd893a79610d4379594d Mon Sep 17 00:00:00 2001 Message-ID: From: Peter Krempa Date: Mon, 7 Apr 2025 13:35:37 +0200 Subject: [PATCH] libvirt-host: Clarify/fix description of the CPU frequency field The 'virNodeInfo' field for CPU frequency is named 'mhz'. The docs were mentioning 'mHZ', which is neither the field name nor proper spelling of the unit. Reword the paragraph to mention "CPU frequency" instead and explicitly name the field in virNodeInfo struct. Signed-off-by: Peter Krempa Reviewed-by: Michal Privoznik (cherry picked from commit e54cc1500ccfb36cd5b67eb4d886c491fdda5b2b) https://issues.redhat.com/browse/RHEL-86197 --- src/libvirt-host.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/libvirt-host.c b/src/libvirt-host.c index b3a6421a7f..318a664d24 100644 --- a/src/libvirt-host.c +++ b/src/libvirt-host.c @@ -410,9 +410,9 @@ virConnectGetMaxVcpus(virConnectPtr conn, * Use of this API is strongly discouraged as the information provided * is not guaranteed to be accurate on all hardware platforms. * - * The mHZ value merely reflects the speed that the first CPU in the - * machine is currently running at. This speed may vary across CPUs - * and changes continually as the host OS throttles. + * The CPU frequency value (field 'mhz' in virNodeInfo) merely reflects the + * speed that the first CPU in the machine is currently running at. This speed + * may vary across CPUs and changes continually as the host OS throttles. * * The nodes/sockets/cores/threads data is potentially inaccurate as * it assumes a symmetric installation. If one NUMA node has more @@ -420,7 +420,7 @@ virConnectGetMaxVcpus(virConnectPtr conn, * wrong. It is also not able to report about CPU dies. * * Applications are recommended to use the virConnectGetCapabilities() - * call instead, which provides all the information except CPU mHZ, + * call instead, which provides all the information except CPU frequency, * in a more accurate representation. * * Returns 0 in case of success and -1 in case of failure. -- 2.49.0