Skip to content

Commit

Permalink
latencytop: use correct kernel-doc format for func params
Browse files Browse the repository at this point in the history
Use a ':' instead of a '-' after function parameters to eliminate
kernel-doc warnings.

kernel/latencytop.c:177: warning: Function parameter or struct member 'tsk' not described in '__account_scheduler_latency'
../kernel/latencytop.c:177: warning: Function parameter or struct member 'usecs' not described in '__account_scheduler_latency'
../kernel/latencytop.c:177: warning: Function parameter or struct member 'inter' not described in '__account_scheduler_latency'

Link: https://lkml.kernel.org/r/20250111063019.910730-1-rdunlap@infradead.org
Fixes: ad0b0fd ("sched, latencytop: incorporate review feedback from Andrew Morton")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
  • Loading branch information
Randy Dunlap authored and Andrew Morton committed Jan 25, 2025
1 parent 2b97aaf commit 6907944
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions kernel/latencytop.c
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,9 @@ account_global_scheduler_latency(struct task_struct *tsk,

/**
* __account_scheduler_latency - record an occurred latency
* @tsk - the task struct of the task hitting the latency
* @usecs - the duration of the latency in microseconds
* @inter - 1 if the sleep was interruptible, 0 if uninterruptible
* @tsk: the task struct of the task hitting the latency
* @usecs: the duration of the latency in microseconds
* @inter: 1 if the sleep was interruptible, 0 if uninterruptible
*
* This function is the main entry point for recording latency entries
* as called by the scheduler.
Expand Down

0 comments on commit 6907944

Please sign in to comment.