virDomainSetBlockThreshold: Document that two events are fired when index isn't used

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@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>

diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index e48f3cdb023983593f5ca0fa61ad59abd20ecab7..35c0df0ebcb1adc4ac259e9c54de19ec657c1542 100644 (file)
--- 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.
  *