sched/completion: Document that reinit_completion() must be called after complete_all()
authorSteven Rostedt <rostedt@goodmis.org>
Wed, 16 Aug 2017 17:12:02 +0000 (13:12 -0400)
committerIngo Molnar <mingo@kernel.org>
Wed, 16 Aug 2017 18:08:10 +0000 (20:08 +0200)
commit9c8783201cb58e9af8ddeb0cc68f37b0a44ca16c
tree212c0a154e726ca945bc890886a1190e60568c31
parent1e58565e6d147751d85ee9e692d1226059b3318f
sched/completion: Document that reinit_completion() must be called after complete_all()

The complete_all() function modifies the completion's "done" variable to
UINT_MAX, and no other caller (wait_for_completion(), etc) will modify
it back to zero. That means that any call to complete_all() must have a
reinit_completion() before that completion can be used again.

Document this fact by the complete_all() function.

Also document that completion_done() will always return true if
complete_all() is called.

Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Acked-by: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Link: http://lkml.kernel.org/r/20170816131202.195c2f4b@gandalf.local.home
Signed-off-by: Ingo Molnar <mingo@kernel.org>
kernel/sched/completion.c