Bug 747483

Summary: Missing flags parameter for get_xml_description in perl-Sys-Virt man page
Product: Red Hat Enterprise Linux 6 Reporter: xhu
Component: perl-Sys-VirtAssignee: Daniel Berrangé <berrange>
Status: CLOSED ERRATA QA Contact: Virtualization Bugs <virt-bugs>
Severity: medium Docs Contact:
Priority: medium    
Version: 6.3CC: berrange, crobinso, dallan, dyuan, mshao, mzhan, rwu, xen-maint
Target Milestone: rc   
Target Release: ---   
Hardware: x86_64   
OS: Linux   
Whiteboard:
Fixed In Version: perl-Sys-Virt-0.9.9-1.el6 Doc Type: Bug Fix
Doc Text:
No technical notes required
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-06-20 12:00:41 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description xhu 2011-10-20 02:10:00 UTC
Description of problem:
Missing flags parameter for get_xml_description in perl-Sys-Virt man page

Version-Release number of selected component (if applicable):
perl-Sys-Virt-0.9.4-2.el6
libvirt-0.9.4-16.el6.x86_64
qemu-kvm-0.12.1.2-2.195.el6.x86_64

How reproducible:
everytimes

Steps to Reproduce:
1. install perl-Sys-Virt
# yum install perl-Sys-Virt

2. check usage for get_xml_description function
# man /usr/share/man/man3/Sys::Virt::Domain.3pm.gz|col -b|grep -2 get_xml_description
	   current live config.

       my $xml = $dom->get_xml_description()
	   Returns an XML document containing a complete description of the
	   domain’s configuration
  
Actual results:
The description for get_xml_description is as follows:
 my $xml = $dom->get_xml_description()
	   Returns an XML document containing a complete description of the
	   domain’s configuration

Expected results:
It should be as follows:
my $xml = $dom->get_xml_description($flags=0)


Additional info:
$dom->get_xml_description will call C API virDomainGetXMLDesc, which
contains a 'flags'
parameter, it looks like this:
virDomainGetXMLDesc(virDomainPtr domain, unsigned int flags)

@flags is an OR'ed set of virDomainXMLFlags, and it may be
VIR_DOMAIN_XML_SECURE,
VIR_DOMAIN_XML_INACTIVE or VIR_DOMAIN_XML_UPDATE_CPU.

So it need users can change flags value to meet different requirement.

Comment 3 xhu 2012-01-17 05:59:26 UTC
Reproduce it with perl-Sys-Virt-0.9.4-2.el6
Verify it with perl-Sys-Virt-0.9.9-1.el6 and it passed. The steps are as follows:
# man /usr/share/man/man3/Sys::Virt::Domain.3pm.gz|col -b|grep -2 get_xml_description
       current live config.

       my $xml = $dom->get_xml_description($flags=0)
	   Returns an XML document containing a complete description of the
	   domain’s configuration. The optional $flags parameter controls

Comment 5 Daniel Berrangé 2012-05-01 09:05:01 UTC
    Technical note added. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    
    New Contents:
No technical notes required

Comment 7 errata-xmlrpc 2012-06-20 12:00:41 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/RHBA-2012-0754.html