Commit 69079443 authored Jan 10, 2025 by Randy Dunlap Committed by Andrew Morton Jan 24, 2025

latencytop: use correct kernel-doc format for func params

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: ad0b0fd5 ("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>

parent 2b97aaf7

kernel/latencytop.c

+3 −3

Original line number	Diff line number	Diff line
		@@ -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.