[libvirt] [PATCH] virsh: domifaddr: clarify description of --full option

Chen Hanxiao posted 1 patch 6 years, 6 months ago
Failed in applying to current master (apply log)
tools/virsh-domain-monitor.c | 2 +-
tools/virsh.pod              | 6 +++---
2 files changed, 4 insertions(+), 4 deletions(-)
[libvirt] [PATCH] virsh: domifaddr: clarify description of --full option
Posted by Chen Hanxiao 6 years, 6 months ago
From: Chen Hanxiao <chenhanxiao@gmail.com>

  Option --full will always display the name and MAC
  address of the interface.
  Both virsh help and virsh man page didn't mention that.

Signed-off-by: Chen Hanxiao <chenhanxiao@gmail.com>
---
 tools/virsh-domain-monitor.c | 2 +-
 tools/virsh.pod              | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/tools/virsh-domain-monitor.c b/tools/virsh-domain-monitor.c
index 4c50155e1..35d04b22a 100644
--- a/tools/virsh-domain-monitor.c
+++ b/tools/virsh-domain-monitor.c
@@ -2153,7 +2153,7 @@ static const vshCmdOptDef opts_domifaddr[] = {
     {.name = "full",
      .type = VSH_OT_BOOL,
      .flags = VSH_OFLAG_NONE,
-     .help = N_("display full fields")},
+     .help = N_("always display names and MACs of interfaces")},
     {.name = "source",
      .type = VSH_OT_STRING,
      .flags = VSH_OFLAG_NONE,
diff --git a/tools/virsh.pod b/tools/virsh.pod
index 9304ca525..db1ede880 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -766,9 +766,9 @@ addresses, or limited output just for one interface if I<interface> is
 specified. Note that I<interface> can be driver dependent, it can be the name
 within guest OS or the name you would see in domain XML. Moreover, the whole
 command may require a guest agent to be configured for the queried domain under
-some drivers, notably qemu. If I<--full> is specified, the interface name is
-always displayed when the interface has multiple addresses or alias, otherwise
-it only displays the interface name for the first address, and "-" for the
+some drivers, notably qemu. If I<--full> is specified, the interface name and MAC
+address is always displayed when the interface has multiple addresses or alias,
+otherwise it only displays the interface name for the first address, and "-" for the
 others. The I<--source> argument specifies what data source to use for the
 addresses, currently one of 'lease' to read DHCP leases, or 'agent' to query
 the guest OS via an agent. If unspecified, 'lease' is the default.
-- 
2.13.5

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH] virsh: domifaddr: clarify description of --full option
Posted by John Ferlan 6 years, 6 months ago

On 10/16/2017 02:53 AM, Chen Hanxiao wrote:
> From: Chen Hanxiao <chenhanxiao@gmail.com>
> 
>   Option --full will always display the name and MAC
>   address of the interface.
>   Both virsh help and virsh man page didn't mention that.
> 
> Signed-off-by: Chen Hanxiao <chenhanxiao@gmail.com>
> ---
>  tools/virsh-domain-monitor.c | 2 +-
>  tools/virsh.pod              | 6 +++---
>  2 files changed, 4 insertions(+), 4 deletions(-)
> 

Reviewed-by: John Ferlan <jferlan@redhat.com>

OK - in general; however, before pushing I cleaned up the syntax and
grammar a bit for the --full argument as well as separating it so that
it has its own paragraph (causing --source to have its own paragraph too).

John

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