From: Osier Yang <jyang@redhat.com>
Date: Tue, 19 Jul 2011 03:19:25 +0000 (+0800)
Subject: doc: Correct documents for iface commands
X-Git-Tag: v0.9.4-rc1~139
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dde5681356dc3f5a790b8c1a5763c8efa0d398c7;p=thirdparty%2Flibvirt.git

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.
---

diff --git a/tools/virsh.pod b/tools/virsh.pod
index 5dc3d2e41e..6430efb95d 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -1077,20 +1077,24 @@ Returns the list of active host interfaces.  If I<--all> is specified
 this will also include defined but inactive interfaces.  If
 I<--inactive> is specified only the inactive ones will be listed.
 
-=item B<iface-name> I<iface-MAC>
+=item B<iface-name> I<interface>
 
-Convert a host interface MAC to interface name, if the I<iface-MAC> is
-unique among the host's interfaces.
+Convert a host interface MAC to interface name, if the MAC address is unique
+among the host's interfaces.
 
-=item B<iface-name> I<iface-MAC>
+I<interface> specifies the interface MAC address.
+
+=item B<iface-mac> I<interface>
 
 Convert a host interface name to MAC address.
 
-=item B<iface-start> I<iface>
+I<interface> specifies the interface name.
+
+=item B<iface-start> I<interface>
 
 Start a (previously defined) host interface, such as by running "if-up".
 
-=item B<iface-undefine> I<iface>
+=item B<iface-undefine> I<interface>
 
 Undefine the configuration for an inactive host interface.