[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] consistency of virsh help output



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.

Have a nice day,
Z.

--
Zdenek Styblik
Net/Linux admin
OS TurnovFree.net
email: stybla turnovfree net
jabber: stybla jabber turnovfree net


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]