[libvirt] consistency of virsh help output

[Justin Clift]

On 03/02/2011, at 8:31 PM, Zdenek Styblik wrote:
> Hello,
> 
> I've found virsh help output to be inconsistent.
> 
> ~~~ SNIP ~~~
> attach-disk <domain> <source> <target> [--driver <string>]...
> 
> X
> 
> attach-interface <domain> <type> <source> [<target>] ...
> ~~~ SNIP ~~~
> 
> where <KEYWORD> is usually explained in OPTIONS as:
> ~~~ SNIP ~~~
> [--domain] <string>  domain name, id or uuid
> ~~~ SNIP ~~~
> 
> Substitution of <domain> -> [--domain] <string> resp. that you can only provide a <string> without [--domain] and it's still going to work. This took me some time to figure out. But back on point.
> 
> As you can see from snips, once you use eg. <domain> and substitution resp. explanation is in OPTIONS and second you put "explanation" right into SYNOPSIS.
> 
> I think it would be worth of cleaning out and make everything one way or another. Would it be a problem? I presume it's just matter of modifying "couple" printf()-s.

Yeah, consistency would definitely be good, and you're right, it probably would be just a matter of modifying printf() types of statements.

You're definitely welcome to create patches to accomplish this if you want. :)

+ Justin