linux-kernel - Re: [PATCH] tracing/kprobes: Fix the description of variable length arguments

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] [thread-next>] [day] [month] [year] [list]

Date:   Fri, 27 Oct 2023 14:10:44 +0530
From:   Mukesh Ojha <quic_mojha@...cinc.com>
To:     Yujie Liu <yujie.liu@...el.com>,
        Steven Rostedt <rostedt@...dmis.org>
CC:     Masami Hiramatsu <mhiramat@...nel.org>,
        Tom Zanussi <zanussi@...nel.org>,
        <linux-kernel@...r.kernel.org>,
        <linux-trace-kernel@...r.kernel.org>,
        kernel test robot <lkp@...el.com>
Subject: Re: [PATCH] tracing/kprobes: Fix the description of variable length
 arguments



On 10/27/2023 9:43 AM, Yujie Liu wrote:
> Fix the following kernel-doc warnings:
> 
> kernel/trace/trace_kprobe.c:1029: warning: Excess function parameter 'args' description in '__kprobe_event_gen_cmd_start'
> kernel/trace/trace_kprobe.c:1097: warning: Excess function parameter 'args' description in '__kprobe_event_add_fields'
> 
> Refer to the usage of variable length arguments elsewhere in the kernel
> code, "@..." is the proper way to express it in the description.
> 
> Fixes: 2a588dd1d5d6 ("tracing: Add kprobe event command generation functions")
> Reported-by: kernel test robot <lkp@...el.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202310190437.paI6LYJF-lkp@intel.com/
> Signed-off-by: Yujie Liu <yujie.liu@...el.com>

Not related to this patch, but I see order of the argument as well is 
not proper in the document of the __kprobe_event_gen_cmd_start(),
if you can fix that too.

LGTM, Thanks for this.
Reviewed-by: Mukesh Ojha <quic_mojha@...cinc.com>

-Mukesh

> ---
>   kernel/trace/trace_kprobe.c | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/kernel/trace/trace_kprobe.c b/kernel/trace/trace_kprobe.c
> index a8fef6ab0872..95c5b0668cb7 100644
> --- a/kernel/trace/trace_kprobe.c
> +++ b/kernel/trace/trace_kprobe.c
> @@ -1007,7 +1007,7 @@ EXPORT_SYMBOL_GPL(kprobe_event_cmd_init);
>    * @name: The name of the kprobe event
>    * @loc: The location of the kprobe event
>    * @kretprobe: Is this a return probe?
> - * @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 kprobe_event_gen_cmd_start() wrapper, which automatically
> @@ -1080,7 +1080,7 @@ EXPORT_SYMBOL_GPL(__kprobe_event_gen_cmd_start);
>   /**
>    * __kprobe_event_add_fields - Add probe fields to a kprobe command from arg list
>    * @cmd: A pointer to the dynevent_cmd struct representing the new event
> - * @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 kprobe_event_add_fields() wrapper, which