Commit c68c9ec1 authored by Jakub Kicinski's avatar Jakub Kicinski Committed by Steven Rostedt (VMware)
Browse files

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/20190828052549.2472-2-jakub.kicinski@netronome.com



Signed-off-by: default avatarJakub Kicinski <jakub.kicinski@netronome.com>
Signed-off-by: default avatarSteven Rostedt (VMware) <rostedt@goodmis.org>
parent 2e815627

kernel/trace/trace.c

+14 −12
Original line number Original line Diff line number Diff line
@@ -1567,9 +1567,9 @@ update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu, 




/**

/**

 * update_max_tr_single - only copy one trace over, and reset the rest

 * update_max_tr_single - only copy one trace over, and reset the rest

 * @tr - tracer

 * @tr: tracer

 * @tsk - task with the latency

 * @tsk: task with the latency

 * @cpu - the cpu of the buffer to copy.

 * @cpu: the cpu of the buffer to copy.

 *

 *

 * Flip the trace of a single CPU buffer between the @tr and the max_tr.

 * Flip the trace of a single CPU buffer between the @tr and the max_tr.

 */

 */
@@ -1767,7 +1767,7 @@ static void __init apply_trace_boot_options(void); 




/**

/**

 * register_tracer - register a tracer with the ftrace system.

 * register_tracer - register a tracer with the ftrace system.

 * @type - the plugin for the tracer

 * @type: the plugin for the tracer

 *

 *

 * Register a new plugin tracer.

 * Register a new plugin tracer.

 */

 */
@@ -2230,9 +2230,9 @@ static bool tracing_record_taskinfo_skip(int flags) 
/**

/**

 * tracing_record_taskinfo - record the task info of a task

 * tracing_record_taskinfo - record the task info of a task

 *

 *

 * @task  - task to record

 * @task:  task to record

 * @flags - TRACE_RECORD_CMDLINE for recording comm

 * @flags: TRACE_RECORD_CMDLINE for recording comm

 *        - TRACE_RECORD_TGID for recording tgid

 *         TRACE_RECORD_TGID for recording tgid

 */

 */

void tracing_record_taskinfo(struct task_struct *task, int flags)

void tracing_record_taskinfo(struct task_struct *task, int flags)

{

{
@@ -2258,9 +2258,9 @@ void tracing_record_taskinfo(struct task_struct *task, int flags) 
/**

/**

 * tracing_record_taskinfo_sched_switch - record task info for sched_switch

 * tracing_record_taskinfo_sched_switch - record task info for sched_switch

 *

 *

 * @prev - previous task during sched_switch

 * @prev: previous task during sched_switch

 * @next - next task during sched_switch

 * @next: next task during sched_switch

 * @flags - TRACE_RECORD_CMDLINE for recording comm

 * @flags: TRACE_RECORD_CMDLINE for recording comm

 *         TRACE_RECORD_TGID for recording tgid

 *         TRACE_RECORD_TGID for recording tgid

 */

 */

void tracing_record_taskinfo_sched_switch(struct task_struct *prev,

void tracing_record_taskinfo_sched_switch(struct task_struct *prev,
@@ -3072,7 +3072,9 @@ static void trace_printk_start_stop_comm(int enabled) 




/**

/**

 * trace_vbprintk - write binary msg to tracing buffer

 * trace_vbprintk - write binary msg to tracing buffer

 *

 * @ip:    The address of the caller

 * @fmt:   The string format to write to the buffer

 * @args:  Arguments for @fmt

 */

 */

int trace_vbprintk(unsigned long ip, const char *fmt, va_list args)

int trace_vbprintk(unsigned long ip, const char *fmt, va_list args)

{

{

CRA Git | Maintained and supported by SUSTech CRA and CCSE