Skip to content

Commit c68c9ec

Browse files
Jakub Kicinskirostedt
authored andcommitted
tracing: Correct kdoc formats
Fix the following kdoc warnings: kernel/trace/trace.c:1579: warning: Function parameter or member 'tr' not described in 'update_max_tr_single' kernel/trace/trace.c:1579: warning: Function parameter or member 'tsk' not described in 'update_max_tr_single' kernel/trace/trace.c:1579: warning: Function parameter or member 'cpu' not described in 'update_max_tr_single' kernel/trace/trace.c:1776: warning: Function parameter or member 'type' not described in 'register_tracer' kernel/trace/trace.c:2239: warning: Function parameter or member 'task' not described in 'tracing_record_taskinfo' kernel/trace/trace.c:2239: warning: Function parameter or member 'flags' not described in 'tracing_record_taskinfo' kernel/trace/trace.c:2269: warning: Function parameter or member 'prev' not described in 'tracing_record_taskinfo_sched_switch' kernel/trace/trace.c:2269: warning: Function parameter or member 'next' not described in 'tracing_record_taskinfo_sched_switch' kernel/trace/trace.c:2269: warning: Function parameter or member 'flags' not described in 'tracing_record_taskinfo_sched_switch' kernel/trace/trace.c:3078: warning: Function parameter or member 'ip' not described in 'trace_vbprintk' kernel/trace/trace.c:3078: warning: Function parameter or member 'fmt' not described in 'trace_vbprintk' kernel/trace/trace.c:3078: warning: Function parameter or member 'args' not described in 'trace_vbprintk' Link: http://lkml.kernel.org/r/[email protected] Signed-off-by: Jakub Kicinski <[email protected]> Signed-off-by: Steven Rostedt (VMware) <[email protected]>
1 parent 2e81562 commit c68c9ec

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

kernel/trace/trace.c

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1567,9 +1567,9 @@ update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu,
15671567

15681568
/**
15691569
* update_max_tr_single - only copy one trace over, and reset the rest
1570-
* @tr - tracer
1571-
* @tsk - task with the latency
1572-
* @cpu - the cpu of the buffer to copy.
1570+
* @tr: tracer
1571+
* @tsk: task with the latency
1572+
* @cpu: the cpu of the buffer to copy.
15731573
*
15741574
* Flip the trace of a single CPU buffer between the @tr and the max_tr.
15751575
*/
@@ -1767,7 +1767,7 @@ static void __init apply_trace_boot_options(void);
17671767

17681768
/**
17691769
* register_tracer - register a tracer with the ftrace system.
1770-
* @type - the plugin for the tracer
1770+
* @type: the plugin for the tracer
17711771
*
17721772
* Register a new plugin tracer.
17731773
*/
@@ -2230,9 +2230,9 @@ static bool tracing_record_taskinfo_skip(int flags)
22302230
/**
22312231
* tracing_record_taskinfo - record the task info of a task
22322232
*
2233-
* @task - task to record
2234-
* @flags - TRACE_RECORD_CMDLINE for recording comm
2235-
* - TRACE_RECORD_TGID for recording tgid
2233+
* @task: task to record
2234+
* @flags: TRACE_RECORD_CMDLINE for recording comm
2235+
* TRACE_RECORD_TGID for recording tgid
22362236
*/
22372237
void tracing_record_taskinfo(struct task_struct *task, int flags)
22382238
{
@@ -2258,10 +2258,10 @@ void tracing_record_taskinfo(struct task_struct *task, int flags)
22582258
/**
22592259
* tracing_record_taskinfo_sched_switch - record task info for sched_switch
22602260
*
2261-
* @prev - previous task during sched_switch
2262-
* @next - next task during sched_switch
2263-
* @flags - TRACE_RECORD_CMDLINE for recording comm
2264-
* TRACE_RECORD_TGID for recording tgid
2261+
* @prev: previous task during sched_switch
2262+
* @next: next task during sched_switch
2263+
* @flags: TRACE_RECORD_CMDLINE for recording comm
2264+
* TRACE_RECORD_TGID for recording tgid
22652265
*/
22662266
void tracing_record_taskinfo_sched_switch(struct task_struct *prev,
22672267
struct task_struct *next, int flags)
@@ -3072,7 +3072,9 @@ static void trace_printk_start_stop_comm(int enabled)
30723072

30733073
/**
30743074
* trace_vbprintk - write binary msg to tracing buffer
3075-
*
3075+
* @ip: The address of the caller
3076+
* @fmt: The string format to write to the buffer
3077+
* @args: Arguments for @fmt
30763078
*/
30773079
int trace_vbprintk(unsigned long ip, const char *fmt, va_list args)
30783080
{

0 commit comments

Comments
 (0)