sched/wait: Improve the bit-wait API parameter names in the API function prototypes
authorIngo Molnar <mingo@kernel.org>
Sun, 5 Mar 2017 10:54:46 +0000 (11:54 +0100)
committerIngo Molnar <mingo@kernel.org>
Tue, 20 Jun 2017 10:18:29 +0000 (12:18 +0200)
commit939798a072300698870b96756c38bb34c20f6c71
tree31d24914d7d72779ff401a5f4b401a90863864fe
parent76c85ddc4695bb7b8209bfeff11f5156088f9197
sched/wait: Improve the bit-wait API parameter names in the API function prototypes

Contrary to kernel tradition, most of the bit-wait function prototypes
in <linux/wait.h> don't fully define the parameter names, they only
list the types:

int out_of_line_wait_on_bit_timeout(void *, int, wait_bit_action_f *, unsigned, unsigned long);

... which is pretty passive-aggressive in terms of informing the reader
about what these functions are doing.

Fill in the parameter names, such as:

int out_of_line_wait_on_bit_timeout(void *word, int, wait_bit_action_f *action, unsigned int mode, unsigned long timeout);

Also turn spurious (and inconsistently utilized) cases of 'unsigned' into 'unsigned int'.

Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Ingo Molnar <mingo@kernel.org>
include/linux/wait.h