Skip to contentSkip to conversation

tracing/kprobes: Fix the description of variable length arguments

PATCH In review Yujie Liu 3 participants 3 messages Oct 27, 2023 Tracing

lore
Share & tools
lore

Yujie Liu

author
#0 lore raw

PATCH 1/1 tracing/kprobes: Fix the description of variable length arguments

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")
---
 kernel/trace/trace_kprobe.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
kernel/trace/trace_kprobe.c +2 -2
index a8fef6ab0872..95c5b0668cb7 100644
@@ -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
Signature · 1 line
2.34.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 5 lines · Yujie Liu

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'

Quoted 7 lines

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")

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.

-Mukesh

Quoted 26 lines
---
  kernel/trace/trace_kprobe.c | 4 ++--
  1 file changed, 2 insertions(+), 2 deletions(-)
kernel/trace/trace_kprobe.c +2 -2
index a8fef6ab0872..95c5b0668cb7 100644
@@ -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 lore raw
Quoted 16 lines · On Fri, 27 Oct 2023 14:10:44 +0530 Mukesh Ojha <[email protected]> wrote:
Quoted 5 lines · Yujie Liu

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'

Quoted 7 lines

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")
Quoted 6 lines

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.

Thanks! let me pick this!

Quoted 29 lines

-Mukesh

Quoted 26 lines
---
  kernel/trace/trace_kprobe.c | 4 ++--
  1 file changed, 2 insertions(+), 2 deletions(-)
kernel/trace/trace_kprobe.c +2 -2
index a8fef6ab0872..95c5b0668cb7 100644
@@ -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
Signature · 1 line
Masami Hiramatsu (Google) <[email protected]>