Documentation: scheduler: fix information on arch SD flags, sched_domain and sched_debug
authorBarry Song <song.bao.hua@hisilicon.com>
Fri, 13 Nov 2020 11:50:18 +0000 (00:50 +1300)
committerPeter Zijlstra <peterz@infradead.org>
Thu, 19 Nov 2020 10:25:46 +0000 (11:25 +0100)
commit9032dc211523f7cd5395302a0658c306249553f4
tree67fcfa9213db40200681312af243736c6e65dc80
parentb5b217346de85ed1b03fdecd5c5076b34fbb2f0b
Documentation: scheduler: fix information on arch SD flags, sched_domain and sched_debug

This document seems to be out of date for many, many years. Even it has
misspelled from the first day.
ARCH_HASH_SCHED_TUNE should be ARCH_HAS_SCHED_TUNE
ARCH_HASH_SCHED_DOMAIN should be ARCH_HAS_SCHED_DOMAIN

Since v2.6.14, kernel completely deleted the relevant code and even
arch_init_sched_domains() was deleted.

Right now, kernel is asking architectures to call set_sched_topology() to
override the default sched domains.

On the other hand, to print the schedule debug information, users need to
set sched_debug cmdline or enable it by sysfs entry. So this patch also
adds the description for sched_debug.

Signed-off-by: Barry Song <song.bao.hua@hisilicon.com>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Reviewed-by: Valentin Schneider <valentin.schneider@arm.com>
Link: https://lkml.kernel.org/r/20201113115018.1628-1-song.bao.hua@hisilicon.com
Documentation/scheduler/sched-domains.rst