]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
src: expand docs for guest info constant version handling
authorDaniel P. Berrangé <berrange@redhat.com>
Wed, 5 Mar 2025 15:24:31 +0000 (15:24 +0000)
committerDaniel P. Berrangé <berrange@redhat.com>
Wed, 12 Mar 2025 09:59:13 +0000 (09:59 +0000)
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>
src/libvirt-domain.c

index 390f54d46e69d113f4f0ec631e12387b3ff8b82b..82de3ede24dba245c461174bb96db86c1a9724ef 100644 (file)
@@ -13299,6 +13299,13 @@ virDomainSetVcpu(virDomainPtr domain,
  * Which, when fsindex==3 and diskindex==7, would result in the
  * key "fs.3.disk.7.serial".
  *
+ * NB, for the VIR_DOMAIN_GUEST_INFO_* 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 0 on success, -1 on error.
  *
  * Since: 5.7.0