[PATCH v2 23/23] 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.
Signed-off-by: Daniel P. Berrangé <berrange(a)redhat.com>
---
src/libvirt-domain.c | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index 59fb923d10..a7a1c5ebd3 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.
--
2.48.1