]> git.ipfire.org Git - thirdparty/libvirt.git/commit
docs: improve virsh man page synopses
authorEric Blake <eblake@redhat.com>
Thu, 14 Jul 2011 17:36:21 +0000 (11:36 -0600)
committerEric Blake <eblake@redhat.com>
Mon, 18 Jul 2011 17:19:40 +0000 (11:19 -0600)
commit08d3b0a2f8be57205973af320ece8ce36fbb5389
tree63336b219890c190e7cf9a23bb305427df156ed4
parent40798fb0d2ee5c7b76b676f06a7f385fa2195abd
docs: improve virsh man page synopses

"optional" is not a very good meta-syntactic construct in our man
page.  I scrubbed this, and additionally improved some documentation
on mutually exclusive options.  For example,

[[--live] [--config] | [--current]]

implies a set of optional flags, where within the set you can have
either --current or a choice of 0, 1, or both --live and --config.

* tools/virsh.pod: Use "[name]" rather than "optional name" for
optional arguments.
tools/virsh.pod