Skip to contentSkip to conversation

docs: fix documentation about default scheduler

PATCH In review Roger Pau Monne 2 participants 2 messages Nov 17, 2020 – Dec 7, 2020

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 docs: fix documentation about default scheduler

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')

---
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(-)
docs/misc/xen-command-line.pandoc +4 -2
index 4ae9391fcd..803243c3fa 100644
@@ -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>`
Signature · 1 line
2.29.2
Acked-by on v3 1/1
#1 lore raw
Quoted 7 lines · Roger Pau Monne

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')

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:

Wei.