Re: [libvirt] [PATCH] doc: Correct docs for iface commands

2011-07-18 Thread Eric Blake

On 07/18/2011 05:45 AM, Osier Yang wrote:

duplicate documents for iface-name, lacks of document for
iface-mac, inconsistent option names with virsh help strings.
---
  tools/virsh.pod |   16 ++--
  1 files changed, 10 insertions(+), 6 deletions(-)

diff --git a/tools/virsh.pod b/tools/virsh.pod
index 377fac0..4f218d3 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -1081,20 +1081,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 Biface-name  Iiface-MAC
+=item Biface-name  Iinterface


We have other cases of man page names differing from virsh.c names.  For 
example, 'virsh help domid' documents 'domain' along with later 
mentioning domain name or uuid under OPTIONS, but 'man virsh' merely 
documents 'domid domain-name-or-uuid' in its synopsis.


I'm okay with fixing the synopsis to match virsh, but we should probably 
scrub things to fix all commands to use consistent names.


At any rate, this is strict improvement, so:

ACK.

--
Eric Blake   ebl...@redhat.com+1-801-349-2682
Libvirt virtualization library http://libvirt.org

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list


Re: [libvirt] [PATCH] doc: Correct docs for iface commands

2011-07-18 Thread Osier Yang

于 2011年07月19日 03:24, Eric Blake 写道:

On 07/18/2011 05:45 AM, Osier Yang wrote:

duplicate documents for iface-name, lacks of document for
iface-mac, inconsistent option names with virsh help strings.
---
tools/virsh.pod | 16 ++--
1 files changed, 10 insertions(+), 6 deletions(-)

diff --git a/tools/virsh.pod b/tools/virsh.pod
index 377fac0..4f218d3 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -1081,20 +1081,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 Biface-name Iiface-MAC
+=item Biface-name Iinterface


We have other cases of man page names differing from virsh.c names. 
For example, 'virsh help domid' documents 'domain' along with later 
mentioning domain name or uuid under OPTIONS, but 'man virsh' merely 
documents 'domid domain-name-or-uuid' in its synopsis.


I'm okay with fixing the synopsis to match virsh, but we should 
probably scrub things to fix all commands to use consistent names.


At any rate, this is strict improvement, so:

ACK.



Pushed, thanks, and I'm looking at the whole virsh manual to work out
a patch fixes the all.

Osier

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list