[PATCH] docs: domain: Explain supported options of 'error_policy'

From: Peter Krempa <pkrempa(a)redhat.com&gt; Explain what the individual settings actually result in. The changes are based on the paraprhase of qemu documentation which in 'qemu-options.hx' states: ``werror=action,rerror=action`` Specify which action to take on write and read errors. Valid actions are: "ignore" (ignore the error and try to continue), "stop" (pause QEMU), "report" (report the error to the guest), "enospc" (pause QEMU only if the host disk is full; report the error to the guest otherwise). The default setting is ``werror=enospc`` and ``rerror=report``. Closes: https://gitlab.com/libvirt/libvirt/-/issues/138 Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- docs/formatdomain.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index c7c75ae219..a23a746229 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -3451,8 +3451,12 @@ paravirtualized driver is specified via the ``disk`` element. and sync requests from guest are ignored). :since:`Since 0.6.0` - The optional ``error_policy`` attribute controls how the hypervisor will - behave on a disk read or write error, possible values are "stop", - "report" (:since:`since 0.9.7`), "ignore", and "enospace". + behave on a disk read or write error, possible values are ``stop`` ( + suspend/pause the domain on error), ``report`` (report the error to the + guest OS; :since:`since 0.9.7`), ``ignore`` (ignore the error and try to + continue), and ``enospace`` (suspend/pause the domain only if host storage + is full; report the error to the guest OS otherwise). + The default is left to the discretion of the hypervisor. :since:`Since 0.8.0`. - The optional ``rerror_policy`` attribute controls behavior for read -- 2.49.0