[libvirt] docs: domain: Show canonical pvspinlock XML

Message ID b6b3b25b8388c43a1ab4eabd112968eec0b6f779.1444071579.git.crobinso@redhat.com
State New
Headers show

Commit Message

Cole Robinson Oct. 5, 2015, 6:59 p.m.
The example pvspinlock XML is:

  <pvspinlock/>

While this is accepted by libvirt and works correctly, it's currently
always output as a tristate like

  <pvspinlock state='on'/>

So document that format instead
---
 docs/formatdomain.html.in | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Martin Kletzander Oct. 6, 2015, 7:19 a.m. | #1
On Mon, Oct 05, 2015 at 02:59:39PM -0400, Cole Robinson wrote:
>The example pvspinlock XML is:
>
>  <pvspinlock/>
>
>While this is accepted by libvirt and works correctly, it's currently
>always output as a tristate like
>
>  <pvspinlock state='on'/>
>
>So document that format instead
>---
> docs/formatdomain.html.in | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>

We could also clean this and others to behave as apic, kvm, etc. by
doing s/ state='on'// on line 2209 in domain_conf.c.  But whichever
one you choose, ACK.

>diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
>index efa485c..c88b032 100644
>--- a/docs/formatdomain.html.in
>+++ b/docs/formatdomain.html.in
>@@ -1464,7 +1464,7 @@
>     &lt;kvm&gt;
>       &lt;hidden state='on'/&gt;
>     &lt;/kvm&gt;
>-    &lt;pvspinlock/&gt;
>+    &lt;pvspinlock state='on'/&gt;
>     &lt;gic version='2'/&gt;
>
>   &lt;/features&gt;
>--
>2.5.0
>
>--
>libvir-list mailing list
>libvir-list@redhat.com
>https://www.redhat.com/mailman/listinfo/libvir-list
--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Cole Robinson Oct. 6, 2015, 2:41 p.m. | #2
On 10/06/2015 03:19 AM, Martin Kletzander wrote:
> On Mon, Oct 05, 2015 at 02:59:39PM -0400, Cole Robinson wrote:
>> The example pvspinlock XML is:
>>
>>  <pvspinlock/>
>>
>> While this is accepted by libvirt and works correctly, it's currently
>> always output as a tristate like
>>
>>  <pvspinlock state='on'/>
>>
>> So document that format instead
>> ---
>> docs/formatdomain.html.in | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>
> 
> We could also clean this and others to behave as apic, kvm, etc. by
> doing s/ state='on'// on line 2209 in domain_conf.c.  But whichever
> one you choose, ACK.
> 

I think it's better to be explicit about the state='on' bit so personally I'd
prefer not to drop it from domain_conf.c. I've pushed this fix, thanks for the
review

- Cole

>> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
>> index efa485c..c88b032 100644
>> --- a/docs/formatdomain.html.in
>> +++ b/docs/formatdomain.html.in
>> @@ -1464,7 +1464,7 @@
>>     &lt;kvm&gt;
>>       &lt;hidden state='on'/&gt;
>>     &lt;/kvm&gt;
>> -    &lt;pvspinlock/&gt;
>> +    &lt;pvspinlock state='on'/&gt;
>>     &lt;gic version='2'/&gt;
>>
>>   &lt;/features&gt;
>> -- 
>> 2.5.0
>>
>> -- 
>> libvir-list mailing list
>> libvir-list@redhat.com
>> https://www.redhat.com/mailman/listinfo/libvir-list

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Patch hide | download patch | download mbox

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index efa485c..c88b032 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -1464,7 +1464,7 @@ 
     &lt;kvm&gt;
       &lt;hidden state='on'/&gt;
     &lt;/kvm&gt;
-    &lt;pvspinlock/&gt;
+    &lt;pvspinlock state='on'/&gt;
     &lt;gic version='2'/&gt;
 
   &lt;/features&gt;