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>
This commit is contained in:
Peter Krempa 2021-07-01 16:03:58 +02:00
parent a3edda6b9e
commit 0ba4066819

View File

@ -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.
*