sched/fair: Better document newidle_balance()
authorPeter Zijlstra <peterz@infradead.org>
Fri, 8 Nov 2019 13:15:55 +0000 (14:15 +0100)
committerIngo Molnar <mingo@kernel.org>
Mon, 11 Nov 2019 07:35:18 +0000 (08:35 +0100)
commit7277a34c6be0b2972bdd1fea88c7cef409bed5b4
tree3676ac4c75f4b842510d8e9855d6bcc043d58ce7
parent6d5a763c303bc9d78b17361d30b692ba2facf9b4
sched/fair: Better document newidle_balance()

Whilst chasing the pick_next_task() race, there was some confusion
about the newidle_balance() return values. Document them.

[ mingo: Minor edits. ]

Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: bsegall@google.com
Cc: dietmar.eggemann@arm.com
Cc: juri.lelli@redhat.com
Cc: ktkhai@virtuozzo.com
Cc: mgorman@suse.de
Cc: qais.yousef@arm.com
Cc: qperret@google.com
Cc: rostedt@goodmis.org
Cc: valentin.schneider@arm.com
Cc: vincent.guittot@linaro.org
Link: https://lkml.kernel.org/r/20191108131909.488364308@infradead.org
Signed-off-by: Ingo Molnar <mingo@kernel.org>
kernel/sched/fair.c