Bug 882829
| Summary: | [Doc] Perl-Sys-Virt doc for list_all_volumes have errors | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 6 | Reporter: | weizhang <weizhan> |
| Component: | perl-Sys-Virt | Assignee: | Daniel Berrangé <berrange> |
| Status: | CLOSED ERRATA | QA Contact: | Virtualization Bugs <virt-bugs> |
| Severity: | low | Docs Contact: | |
| Priority: | medium | ||
| Version: | 6.4 | CC: | dallan, dyuan, mzhan, rwu |
| Target Milestone: | rc | ||
| Target Release: | --- | ||
| Hardware: | x86_64 | ||
| OS: | Linux | ||
| Whiteboard: | |||
| Fixed In Version: | perl-Sys-Virt-0.10.2-5.el6 | Doc Type: | Bug Fix |
| Doc Text: |
Cause:
Mistakes were made in the POD documentation for list_all_volumes
Consequence:
The documentation would mislead users
Fix:
The documentation was updated
Result:
The documentation for list_all_volumes correctly describes the API usage
|
Story Points: | --- |
| Clone Of: | Environment: | ||
| Last Closed: | 2013-02-21 09:52:36 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: | 886216 | ||
|
Description
weizhang
2012-12-03 08:06:02 UTC
commit 1bc198f982e7749661ccf9071c5ee6669ba7e09b
Author: Daniel P. Berrange <berrange>
Date: Tue Dec 11 10:57:02 2012 +0000
Fix misc typos in POD docs for StoragePool.pm
Signed-off-by: Daniel P. Berrange <berrange>
Verify pass on
perl-Sys-Virt-0.10.2-5.el6.x86_64
check doc
my @vols = $pool->list_volumes()
Return a list of all volumes in the storage pool. The elements in the returned list are instances of the
Sys::Virt::StorageVol class. This method requires O(n) RPC calls, so the "list_all_volumes" method is recommended
as a more efficient alternative.
my @volumes = $pool->list_all_volumes($flags)
Return a list of all storage volumes associated with this pool. The elements in the returned list are instances of
the Sys::Virt::StorageVol class. The $flags parameter can be used to filter the list of return storage volumes.
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-2013-0377.html |