Bug 833327
| Summary: | [Doc]The abbreviation of domain name-id-uuid arguments are inconsistent in manual | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 6 | Reporter: | hongming <honzhang> |
| Component: | libvirt | Assignee: | Ján Tomko <jtomko> |
| Status: | CLOSED ERRATA | QA Contact: | Virtualization Bugs <virt-bugs> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | 6.3 | CC: | acathrow, dallan, dyasny, dyuan, mprivozn, mzhan, rwu, yupzhang |
| Target Milestone: | rc | ||
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | libvirt-0.10.0-0rc0.el6 | Doc Type: | Bug Fix |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2013-02-21 07:17:54 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: | |||
1. In # man virsh:
dominfo domain-id
Returns basic information about the domain.
but both domname and domuuid work well.
Expected results:
Update the virsh manual, use "dominfo domain-name-or-id-or-uuid" instead of "dominfo-id"
Proposed patch v2: https://www.redhat.com/archives/libvir-list/2012-July/msg00893.html Fixed by commit aa03b1471c334836e87f814a32d9fec914eeed94
virsh man page - domain-id consistency
Verify it using libvirt-0.10.0-0rc0.el6.x86_64, # man virsh Where command is one of the commands listed below, domain is the numeric domain id, or the domain name, or the domain UUID and ARGS are command specific options. There are a few exceptions to this rule in the cases where the command in question acts on all domains, the entire machine, or directly on the xen hypervisor. Those exceptions will be clear for each of those commands. The abbreviation of domain-id-uuid arguments are consistent in manual. So move its status to VERIFIED. 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 |
Description of problem: The abbreviation of domain name-id-uuid arguments are inconsistent in manual. The domain name -id- uuid is abbreviated to "domain-id" in manual. But some of commands use "domain" format and two commands use "domain-id-or-uuid " format in manual ,and id and uuid can be used as arguments in them. Version-Release number of selected component (if applicable): libvirt-0.9.10-21.el6.x86_64 How reproducible: 100% Steps to Reproduce: 1.#man virsh DOMAIN COMMANDS The following commands manipulate domains directly, as stated previously most commands take domain-id as the first parameter. The domain-id can be specified as a short integer, a name or a full UUID. domblkstat domain block-device [--human] domifstat domain interface-device domif-setlink domain interface-device state --persistent domif-getlink domain interface-device --persistent domiftune domain interface-device [[--config] [--live] | [--current]] [--inbound average,peak,burst] [--outbound average,peak,burst] dommemstat domain domblkinfo domain block-device domblklist domain [--inactive] [--details] domiflist domain [--inactive] blockcopy domain path dest [bandwidth] [--shallow] [--reuse-external] [--raw] [--wait [--verbose] [{--pivot | --finish}] [--timeout seconds] [--async]] blockpull domain path [bandwidth] [base] [--wait [--verbose] [--timeout seconds] [--async]] blkdeviotune domain device [[--config] [--live] | [--current]] [[total-bytes-sec] | [read-bytes-sec] [write-bytes-sec]] [[total-iops-sec] | [read-iops-sec] [write-iops-sec]] blockjob domain path { [--abort] [--async] [--pivot] | [--info] | [bandwidth] } blockresize domain path size cpu-stats domain [--total] [start] [count] numatune domain [--mode mode] [--nodeset nodeset] [[--config] [--live] | [--current]] domjobabort domain-id-or-uuid domjobinfo domain-id-or-uuid Actual results: The above commands use "domain" and the domjobabort and domjobinfo use " domain-id-or-uuid " Expected results: The abbreviation of domain-id-uuid arguments are consistent in manual. Additional info: