sched/swait: Document it clearly that the swait facilities are special and shouldn...
authorDavidlohr Bueso <dave@stgolabs.net>
Fri, 20 Oct 2017 17:13:46 +0000 (10:13 -0700)
committerIngo Molnar <mingo@kernel.org>
Mon, 23 Oct 2017 11:59:21 +0000 (13:59 +0200)
commit88796e7e5c457cae72833196cb98e6895dd107e2
treefc23dff02b405bca156a51176e9eb26eddfec331
parentbb176f67090ca54869fc1262c913aa69d2ede070
sched/swait: Document it clearly that the swait facilities are special and shouldn't be used

We currently welcome using swait over wait whenever possible because
it is a slimmer data structure. However, Linus has made it very clear
that he does not want this used, unless under very specific RT scenarios
(such as current users).

Update the comments before kernel hipsters start thinking swait is the
cool thing to do.

Signed-off-by: Davidlohr Bueso <dbueso@suse.de>
Acked-by: Luis R. Rodriguez <mcgrof@kernel.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: dave@stgolabs.net
Cc: wagi@monom.org
Link: http://lkml.kernel.org/r/20171020171346.24445-1-dave@stgolabs.net
Signed-off-by: Ingo Molnar <mingo@kernel.org>
include/linux/swait.h