[libvirt] [PATCH] tools: virsh: Add some example values to attach-disk --help

https://bugzilla.redhat.com/show_bug.cgi?id=982630 --- tools/virsh-domain.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c index 36d0353..46598bb 100644 --- a/tools/virsh-domain.c +++ b/tools/virsh-domain.c @@ -322,11 +322,11 @@ static const vshCmdOptDef opts_attach_disk[] = { }, {.name = "driver", .type = VSH_OT_STRING, - .help = N_("driver of disk device") + .help = N_("driver of disk device (qemu|...)") }, {.name = "subdriver", .type = VSH_OT_STRING, - .help = N_("subdriver of disk device") + .help = N_("subdriver of disk device (raw|qcow2|vmdk|...)") }, {.name = "iothread", .type = VSH_OT_STRING, @@ -338,7 +338,7 @@ static const vshCmdOptDef opts_attach_disk[] = { }, {.name = "type", .type = VSH_OT_STRING, - .help = N_("target device type") + .help = N_("target device type (disk|cdrom|floppy|...)") }, {.name = "shareable", .type = VSH_OT_ALIAS, @@ -346,11 +346,11 @@ static const vshCmdOptDef opts_attach_disk[] = { }, {.name = "mode", .type = VSH_OT_STRING, - .help = N_("mode of device reading and writing") + .help = N_("mode of device reading and writing (readonly|shareable)") }, {.name = "sourcetype", .type = VSH_OT_STRING, - .help = N_("type of source (block|file)") + .help = N_("type of source (block|file|...)") }, {.name = "serial", .type = VSH_OT_STRING, -- 2.7.3

On Sat, Apr 09, 2016 at 10:18:07PM -0400, Cole Robinson wrote:
https://bugzilla.redhat.com/show_bug.cgi?id=982630 --- tools/virsh-domain.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
I think we were trying not to put examples in the help info, just in case they are not applicable in some case. But I think this makes the info more understandable *and* we already mention these in the man page, so "why not", right? So ACK from my POV.

On Sat, Apr 09, 2016 at 10:18:07PM -0400, Cole Robinson wrote:
https://bugzilla.redhat.com/show_bug.cgi?id=982630 --- tools/virsh-domain.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
NACK, examples belong in the man page, not the help strings. Jan
participants (3)
-
Cole Robinson
-
Ján Tomko
-
Martin Kletzander