[libvirt] [PATCH v2] doc: Correct the default werror policy

[Martin Kletzander]

On Thu, Feb 23, 2017 at 12:30:02PM +0100, Philipp Hahn wrote:
>The documentation is plain wrong about the default write_error policy,
>as its only implemented by QEMU (src/vz/vz_utils.c is the only other
>case, which simply explodes, is anything except other then
>VIR_DOMAIN_DISK_ERROR_POLICY_DEFAULT is used).
>
>And QEMUs default is VIR_DOMAIN_DISK_ERROR_POLICY_ENOSPACE.
>
>Signed-off-by: Philipp Hahn <hahn at univention.de>
>---
> docs/formatdomain.html.in | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>---
>Osier Yang proposed v1 on 2011-10-24, which never got applied due to
>discussions of "enospace" vs. "enospc".
>
>diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
>index 02ce792..3e1a193 100644
>--- a/docs/formatdomain.html.in
>+++ b/docs/formatdomain.html.in
>@@ -2745,7 +2745,8 @@
>             how the hypervisor will behave on a disk read or write
>             error, possible values are "stop", "report", "ignore", and
>             "enospace".<span class="since">Since 0.8.0, "report" since
>-            0.9.7</span> The default setting of error_policy is "report".
>+            0.9.7</span> The default is left to the discretion of the
>+            hypervisor: QEMU defaults to "enospace".<br/>

Did really all the versions do that?  I'm not sure.  Anyway, I don't
really think we should guarantee something that we have no power over,
especially since they can change the default and nobody will fix it in
our docs.  Only defaults that QEMU *driver* selects shoud be mentioned
in here (as that will also be visible in the XML), but when talking
about hypervisor defaults, I would just leave it to "hypervisor
default".

>             There is also an
>             optional <code>rerror_policy</code> that controls behavior
>             for read errors only. <span class="since">Since
>@@ -2755,8 +2756,7 @@
>             read errors. Also note that "enospace" is not a valid
>             policy for read errors, so if <code>error_policy</code> is
>             set to "enospace" and no <code>rerror_policy</code> is
>-            given, the read error policy will be left at its default,
>-            which is "report".
>+            given, the read error policy will be left at its default.
>           </li>
>           <li>
>             The optional <code>io</code> attribute controls specific
>--
>2.1.4
>
>--
>libvir-list mailing list
>libvir-list at redhat.com
>https://www.redhat.com/mailman/listinfo/libvir-list
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: Digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20170223/102a0c03/attachment-0001.sig>