* [PATCH] tracing/kprobes: Fix the description of variable length arguments
@ 2023-10-27 4:13 Yujie Liu
2023-10-27 8:40 ` Mukesh Ojha
0 siblings, 1 reply; 3+ messages in thread
From: Yujie Liu @ 2023-10-27 4:13 UTC (permalink / raw)
To: Steven Rostedt
Cc: Masami Hiramatsu, Tom Zanussi, linux-kernel, linux-trace-kernel,
kernel test robot
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@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202310190437.paI6LYJF-lkp@intel.com/
Signed-off-by: Yujie Liu <yujie.liu@intel.com>
---
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
--
2.34.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] tracing/kprobes: Fix the description of variable length arguments
2023-10-27 4:13 [PATCH] tracing/kprobes: Fix the description of variable length arguments Yujie Liu
@ 2023-10-27 8:40 ` Mukesh Ojha
2023-10-27 13:18 ` Masami Hiramatsu
0 siblings, 1 reply; 3+ messages in thread
From: Mukesh Ojha @ 2023-10-27 8:40 UTC (permalink / raw)
To: Yujie Liu, Steven Rostedt
Cc: Masami Hiramatsu, Tom Zanussi, linux-kernel, linux-trace-kernel,
kernel test robot
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@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202310190437.paI6LYJF-lkp@intel.com/
> Signed-off-by: Yujie Liu <yujie.liu@intel.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@quicinc.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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] tracing/kprobes: Fix the description of variable length arguments
2023-10-27 8:40 ` Mukesh Ojha
@ 2023-10-27 13:18 ` Masami Hiramatsu
0 siblings, 0 replies; 3+ messages in thread
From: Masami Hiramatsu @ 2023-10-27 13:18 UTC (permalink / raw)
To: Mukesh Ojha
Cc: Yujie Liu, Steven Rostedt, Masami Hiramatsu, Tom Zanussi,
linux-kernel, linux-trace-kernel, kernel test robot
On Fri, 27 Oct 2023 14:10:44 +0530
Mukesh Ojha <quic_mojha@quicinc.com> wrote:
>
>
> 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@intel.com>
> > Closes: https://lore.kernel.org/oe-kbuild-all/202310190437.paI6LYJF-lkp@intel.com/
> > Signed-off-by: Yujie Liu <yujie.liu@intel.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@quicinc.com>
Thanks! let me pick this!
>
> -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
--
Masami Hiramatsu (Google) <mhiramat@kernel.org>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-10-27 13:18 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-10-27 4:13 [PATCH] tracing/kprobes: Fix the description of variable length arguments Yujie Liu
2023-10-27 8:40 ` Mukesh Ojha
2023-10-27 13:18 ` Masami Hiramatsu
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.