From: Daniel P. Berrangé <berrange@redhat.com>
Date: Wed, 5 Mar 2025 15:24:31 +0000 (+0000)
Subject: src: expand docs for guest stats constant version handling
X-Git-Tag: v11.2.0-rc1~178
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=defca1162755511710ac13a8d83811f7d3aa0e28;p=thirdparty%2Flibvirt.git

src: expand docs for guest stats constant version handling

Explain that the 11.2.0 release dates are mostly reflecting when the
constant was first added, not when the key was introduced.

Reviewed-by: Peter Krempa <pkrempa@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---

diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index c64f3015d4..b23a3489c5 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -12440,6 +12440,13 @@ virConnectGetDomainCapabilities(virConnectPtr conn,
  * Which, when monindex==3 and bankindex==7, would result in the
  * key "cpu.cache.monitor.3.bank.7.bytes".
  *
+ * NB, for the VIR_DOMAIN_STATS_* constants, if the `Since`
+ * tag is set to `11.2.0` this is usually representing the
+ * release when the constant was first introduced to the public
+ * API. Most of these typed parameter keys will have been
+ * introduced in earlier libvirt releases, prior to the definition
+ * of the constants.
+ *
  * Returns the count of returned statistics structures on success, -1 on error.
  * The requested data are returned in the @retStats parameter. The returned
  * array should be freed by the caller. See virDomainStatsRecordListFree.