[libvirt] [PATCH] Fix typos for snapshot-create-as in virsh help cmd and doc

Eric Blake eblake at redhat.com
Wed Sep 14 18:16:25 UTC 2011


On 09/14/2011 12:14 PM, Eric Blake wrote:
> On 09/14/2011 12:06 PM, Nan Zhang wrote:
>> * tools/virsh.c: Using VSH_OT_STRING instead of VSH_OT_ARGV for diskspec
>
> Nack. This MUST be VSH_OT_ARGV, in order to allow multiple diskspec.
>
>> * tools/virsh.pod: Fix missing -- tag for snapshot-create-as in docs
>
> Nack. This is intentional - if all earlier options with arguments are
> provided, then you can write 'snapshot-create-as dom name description
> vda' instead of the identical 'snapashot-create-as dom name description
> --diskspec vda'

That said, I agree that the man page does look a bit confusing, and 
perhaps we could go with:

  =item B<snapshot-create-as> I<domain> {[I<--print-xml>]
  | [I<--no-metadata>] [I<--halt>]} [I<name>] [I<description>]
-[I<--disk-only> [I<diskspec>]...]
+[I<--disk-only>] [[I<--diskspec>] B<diskspec>]...

to make it obvious that B<diskspec> is a literal term, optionally 
preceded by a literal --diskspec.

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




More information about the libvir-list mailing list