Re: [libvirt] [PATCH 4/8] virsh: man: Add missing dashes for blockjob --bandwidth
On 04/30/2015 08:45 AM, Peter Krempa wrote:
---
tools/virsh.pod | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/tools/virsh.pod b/tools/virsh.pod
index f8496f3..f576fb0 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -1124,10 +1124,10 @@ I<--config> or I<--current> can be specified. If no
flag is specified, behavior
is different depending on hypervisor.
=item B<blockjob> I<domain> I<path> { [I<--abort>]
[I<--async>] [I<--pivot>] |
-[I<--info>] [I<--raw>] [I<--bytes>] | [I<bandwidth>] }
+[I<--info>] [I<--raw>] [I<--bytes>] | [I<--bandwidth>] }
Actually, --bandwidth takes an argument, so this could probably be
something like:
| [[I<--bandwidth>] I<bandwidth>] }
(look at how freepages lists --cellno for comparison).
Manage active block operations. There are three mutually-exclusive
modes:
-I<--info>, I<bandwidth>, and I<--abort>. I<--async> and
I<--pivot> imply
+I<--info>, I<--bandwidth>, and I<--abort>. I<--async> and
I<--pivot> imply
abort mode; I<--raw> implies info mode; and if no mode was given, I<--info>
mode is assumed.
This one is fine.
@@ -1151,7 +1151,7 @@ not supply bytes/s resolution; when omitting the flag, raw output
is
listed in MiB/s and human-readable output automatically selects the
best resolution supported by the server.
-I<bandwidth> can be used to set bandwidth limit for the active job.
+I<--bandwidth> can be used to set bandwidth limit for the active job.
Since the --bandwidth option is the only optional parameter that takes
an argument, and since we declared the modes to be mutually exclusive,
it will be identical behavior whether the user does 'blockjob $dom $path
$number' or 'blockjob $dom $path --bandwidth $number'. I'm not sure how
best to word that here; maybe:
A I<--bandwidth number> can be used to set ...
Specifying a negative value is interpreted as an unsigned long long
value or essentially unlimited. The hypervisor can choose whether to
reject the value or convert it to the maximum value allowed.
--
Eric Blake eblake redhat com +1-919-301-3266
Libvirt virtualization library http://libvirt.org
Attachments:
- signature.asc (application/pgp-signature — 604 bytes)