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

[Eric Blake]

On 10/30/2011 10:11 PM, Osier Yang wrote:

>>> The optional<code>error_policy</code> attribute controls
>>> 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 (QEMU and KVM only),
>>> + "report" since 0.9.7</span>. QEMU sets error_policy as "enospc"
>>> + by default.
>>
>> This is definitely more correct than what's already there. My only
>> issue is that the description mixes libvirt's name of the attribute
>> "error_policy" with QEMU's value "enospc". Maybe instead it can just
>> say that QEMU defaults to "werror=enospc,rerror=report" when neither
>> error_policy nor rerror_policy are specified.
>
> Oh, you are right, it shouldn't mix them together.
>
> "rerror" is clarified later, so how about following (with your
> next suggestion) ?
>
> if no "error_policy" is given, the write error policy will be left at
> QEMU's default setting, which is "enospc".

We're still mixing things up.  "enospc" is an internal detail of qemu, 
and should not be leaked in the docs; we should only be using the term 
"enospace" which is the XML we are documenting.  How about:

possible value are "stop", "report", "ignore", and "enospace" (since 
...).  If no "error_policy" is given, the write error policy is left at 
qemu's default of "enospace".

>>
>> Other than that, ACK.

There's been enough churn (aka "bike-shedding") that it would probably 
be wise to send a v2 before pushing.

-- 
Eric Blake   eblake at redhat.com    +1-801-349-2682
Libvirt virtualization library http://libvirt.org