[PATCH 3/3] virDomainSetBlockThreshold: Document that two events are fired when index isn't used

[Peter Krempa]

Libvirt started emitting two threshold events, once with index and once
withouth when the index isn't registered. Document this caveat.

Signed-off-by: Peter Krempa <pkrempa at redhat.com>
---
 src/libvirt-domain.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index 750e32f0ca..0a7d2dd234 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -12637,6 +12637,10 @@ int virDomainGetGuestInfo(virDomainPtr domain,
  * live VM XML for 'backingStore' or 'source' elements of a disk. If index is
  * given the threshold is set for the corresponding image.
  *
+ * In case when @dev does not contain index the
+ * VIR_DOMAIN_EVENT_ID_BLOCK_THRESHOLD event may be emitted twice, once for the
+ * disk device target without index and once containing the index.
+ *
  * Note that the threshold event can be registered also for destinations of a
  * 'virDomainBlockCopy' destination by using the 'index' of the 'mirror' source.
  *
-- 
2.31.1