External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-02-06 20:00:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

include: libvirt-domain: Reword documentation for @reason of VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON

Browse Source 
Emphasise that it's an enumeration and convert the possibilities to a
list of values with explanation.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Peter Krempa 2025-01-27 15:50:34 +01:00
parent 666219f5f1
commit 3a3c5616eb
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/libvirt/libvirt-domain.h
View File

@ -4805,11 +4805,13 @@ typedef void (*virConnectDomainEventIOErrorCallback)(virConnectPtr conn,
* The callback signature to use when registering for an event of type * The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON with virConnectDomainEventRegisterAny() * VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON with virConnectDomainEventRegisterAny()
* *
* If the I/O error is known to be caused by an ENOSPC condition in * Although @reason is a string, it is considered to be an enumeration of the
* the host (where resizing the disk to be larger will allow the guest * following values:
* to be resumed as if nothing happened), @reason will be "enospc". *
* Otherwise, @reason will be "", although future strings may be added * - "" (empty string): unknown I/O error reason
* if determination of other error types becomes possible. * - "enospc": The I/O error is known to be caused by an ENOSPC condition in
* the host. Resizing the disk source to be larger will allow the
* guest to be resumed as if nothing happened.
* *
* Since: 0.8.1 * Since: 0.8.1
*/ */