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@xxxxxxxxxx>
---
docs/formatdomain.rst | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 5ec765ad3d..7abcb9d773 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -6759,7 +6759,9 @@ Example: manually added device with static PCI slot 2 requested
The optional ``free_page_reporting`` 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
--
2.26.2
