diff mbox series

[v3] docs: fix documentation about default scheduler

Message ID 20201117093258.26754-1-roger.pau@citrix.com (mailing list archive)
State New
Headers show
Series [v3] docs: fix documentation about default scheduler | expand

Commit Message

Roger Pau Monné Nov. 17, 2020, 9:32 a.m. UTC
Fix the command line document to account for the default scheduler in
Kconfig being credit2 now, and the fact that it's selectable at build
time and thus different builds could end up with different default
schedulers.

Fixes: dafd936dddbd ('Make credit2 the default scheduler')
Signed-off-by: Roger Pau Monné <roger.pau@citrix.com>
---
Changes since v2:
 - List credit2 as the default scheduler.
 - Note that default scheduler can be set from Kconfig.

Changes since v1:
 - Point that the default scheduler is being selected by Kconfig,
   don't mention the default Kconfig selection.
---
 docs/misc/xen-command-line.pandoc | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

Comments

Wei Liu Dec. 7, 2020, 3:40 p.m. UTC | #1
On Tue, Nov 17, 2020 at 10:32:58AM +0100, Roger Pau Monne wrote:
> Fix the command line document to account for the default scheduler in
> Kconfig being credit2 now, and the fact that it's selectable at build
> time and thus different builds could end up with different default
> schedulers.
> 
> Fixes: dafd936dddbd ('Make credit2 the default scheduler')
> Signed-off-by: Roger Pau Monné <roger.pau@citrix.com>

Well I have not seen an explicit agreement on the text from the v1
thread, and I don't have v2 in my inbox, but this patch is definitely an
improvement over the old text in that it shows the correct scheduler. In
the interest of making progress:

Acked-by: Wei Liu <wl@xen.org>

Wei.
diff mbox series

Patch

diff --git a/docs/misc/xen-command-line.pandoc b/docs/misc/xen-command-line.pandoc
index 4ae9391fcd..803243c3fa 100644
--- a/docs/misc/xen-command-line.pandoc
+++ b/docs/misc/xen-command-line.pandoc
@@ -1876,9 +1876,11 @@  with read and write permissions.
 ### sched
 > `= credit | credit2 | arinc653 | rtds | null`
 
-> Default: `sched=credit`
+> Default: `sched=credit2`
 
-Choose the default scheduler.
+Choose the default scheduler. Note the default scheduler is selectable via
+Kconfig and depends on enabled schedulers. Check
+`CONFIG_SCHED_DEFAULT` to see which scheduler is the default.
 
 ### sched_credit2_max_cpus_runqueue
 > `= <integer>`