From: Osier Yang <jyang@redhat.com>
Date: Tue, 1 Feb 2011 08:46:17 +0000 (+0800)
Subject: docs: Update docs for cpu_shares setting
X-Git-Tag: v0.8.8~100
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8168285b450ebe9f6e4ac2c3d8f107ca7c581119;p=thirdparty%2Flibvirt.git

docs: Update docs for cpu_shares setting

* tools/virsh.pod
---

diff --git a/tools/virsh.pod b/tools/virsh.pod
index 441ca8a4ac..d6a16f2d4f 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -566,7 +566,9 @@ Xen (credit scheduler): weight, cap
 
 ESX (allocation scheduler): reservation, limit, shares
 
-B<Note>: The cpu_shares parameter has a valid value range of 0-262144.
+B<Note>: The cpu_shares parameter has a valid value range of 0-262144; Negative
+values are wrapped to positive, and larger values are capped at the maximum.
+Therefore, -1 is a useful shorthand for 262144.
 
 B<Note>: The weight and cap parameters are defined only for the
 XEN_CREDIT scheduler and are now I<DEPRECATED>.