Commit d5090d91 authored by Randy Dunlap's avatar Randy Dunlap Committed by Steven Rostedt (Google)
Browse files

tracing/filter: fix kernel-doc warnings 

Use the 'struct' keyword for a struct's kernel-doc notation and
use the correct function parameter name to eliminate kernel-doc
warnings:

kernel/trace/trace_events_filter.c:136: warning: cannot understand function prototype: 'struct prog_entry '
kerne/trace/trace_events_filter.c:155: warning: Excess function parameter 'when_to_branch' description in 'update_preds'

Also correct some trivial punctuation problems.

Link: https://lkml.kernel.org/r/20230108021238.16398-1-rdunlap@infradead.org



Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarSteven Rostedt (Google) <rostedt@goodmis.org>
parent ca0f2cfc

kernel/trace/trace_events_filter.c

+4 −4
Original line number Diff line number Diff line
@@ -128,7 +128,7 @@ static bool is_not(const char *str) 
}



/**

 * prog_entry - a singe entry in the filter program

 * struct prog_entry - a singe entry in the filter program

 * @target:	     Index to jump to on a branch (actually one minus the index)

 * @when_to_branch:  The value of the result of the predicate to do a branch

 * @pred:	     The predicate to execute.
@@ -143,13 +143,13 @@ struct prog_entry { 
 * update_preds - assign a program entry a label target

 * @prog: The program array

 * @N: The index of the current entry in @prog

 * @when_to_branch: What to assign a program entry for its branch condition

 * @invert: What to assign a program entry for its branch condition

 *

 * The program entry at @N has a target that points to the index of a program

 * entry that can have its target and when_to_branch fields updated.

 * Update the current program entry denoted by index @N target field to be

 * that of the updated entry. This will denote the entry to update if

 * we are processing an "||" after an "&&"

 * we are processing an "||" after an "&&".

 */

static void update_preds(struct prog_entry *prog, int N, int invert)

{