[PATCH] docs: Reword virDomainGetEmulatorPinInfo description

This API only queries the XML settings and not the running threads themselves. In order to avoid confusion, change the wording slightly. Resolves: https://issues.redhat.com/browse/RHEL-72052 Signed-off-by: Martin Kletzander <mkletzan@redhat.com> --- src/libvirt-domain.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c index e8e5379672ae..275d65b8c16b 100644 --- a/src/libvirt-domain.c +++ b/src/libvirt-domain.c @@ -7998,8 +7998,8 @@ virDomainPinEmulator(virDomainPtr domain, unsigned char *cpumap, * Must not be VIR_DOMAIN_AFFECT_LIVE and * VIR_DOMAIN_AFFECT_CONFIG concurrently. * - * Query the CPU affinity setting of all emulator threads of domain, store - * it in cpumap. + * Query the CPU pinning setting of all emulator threads from the domain XML, + * store it in cpumap. * * Returns 1 in case of success, * 0 in case of no emulator threads are pined to pcpus, -- 2.48.0

On 1/13/25 15:48, Martin Kletzander wrote:
This API only queries the XML settings and not the running threads themselves. In order to avoid confusion, change the wording slightly.
Resolves: https://issues.redhat.com/browse/RHEL-72052 Signed-off-by: Martin Kletzander <mkletzan@redhat.com> --- src/libvirt-domain.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c index e8e5379672ae..275d65b8c16b 100644 --- a/src/libvirt-domain.c +++ b/src/libvirt-domain.c @@ -7998,8 +7998,8 @@ virDomainPinEmulator(virDomainPtr domain, unsigned char *cpumap, * Must not be VIR_DOMAIN_AFFECT_LIVE and * VIR_DOMAIN_AFFECT_CONFIG concurrently. * - * Query the CPU affinity setting of all emulator threads of domain, store - * it in cpumap. + * Query the CPU pinning setting of all emulator threads from the domain XML, + * store it in cpumap.
We can take the opportunity and make this "@cpumap" which also makes our docs renderer to render it as <code>cpumap</code>. Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Michal
participants (2)
-
Martin Kletzander
-
Michal Prívozník