Bug 887187

Summary: [Doc] There are some typos in libvirt manual and formatdomain.html
Product: Red Hat Enterprise Linux 6 Reporter: hongming <honzhang>
Component: libvirtAssignee: Eric Blake <eblake>
Status: CLOSED ERRATA QA Contact: Virtualization Bugs <virt-bugs>
Severity: low Docs Contact:
Priority: low    
Version: 6.4CC: acathrow, dallan, dyasny, dyuan, eblake, jdenemar, mzhan, rwu, tlavigne
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: libvirt-0.10.2-13.el6 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2013-02-21 07:28:42 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 895654    

Description hongming 2012-12-14 09:41:43 UTC 
Description of problem:
There are some typos in libvirt manual and formatdomain.html

Version-Release number of selected component (if applicable):
libvirt-devel-0.10.2-10.el6.x86_64
libvirt-0.10.2-10.el6.x86_64


How reproducible:
100%


Steps to Reproduce:
1.# vim /usr/share/doc/libvirt-devel-0.10.2/formatdomain.html
.....

1123   &lt;features&gt;
1124     &lt;pae/&gt;
1125     &lt;acpi/&gt;
1126     &lt;apic/&gt;
1127     &lt;hap/&gt;
1128     &lt;privnet/&gt;
1129     &lt;hyperv&gt;
1130       &lt;relaxed state='on'&gt;   <==== It should add "/"
1131     &lt;/hyperv&gt;
1132
1133   &lt;/features&gt;


http://libvirt.org/formatdomain.html

  <features>
    <pae/>
    <acpi/>
    <apic/>
    <hap/>
    <privnet/>
    <hyperv>
      <relaxed state='on'> 
    </hyperv>
  </features>
================================================================================

2. # vim /usr/share/doc/libvirt-devel-0.10.2/formatdomain.html

2319       &lt;virtualport type='openvswitch'/&gt;    <==== It should remove "/"
2320         &lt;parameters profileid='menial' interfaceid='09b11c53-8b5c-4eeb-8f     00-d84eaa0aaa4f'/&gt;
2321       &lt;/virtualport&gt;

http://libvirt.org/formatdomain.html

<virtualport type='openvswitch'/>
        <parameters profileid='menial' interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f'/>
 </virtualport>

================================================================================
3. # vim /usr/share/doc/libvirt-devel-0.10.2/formatdomain.html

3439   &lt;devices&gt;
3440     &lt;serial type="dev"&gt;
3441       &lt;source path="/dev/ttyS0"/&gt;
3442       &lt;target port="1"/&gt;
3443   &lt;/serial&gt;                      <==== It should add indentation
3444   &lt;/devices&gt;

http://libvirt.org/formatdomain.html

<devices>
  <serial type="dev">
    <source path="/dev/ttyS0"/>
    <target port="1"/>
</serial>
</devices>

==================================================================================
4. # man virsh

......
 Example

            virsh dumpxml <domain> > domain.xml
            vi domain.xml (or make changes with your other text editor)
            virsh create < domain.xml     <==== It should remove "<"



  
Actual results:


Expected results:


Additional info:
Comment 2 Eric Blake 2012-12-14 15:30:47 UTC 
Items 1-3 are fixed with:

commit 9821f8f6cfc49cb7ebcf707f2e40894d8f6c80af
Author: Eric Blake <eblake>
Date:   Fri Dec 14 08:28:57 2012 -0700

    docs: fix some typos in examples
    
    As detected in https://bugzilla.redhat.com/show_bug.cgi?id=887187
    
    * docs/formatdomain.html.in: Fix XML typos.

Item 4 is fixed with:

commit d49adae2e261d2736b22be37ef8d4fe0460df0ad
Author: Guido Günther <agx>
Date:   Wed Nov 7 21:35:55 2012 +0100

    Fix "virsh create" example
    
    We require a file and don't accept standard input:
    
    http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=692322
Comment 3 Eric Blake 2012-12-14 16:13:35 UTC 
In POST:
http://post-office.corp.redhat.com/archives/rhvirt-patches/2012-December/msg00379.html
Comment 4 hongming 2012-12-20 05:35:14 UTC 
Verify it using libvirt-0.10.2-13.el6.x86_64. The result is expected. Change its status to VERIFIED.


Check the following files , the above typos have been fixed.

1
http://libvirt.org/formatdomain.html
/usr/share/doc/libvirt-devel-0.10.2/formatdomain.html


2.man virsh 

           Example

            virsh dumpxml <domain> > domain.xml
            vi domain.xml (or make changes with your other text editor)
            virsh create domain.xml
Comment 5 errata-xmlrpc 2013-02-21 07:28:42 UTC 
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

http://rhn.redhat.com/errata/RHSA-2013-0276.html