linux-kernel - Re: [PATCH] tracing/synthetic: fix kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date: Wed, 20 Dec 2023 21:11:33 +0900
From: Masami Hiramatsu (Google) <mhiramat@...nel.org>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, Steven Rostedt <rostedt@...dmis.org>,
 Masami Hiramatsu <mhiramat@...nel.org>, Mathieu Desnoyers
 <mathieu.desnoyers@...icios.com>, linux-trace-kernel@...r.kernel.org
Subject: Re: [PATCH] tracing/synthetic: fix kernel-doc warnings

On Tue, 19 Dec 2023 22:12:26 -0800
Randy Dunlap <rdunlap@...radead.org> 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) <mhiramat@...nel.org>

> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Steven Rostedt <rostedt@...dmis.org>
> Cc: Masami Hiramatsu <mhiramat@...nel.org>
> Cc: Mathieu Desnoyers <mathieu.desnoyers@...icios.com>
> Cc: linux-trace-kernel@...r.kernel.org
> ---
>  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) <mhiramat@...nel.org>