]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
libvirt-domain: Fix documentation of virDomainInterfaceAddresses()
authorMichal Privoznik <mprivozn@redhat.com>
Tue, 20 Jan 2026 15:15:14 +0000 (16:15 +0100)
committerMichal Privoznik <mprivozn@redhat.com>
Wed, 21 Jan 2026 16:29:36 +0000 (17:29 +0100)
Ever since of v1.2.14-rc1~105 the hwaddr member of
_virDomainInterface struct can be NULL. And this is documented
inside the struct. But then the public API documents it can never
be NULL which is obviously wrong. Fix the public API
documentation.

Fixes: 3640245db7d72bf8e05df726587625a6328c895e
Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
src/libvirt-domain.c

index 74c70a0a43fe95f2d18fca3a1bcb5ba998d7b047..a278c4679d91d9e8c62c5fac4e14a97c196db5d1 100644 (file)
@@ -12881,7 +12881,7 @@ virDomainFSInfoFree(virDomainFSInfoPtr info)
  * might be unset (e.g. VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_ARP does not
  * set IP address prefix as ARP table does not have any notion of that).
  *
- * @ifaces->name and @ifaces->hwaddr are never NULL.
+ * @ifaces->name is never NULL, and @ifaces->hwaddr may be NULL.
  *
  * The caller *must* free @ifaces when no longer needed. Usual use case
  * looks like this: