]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: Clarify free_page_reporting attribute
authorMichal Privoznik <mprivozn@redhat.com>
Wed, 14 Oct 2020 14:46:18 +0000 (16:46 +0200)
committerMichal Privoznik <mprivozn@redhat.com>
Thu, 15 Oct 2020 08:57:33 +0000 (10:57 +0200)
The 'reporting' suffix of the attribute makes it sound like we
could be reporting something to user. While in fact, this is
purely virtio membaloon <-> QEMU business. Clarify the docs to
make it clear.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
docs/formatdomain.rst

index a18222662faed4132ae2fffaff43dcd7a03c2732..bfa80e4bc2a03beaf621eb9f8a64a19e003f9065 100644 (file)
@@ -6759,7 +6759,9 @@ Example: manually added device with static PCI slot 2 requested
    The optional ``freePageReporting`` attribute allows to enable/disable
    ("on"/"off", respectively) the ability of the QEMU virtio memory balloon to
    return unused pages back to the hypervisor to be used by other guests or
-   processes. :since:`Since 6.9.0, QEMU and KVM only`
+   processes. Please note that despite its name it has no effect on free memory
+   as reported by ``virDomainMemoryStats()`` and/or ``virsh dommemstat``.
+   :since:`Since 6.9.0, QEMU and KVM only`
 
 ``period``
    The optional ``period`` allows the QEMU virtio memory balloon driver to