]> xenbits.xensource.com Git - libvirt.git/commitdiff
docs: Clarify values reported by virDomainMemoryStats()
authorMichal Privoznik <mprivozn@redhat.com>
Wed, 24 May 2023 08:53:03 +0000 (10:53 +0200)
committerMichal Privoznik <mprivozn@redhat.com>
Thu, 25 May 2023 12:23:07 +0000 (14:23 +0200)
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>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
include/libvirt/libvirt-domain.h

index 3312b8339e4bd0bd1a31faa7d6c43853bad55cf2..20467849a48d5a8f8e73fb1cbe5812a9e2cf7f12 100644 (file)
@@ -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
  */