[PATCH 3/3] docs: Clarify values reported by virDomainMemoryStats()

Michal Privoznik posted 3 patches 1 year ago
[PATCH 3/3] docs: Clarify values reported by virDomainMemoryStats()
Posted by Michal Privoznik 1 year ago
I was approached by a KubeVirt developer to clarify what value
does VIR_DOMAIN_MEMORY_STAT_DISK_CACHES report, whether it's from
the guest or the host POV. And since I didn't know the answer
even after reading the docs I think we can do better. Clarify the
POV then.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
---
 include/libvirt/libvirt-domain.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h
index 3312b8339e..20467849a4 100644
--- a/include/libvirt/libvirt-domain.h
+++ b/include/libvirt/libvirt-domain.h
@@ -709,7 +709,8 @@ typedef virDomainInterfaceStatsStruct *virDomainInterfaceStatsPtr;
 /**
  * virDomainMemoryStatTags:
  *
- * Memory Statistics Tags:
+ * These represent values from inside of the guest (e.g. the same value would
+ * be read from '/proc/meminfo' and/or other files from inside the guest).
  *
  * Since: 0.7.5
  */
-- 
2.39.3
Re: [PATCH 3/3] docs: Clarify values reported by virDomainMemoryStats()
Posted by Peter Krempa 1 year ago
On Wed, May 24, 2023 at 18:21:07 +0200, Michal Privoznik wrote:
> I was approached by a KubeVirt developer to clarify what value
> does VIR_DOMAIN_MEMORY_STAT_DISK_CACHES report, whether it's from
> the guest or the host POV. And since I didn't know the answer
> even after reading the docs I think we can do better. Clarify the
> POV then.
> 
> Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
> ---
>  include/libvirt/libvirt-domain.h | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)


Reviewed-by: Peter Krempa <pkrempa@redhat.com>