From 5b7f5a049c41cfef41a27987f4918ffb066ae3a2 Mon Sep 17 00:00:00 2001 From: Stefan Hajnoczi Date: Wed, 22 Aug 2012 14:59:11 +0100 Subject: [PATCH] docs: fix blockpull/blockcopy bandwidth Mbps -> MiB/s The bandwidth units for blockpull and blockcopy are in Megabytes per Second, not Megabits per Second. Signed-off-by: Stefan Hajnoczi --- AUTHORS | 1 + src/libvirt.c | 10 +++++----- tools/virsh.pod | 4 ++-- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/AUTHORS b/AUTHORS index 289c9845cb..cea91c9af7 100644 --- a/AUTHORS +++ b/AUTHORS @@ -259,6 +259,7 @@ Patches have also been contributed by: Sukadev Bhattiprolu Thomas Woerner J.B. Joret + Stefan Hajnoczi [....send patches to get your name here....] diff --git a/src/libvirt.c b/src/libvirt.c index 60ce6d17bc..e0ac391dac 100644 --- a/src/libvirt.c +++ b/src/libvirt.c @@ -18344,7 +18344,7 @@ error: * virDomainBlockJobSetSpeed: * @dom: pointer to domain object * @disk: path to the block device, or device shorthand - * @bandwidth: specify bandwidth limit in Mbps + * @bandwidth: specify bandwidth limit in MiB/s * @flags: extra flags; not used yet, so callers should always pass 0 * * Set the maximimum allowable bandwidth that a block job may consume. If @@ -18402,7 +18402,7 @@ error: * virDomainBlockPull: * @dom: pointer to domain object * @disk: path to the block device, or device shorthand - * @bandwidth: (optional) specify copy bandwidth limit in Mbps + * @bandwidth: (optional) specify copy bandwidth limit in MiB/s * @flags: extra flags; not used yet, so callers should always pass 0 * * Populate a disk image with data from its backing image. Once all data from @@ -18419,7 +18419,7 @@ error: * can be found by calling virDomainGetXMLDesc() and inspecting * elements within //domain/devices/disk. * - * The maximum bandwidth (in Mbps) that will be used to do the copy can be + * The maximum bandwidth (in MiB/s) that will be used to do the copy can be * specified with the bandwidth parameter. If set to 0, libvirt will choose a * suitable default. Some hypervisors do not support this feature and will * return an error if bandwidth is not 0; in this case, it might still be @@ -18475,7 +18475,7 @@ error: * @dom: pointer to domain object * @disk: path to the block device, or device shorthand * @base: path to backing file to keep, or NULL for no backing file - * @bandwidth: (optional) specify copy bandwidth limit in Mbps + * @bandwidth: (optional) specify copy bandwidth limit in MiB/s * @flags: bitwise-OR of virDomainBlockRebaseFlags * * Populate a disk image with data from its backing image chain, and @@ -18535,7 +18535,7 @@ error: * can be found by calling virDomainGetXMLDesc() and inspecting * elements within //domain/devices/disk. * - * The maximum bandwidth (in Mbps) that will be used to do the copy can be + * The maximum bandwidth (in MiB/s) that will be used to do the copy can be * specified with the bandwidth parameter. If set to 0, libvirt will choose a * suitable default. Some hypervisors do not support this feature and will * return an error if bandwidth is not 0; in this case, it might still be diff --git a/tools/virsh.pod b/tools/virsh.pod index e932d7c423..424f1d989e 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -723,7 +723,7 @@ the command may continue to block a little while longer until the job is done cleaning up. I specifies fully-qualified path of the disk. -I specifies copying bandwidth limit in Mbps. +I specifies copying bandwidth limit in MiB/s. =item B I I [I] [I] [I<--wait> [I<--verbose>] [I<--timeout> B] [I<--async]] @@ -750,7 +750,7 @@ I specifies fully-qualified path of the disk; it corresponds to a unique target name () or source file () for one of the disk devices attached to I (see also B for listing these names). -I specifies copying bandwidth limit in Mbps. +I specifies copying bandwidth limit in MiB/s. =item B I I [[I<--config>] [I<--live>] | [I<--current>]]