timer: Move kerneldoc where it belongs
PATCH 1/1 timer: Move kerneldoc where it belongs
From: Thierry Reding <[email protected]>
Commit 8a49731416d9 ("timer: provide an api for deferrable timeout") only partially updates the kerneldoc comment for __schedule_timeout() which causes DocBook generation to complain about the missing description for the flag argument. The __schedule_timeout() function is locally scoped and therefore kerneldoc isn't very useful. The original schedule_timeout() function is a public and exported function, however, and therefore should have proper kerneldoc, so move the comment back to it instead.
Signed-off-by Thierry Reding <[email protected]>
--- kernel/time/timer.c | 52 ++++++++++++++++++++++++++-------------------------- 1 file changed, 26 insertions(+), 26 deletions(-)
kernel/time/timer.c +26 -26
@@ -1431,32 +1431,6 @@ static void process_timeout(unsigned long __data)wake_up_process ((struct task_struct *)__data); } -/** -* __schedule_timeout - sleep until timeout -* @timeout: timeout value in jiffies -* -* Make the current task sleep until @timeout jiffies have -* elapsed. The routine will return immediately unless -* the current task state has been set (see set_current_state()). -* -* You can set the task state as follows - -* -* %TASK_UNINTERRUPTIBLE - at least @timeout jiffies are guaranteed to -* pass before the routine returns. The routine will return 0 -* -* %TASK_INTERRUPTIBLE - the routine may return early if a signal is -* delivered to the current task. In this case the remaining time -* in jiffies will be returned, or 0 if the timer expired in time -* -* The current task state is guaranteed to be TASK_RUNNING when this -* routine returns. -* -* Specifying a @timeout value of %MAX_SCHEDULE_TIMEOUT will schedule -* the CPU away without a bound on the timeout. In this case the return -* value will be %MAX_SCHEDULE_TIMEOUT. -* -* In all cases the return value is guaranteed to be non-negative. -*/ static signed long __sched __schedule_timeout (signed long timeout,unsigned long flag) {
@@ -1514,6 +1488,32 @@ __sched __schedule_timeout(signed long timeout, unsigned long flag)return timeout <0 ?0 : timeout; } +/** +* schedule_timeout - sleep until timeout +* @timeout: timeout value in jiffies +* +* Make the current task sleep until @timeout jiffies have +* elapsed. The routine will return immediately unless +* the current task state has been set (see set_current_state()). +* +* You can set the task state as follows - +* +* %TASK_UNINTERRUPTIBLE - at least @timeout jiffies are guaranteed to +* pass before the routine returns. The routine will return 0 +* +* %TASK_INTERRUPTIBLE - the routine may return early if a signal is +* delivered to the current task. In this case the remaining time +* in jiffies will be returned, or 0 if the timer expired in time +* +* The current task state is guaranteed to be TASK_RUNNING when this +* routine returns. +* +* Specifying a @timeout value of %MAX_SCHEDULE_TIMEOUT will schedule +* the CPU away without a bound on the timeout. In this case the return +* value will be %MAX_SCHEDULE_TIMEOUT. +* +* In all cases the return value is guaranteed to be non-negative. +*/ signed long __sched schedule_timeout (signed long timeout) {return __schedule_timeout (timeout,0 );
Signature · 1 line
2.0.4