Bug 722862
| Summary: | [doc]confusion of iface-mac & iface-name in man page | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 6 | Reporter: | zhe peng <zpeng> |
| Component: | libvirt | Assignee: | Peter Krempa <pkrempa> |
| Status: | CLOSED ERRATA | QA Contact: | Virtualization Bugs <virt-bugs> |
| Severity: | low | Docs Contact: | |
| Priority: | low | ||
| Version: | 6.2 | CC: | dallan, dyuan, eblake, jyang, mzhan, rwu, whuang |
| Target Milestone: | rc | ||
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | libvirt-0.9.4-rc1-1.el6 | Doc Type: | Bug Fix |
| Doc Text: |
Cause:
Virsh man page contained duplicate documentation for "iface-name", lack of documentation for "iface-mac" and inconsistent option names with "virsh help".
Consequence:
Confusion while reading the man page. Lack of information about the "iface-mac" command.
Fix:
Man page was fixed to contain correct descriptions.
Result:
Commands in question are documented.
|
Story Points: | --- |
| Clone Of: | Environment: | ||
| Last Closed: | 2011-12-06 11:16:56 UTC | Type: | --- |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
Upstream patch under discussion: https://www.redhat.com/archives/libvir-list/2011-July/msg01084.html commit dde5681356dc3f5a790b8c1a5763c8efa0d398c7
Author: Osier Yang <jyang>
Date: Tue Jul 19 11:19:25 2011 +0800
doc: Correct documents for iface commands
The problems:
* Duplicate documents for "iface-name"
* Lacks of document for "iface-mac"
* Inconsistent option names with virsh help strings.
Patch pushed to upstream, move to POST.
verify this bug with
#rpm -q libvirt
libvirt-0.9.4-1.el6.x86_64
#man virsh
...
iface-name interface
Convert a host interface MAC to interface name, if the MAC address is unique among the host’s
interfaces.
interface specifies the interface MAC address.
iface-mac interface
Convert a host interface name to MAC address.
interface specifies the interface name.
...
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:
Cause:
Virsh man page contained duplicate documentation for "iface-name", lack of documentation for "iface-mac" and inconsistent option names with "virsh help".
Consequence:
Confusion while reading the man page. Lack of information about the "iface-mac" command.
Fix:
Man page was fixed to contain correct descriptions.
Result:
Commands in question are documented.
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-2011-1513.html |
Description of problem: confusion of iface-mac & iface-name in man page Version-Release number of selected component (if applicable): libvirt-0.9.3-5.el6.x86_64 How reproducible: always #man virsh Actual results: ... iface-name iface-MAC Convert a host interface MAC to interface name, if the iface-MAC is unique among the host’s interfaces. iface-name iface-MAC Convert a host interface name to MAC address. ... Expected results: ... iface-name iface-MAC Convert a host interface MAC to interface name, if the iface-MAC is unique among the host’s interfaces. iface-mac iface-NAME Convert a host interface name to MAC address. ... Additional info: using virsh command: #virsh iface-name 00:1b:21:39:8b:18 eth0 #virsh iface-mac eth0 00:1b:21:39:8b:18