RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 833327 - [Doc]The abbreviation of domain name-id-uuid arguments are inconsistent in manual
Summary: [Doc]The abbreviation of domain name-id-uuid arguments are inconsistent in ma...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 6
Classification: Red Hat
Component: libvirt
Version: 6.3
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: rc
: ---
Assignee: Ján Tomko
QA Contact: Virtualization Bugs
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-06-19 08:52 UTC by hongming
Modified: 2013-02-21 07:17 UTC (History)
8 users (show)

Fixed In Version: libvirt-0.10.0-0rc0.el6
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-02-21 07:17:54 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHSA-2013:0276 0 normal SHIPPED_LIVE Moderate: libvirt security, bug fix, and enhancement update 2013-02-20 21:18:26 UTC

Description hongming 2012-06-19 08:52:45 UTC 
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:
Comment 2 dyuan 2012-07-12 10:21:12 UTC 
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"
Comment 5 Ján Tomko 2012-07-18 16:08:39 UTC 
Proposed patch:

https://www.redhat.com/archives/libvir-list/2012-July/msg00760.html
Comment 6 Ján Tomko 2012-07-25 09:29:48 UTC 
Proposed patch v2:
https://www.redhat.com/archives/libvir-list/2012-July/msg00893.html
Comment 7 Ján Tomko 2012-07-26 11:58:37 UTC 
Fixed by commit aa03b1471c334836e87f814a32d9fec914eeed94
    virsh man page - domain-id consistency
Comment 9 hongming 2012-08-06 09:15:06 UTC 
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.
Comment 10 errata-xmlrpc 2013-02-21 07:17:54 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
Note You need to log in before you can comment on or make changes to this bug.