]> xenbits.xensource.com Git - libvirt.git/commit
virsh: tweak help output for VSH_OT_DATA
authorEric Blake <eblake@redhat.com>
Tue, 29 Jun 2010 22:14:57 +0000 (16:14 -0600)
committerEric Blake <eblake@redhat.com>
Wed, 30 Jun 2010 13:17:40 +0000 (07:17 -0600)
commit26752f3be1da9d2efb3f56c387db8c1dec42f830
treeb456843c7787dbd0e853be5780ba97ac708e0127
parent8134d396fefae256b5ebe7b0bd98686368a0dd85
virsh: tweak help output for VSH_OT_DATA

https://bugzilla.redhat.com/show_bug.cgi?id=609044 complained
that 'virsh help pool-create-as' didn't document the shortcut
that you can do 'virsh pool-create-as $name $type --target $target'
rather than having to supply the four optional source- arguments
in order to fill out the necessary positional arguments.

This one-liner changes the help output to hopefully make this more obvious:

  NAME
    pool-create-as - create a pool from a set of args

  SYNOPSIS
    pool-create-as <name> [--print-xml] <type> [<source-host>] [<source-path>] [<source-dev>] [<source-name>] [<target>] [--source-format <string>]

  DESCRIPTION
    Create a pool.

  OPTIONS
    [--name] <string>  name of the pool
    --print-xml      print XML document, but don't define/create
    [--type] <string>  type of the pool
    [--source-host] <string>  source-host for underlying storage
    [--source-path] <string>  source path for underlying storage
    [--source-dev] <string>  source device for underlying storage
    [--source-name] <string>  source name for underlying storage
    [--target] <string>  target for underlying storage
    --source-format <string>  format for underlying storage

* tools/virsh.c (vshCmddefHelp): Make it more obvious that data
arguments may, but not must, be specified by option leaders.
tools/virsh.c