7548c0
From c9113d8cd9d68c932175ea63b634fc5cb7e51ef2 Mon Sep 17 00:00:00 2001
7548c0
Message-Id: <c9113d8cd9d68c932175ea63b634fc5cb7e51ef2@dist-git>
7548c0
From: Pavel Hrdina <phrdina@redhat.com>
7548c0
Date: Thu, 4 Mar 2021 12:57:56 +0100
7548c0
Subject: [PATCH] docs: use proper cpu quota value in our documentation
7548c0
MIME-Version: 1.0
7548c0
Content-Type: text/plain; charset=UTF-8
7548c0
Content-Transfer-Encoding: 8bit
7548c0
7548c0
Commit <d505b8af58912ae1e1a211fabc9995b19bd40828> changed the cpu quota
7548c0
value that reflects what kernel allows but did not update our
7548c0
documentation.
7548c0
7548c0
Signed-off-by: Pavel Hrdina <phrdina@redhat.com>
7548c0
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
7548c0
(cherry picked from commit 992635b142b261cedb6075e459918418fe6e6962)
7548c0
7548c0
Conflicts:
7548c0
    docs/formatdomain.rst
7548c0
        - missing in downstream, we use formatdomain.html.in
7548c0
7548c0
Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1798463
7548c0
7548c0
Signed-off-by: Pavel Hrdina <phrdina@redhat.com>
7548c0
Message-Id: <ba20be50c3bde1668cb214253e5ef8f212fc062b.1614858616.git.phrdina@redhat.com>
7548c0
Reviewed-by: Ján Tomko <jtomko@redhat.com>
7548c0
---
7548c0
 docs/formatdomain.html.in     | 8 ++++----
7548c0
 docs/manpages/virsh.rst       | 2 +-
7548c0
 docs/schemas/domaincommon.rng | 2 +-
7548c0
 3 files changed, 6 insertions(+), 6 deletions(-)
7548c0
7548c0
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
7548c0
index 127dd13cc0..4341e256a8 100644
7548c0
--- a/docs/formatdomain.html.in
7548c0
+++ b/docs/formatdomain.html.in
7548c0
@@ -872,7 +872,7 @@
7548c0
         bandwidth (unit: microseconds). A domain with quota as any
7548c0
         negative value indicates that the domain has infinite bandwidth for
7548c0
         vCPU threads, which means that it is not bandwidth controlled. The value
7548c0
-        should be in range [1000, 18446744073709551] or less than 0. A quota
7548c0
+        should be in range [1000, 17592186044415] or less than 0. A quota
7548c0
         with value 0 means no value. You can use this feature to ensure that all
7548c0
         vCPUs run at the same speed.
7548c0
         Only QEMU driver support since 0.9.4, LXC since
7548c0
@@ -894,7 +894,7 @@
7548c0
         domain. A domain with global_quota as any negative
7548c0
         value indicates that the domain has infinite bandwidth, which means that
7548c0
         it is not bandwidth controlled. The value should be in range
7548c0
-        [1000, 18446744073709551] or less than 0. A global_quota
7548c0
+        [1000, 17592186044415] or less than 0. A global_quota
7548c0
         with value 0 means no value.
7548c0
         Only QEMU driver support since 1.3.3
7548c0
       
7548c0
@@ -915,7 +915,7 @@
7548c0
         excluding vCPUs). A domain with emulator_quota as any negative
7548c0
         value indicates that the domain has infinite bandwidth for emulator threads
7548c0
         (those excluding vCPUs), which means that it is not bandwidth controlled.
7548c0
-        The value should be in range [1000, 18446744073709551] or less than 0. A
7548c0
+        The value should be in range [1000, 17592186044415] or less than 0. A
7548c0
         quota with value 0 means no value.
7548c0
         Only QEMU driver support since 0.10.0
7548c0
       
7548c0
@@ -937,7 +937,7 @@
7548c0
         iothread_quota as any negative value indicates that the
7548c0
         domain IOThreads have infinite bandwidth, which means that it is
7548c0
         not bandwidth controlled. The value should be in range
7548c0
-        [1000, 18446744073709551] or less than 0. An iothread_quota
7548c0
+        [1000, 17592186044415] or less than 0. An iothread_quota
7548c0
         with value 0 means no value. You can use this feature to ensure that
7548c0
         all IOThreads run at the same speed.
7548c0
         Only QEMU driver support since 2.1.0
7548c0
diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst
7548c0
index 0804465d44..a5b95c1123 100644
7548c0
--- a/docs/manpages/virsh.rst
7548c0
+++ b/docs/manpages/virsh.rst
7548c0
@@ -3715,7 +3715,7 @@ XEN_CREDIT scheduler.
7548c0
 ``Note``: The vcpu_period, emulator_period, and iothread_period parameters
7548c0
 have a valid value range of 1000-1000000 or 0, and the vcpu_quota,
7548c0
 emulator_quota, and iothread_quota parameters have a valid value range of
7548c0
-1000-18446744073709551 or less than 0. The value 0 for
7548c0
+1000-17592186044415 or less than 0. The value 0 for
7548c0
 either parameter is the same as not specifying that parameter.
7548c0
 
7548c0
 
7548c0
diff --git a/docs/schemas/domaincommon.rng b/docs/schemas/domaincommon.rng
7548c0
index 4a42cb9b40..6671ef3dfa 100644
7548c0
--- a/docs/schemas/domaincommon.rng
7548c0
+++ b/docs/schemas/domaincommon.rng
7548c0
@@ -6649,7 +6649,7 @@
7548c0
   <define name="cpuquota">
7548c0
     <data type="long">
7548c0
       <param name="pattern">-?[0-9]+</param>
7548c0
-      <param name="maxInclusive">18446744073709551</param>
7548c0
+      <param name="maxInclusive">17592186044415</param>
7548c0
       <param name='minInclusive'>-1</param>
7548c0
     </data>
7548c0
   </define>
7548c0
-- 
7548c0
2.30.0
7548c0