scripts/kernel-doc warns about using @args: for variadic arguments to
functions. Documentation/doc-guide/kernel-doc.rst says that this should
be written as @...: instead, so update the source code to match that,
preventing the warnings.
trace_events_synth.c:1165: warning: Excess function parameter 'args' description in '__synth_event_gen_cmd_start'
trace_events_synth.c:1714: warning: Excess function parameter 'args' description in 'synth_event_trace'
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Steven Rostedt <[email protected]>
Cc: Masami Hiramatsu <[email protected]>
Cc: Mathieu Desnoyers <[email protected]>
Cc: [email protected]
---
kernel/trace/trace_events_synth.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff -- a/kernel/trace/trace_events_synth.c b/kernel/trace/trace_events_synth.c
--- a/kernel/trace/trace_events_synth.c
+++ b/kernel/trace/trace_events_synth.c
@@ -1137,7 +1137,7 @@ EXPORT_SYMBOL_GPL(synth_event_add_fields
* @cmd: A pointer to the dynevent_cmd struct representing the new event
* @name: The name of the synthetic event
* @mod: The module creating the event, NULL if not created from a module
- * @args: Variable number of arg (pairs), one pair for each field
+ * @...: Variable number of arg (pairs), one pair for each field
*
* NOTE: Users normally won't want to call this function directly, but
* rather use the synth_event_gen_cmd_start() wrapper, which
@@ -1695,7 +1695,7 @@ __synth_event_trace_end(struct synth_eve
* synth_event_trace - Trace a synthetic event
* @file: The trace_event_file representing the synthetic event
* @n_vals: The number of values in vals
- * @args: Variable number of args containing the event values
+ * @...: Variable number of args containing the event values
*
* Trace a synthetic event using the values passed in the variable
* argument list.
On Tue, 19 Dec 2023 22:12:26 -0800
Randy Dunlap <[email protected]> wrote:
> scripts/kernel-doc warns about using @args: for variadic arguments to
> functions. Documentation/doc-guide/kernel-doc.rst says that this should
> be written as @...: instead, so update the source code to match that,
> preventing the warnings.
>
> trace_events_synth.c:1165: warning: Excess function parameter 'args' description in '__synth_event_gen_cmd_start'
> trace_events_synth.c:1714: warning: Excess function parameter 'args' description in 'synth_event_trace'
>
Thanks, this looks good to me.
Acked-by: Masami Hiramatsu (Google) <[email protected]>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Steven Rostedt <[email protected]>
> Cc: Masami Hiramatsu <[email protected]>
> Cc: Mathieu Desnoyers <[email protected]>
> Cc: [email protected]
> ---
> kernel/trace/trace_events_synth.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff -- a/kernel/trace/trace_events_synth.c b/kernel/trace/trace_events_synth.c
> --- a/kernel/trace/trace_events_synth.c
> +++ b/kernel/trace/trace_events_synth.c
> @@ -1137,7 +1137,7 @@ EXPORT_SYMBOL_GPL(synth_event_add_fields
> * @cmd: A pointer to the dynevent_cmd struct representing the new event
> * @name: The name of the synthetic event
> * @mod: The module creating the event, NULL if not created from a module
> - * @args: Variable number of arg (pairs), one pair for each field
> + * @...: Variable number of arg (pairs), one pair for each field
> *
> * NOTE: Users normally won't want to call this function directly, but
> * rather use the synth_event_gen_cmd_start() wrapper, which
> @@ -1695,7 +1695,7 @@ __synth_event_trace_end(struct synth_eve
> * synth_event_trace - Trace a synthetic event
> * @file: The trace_event_file representing the synthetic event
> * @n_vals: The number of values in vals
> - * @args: Variable number of args containing the event values
> + * @...: Variable number of args containing the event values
> *
> * Trace a synthetic event using the values passed in the variable
> * argument list.
--
Masami Hiramatsu (Google) <[email protected]>