[Xen-devel] [PATCH] docs: Update credit/credit2 feature docs reflecting new default scheduler

[George Dunlap <george.dunlap@xxxxxxxxxx>]

Signed-off-by: George Dunlap <george.dunlap@xxxxxxxxxx>
---
Release justification:
 - "Bug" in docs (credit1 is no longer default)
 - No functional change

CC: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
CC: Ian Jackson <ian.jackson@xxxxxxxxxxxxx>
CC: Jan Beulich <jbeulich@xxxxxxxx>
CC: Julien Grall <julien.grall@xxxxxxx>
CC: Konrad Rzeszutek Wilk <konrad.wilk@xxxxxxxxxx>
CC: Stefano Stabellini <sstabellini@xxxxxxxxxx>
CC: Tim Deegan <tim@xxxxxxx>
CC: Wei Liu <wei.liu2@xxxxxxxxxx>
CC: Juergen Gross <jgross@xxxxxxxx>
CC: Lars Kurth <lars.kurth@xxxxxxxxxx>
---
 docs/features/sched_credit.pandoc  | 11 +++++++----
 docs/features/sched_credit2.pandoc | 15 +++++++--------
 2 files changed, 14 insertions(+), 12 deletions(-)

diff --git a/docs/features/sched_credit.pandoc 
b/docs/features/sched_credit.pandoc
index 79587d8ad9..706513de6e 100644
--- a/docs/features/sched_credit.pandoc
+++ b/docs/features/sched_credit.pandoc
@@ -12,16 +12,18 @@
 
 # Overview
 
-Credit (also known as Credit1) is the default virtual CPU (vCPU) scheduler
+Credit (also known as Credit1) is the old virtual CPU (vCPU) scheduler
 of the Xen hypervisor.
 
 It is a general purpose, weighted fair-share scheduler.
 
 # User details
 
-Xen supports multiple schedulers. As said, Credit is the default, so it
-is used automatically, unless the `sched=$SCHED` (with `$SCHED` different
-than `credit`) parameter is passed to Xen via the bootloader.
+Xen supports multiple schedulers. Credit is no longer the default.  In
+order to use it as the Xen scheduler the following parameter should be
+passed to the hypervisor at boot:
+
+    `sched=credit`
 
 Once the system is live, for creating a cpupool with Credit as its
 scheduler, either compile a cpupool configuration file, as described
@@ -94,4 +96,5 @@ by also doing the following:
 Date       Revision Version  Notes
 ---------- -------- -------- -------------------------------------------
 2016-10-14 1        Xen 4.8  Document written
+2019-02-7  3        Xen 4.12 No longer default scheduler
 ---------- -------- -------- -------------------------------------------
diff --git a/docs/features/sched_credit2.pandoc 
b/docs/features/sched_credit2.pandoc
index bce843e1fc..436ff9f8f6 100644
--- a/docs/features/sched_credit2.pandoc
+++ b/docs/features/sched_credit2.pandoc
@@ -12,21 +12,19 @@
 
 # Overview
 
-Credit2 is one of the virtual CPU (vCPU) scheduler available in the
+Credit2 is the default virtual CPU (vCPU) scheduler available in the
 Xen hypervisor.
 
 Credit2 was designed as a general purpose scheduler, with particular
 focus on improving handling of mixed workloads, scalability and
-support for low latency applications inside VMs, with respect to
-Credit1.
+support for low latency applications inside VMs.
 
 # User details
 
-Credit2 is not in use by default. In order to use it as the Xen
-scheduler the following parameter should be passed to the hypervisor
-at boot:
-
-    `sched=credit2`
+Xen supports multiple schedulers. As said, Credit2 is the default, so
+it is used automatically, unless the `sched=$SCHED` (with `$SCHED`
+different than `credit2`) parameter is passed to Xen via the
+bootloader.
 
 Other parameters are available for tuning the behavior of Credit2
 (see `docs/misc/xen-command-line.markdown` for a complete list and
@@ -106,4 +104,5 @@ Date       Revision Version  Notes
 ---------- -------- -------- -------------------------------------------
 2016-10-14 1        Xen 4.8  Document written
 2017-11-6  2        Xen 4.10 Soft-affinity and caps implemented
+2019-02-7  3        Xen 4.12 Made the default scheduler
 ---------- -------- -------- -------------------------------------------
-- 
2.20.1


_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/mailman/listinfo/xen-devel