[PATCH] perf core: Fix some kernel-doc warnings.

[PATCH] perf core: Fix some kernel-doc warnings.

[Haocheng Xie]

Fix the following W=1 kernel build warning(s):
kernel/events/core.c:143: warning: Function parameter or member 'cpu' not described in 'cpu_function_call'
kernel/events/core.c:11924: warning: Function parameter or member 'flags' not described in 'sys_perf_event_open'
kernel/events/core.c:12382: warning: Function parameter or member 'overflow_handler' not described in 'perf_event_create_kernel_counter'
kernel/events/core.c:12382: warning: Function parameter or member 'context' not described in 'perf_event_create_kernel_counter'

Signed-off-by: Haocheng Xie <xiehaocheng.cn@gmail.com>
---
 kernel/events/core.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/kernel/events/core.c b/kernel/events/core.c
index 0d98d6a..7988e40 100644
--- a/kernel/events/core.c
+++ b/kernel/events/core.c
@@ -132,6 +132,7 @@ task_function_call(struct task_struct *p, remote_function_f func, void *info)
 
 /**
  * cpu_function_call - call a function on the cpu
+ * @cpu:	target cpu to queue this function
  * @func:	the function to be called
  * @info:	the function call argument
  *
@@ -11917,6 +11918,7 @@ __perf_event_ctx_lock_double(struct perf_event *group_leader,
  * @pid:		target pid
  * @cpu:		target cpu
  * @group_fd:		group leader event fd
+ * @flags:		perf event open flags
  */
 SYSCALL_DEFINE5(perf_event_open,
 		struct perf_event_attr __user *, attr_uptr,
@@ -12373,6 +12375,8 @@ SYSCALL_DEFINE5(perf_event_open,
  * @attr: attributes of the counter to create
  * @cpu: cpu in which the counter is bound
  * @task: task to profile (NULL for percpu)
+ * @overflow_handler: callback to trigger when we hit the event
+ * @context: context data could be used in overflow_handler callback
  */
 struct perf_event *
 perf_event_create_kernel_counter(struct perf_event_attr *attr, int cpu,
-- 
2.9.5

Re: [PATCH] perf core: Fix some kernel-doc warnings.

[Ingo Molnar]

* Haocheng Xie <xiehaocheng.cn@gmail.com> wrote:

> Fix the following W=1 kernel build warning(s):
> kernel/events/core.c:143: warning: Function parameter or member 'cpu' not described in 'cpu_function_call'
> kernel/events/core.c:11924: warning: Function parameter or member 'flags' not described in 'sys_perf_event_open'
> kernel/events/core.c:12382: warning: Function parameter or member 'overflow_handler' not described in 'perf_event_create_kernel_counter'
> kernel/events/core.c:12382: warning: Function parameter or member 'context' not described in 'perf_event_create_kernel_counter'
> 
> Signed-off-by: Haocheng Xie <xiehaocheng.cn@gmail.com>

Even with your two patches there's still W=1 warnings remaining in 
kernel/events/:

  kernel/events/hw_breakpoint.c:461: warning: Function parameter or member 'context' not described in 'register_user_hw_breakpoint'
  kernel/events/hw_breakpoint.c:560: warning: Function parameter or member 'context' not described in 'register_wide_hw_breakpoint'

Could you please fix all of them, and send them as a 3-patch series? 

Doesn't make much sense to just partially fix W=1 warnings in a subsystem.

Thanks,

	Ingo

Re:[PATCH] perf core: Fix some kernel-doc warnings.

[Haocheng Xie]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=y, Size: 1386 bytes --]

Ingo Molnar <mingo@kernel.org> wrote：
>
>
> * Haocheng Xie <xiehaocheng.cn@gmail.com> wrote:
>
> > Fix the following W=1 kernel build warning(s):
> > kernel/events/core.c:143: warning: Function parameter or member 'cpu' not described in 'cpu_function_call'
> > kernel/events/core.c:11924: warning: Function parameter or member 'flags' not described in 'sys_perf_event_open'
> > kernel/events/core.c:12382: warning: Function parameter or member 'overflow_handler' not described in 'perf_event_create_kernel_counter'
> > kernel/events/core.c:12382: warning: Function parameter or member 'context' not described in 'perf_event_create_kernel_counter'
> >
> > Signed-off-by: Haocheng Xie <xiehaocheng.cn@gmail.com>
>
> Even with your two patches there's still W=1 warnings remaining in
> kernel/events/:
>
>   kernel/events/hw_breakpoint.c:461: warning: Function parameter or member 'context' not described in 'register_user_hw_breakpoint'
>   kernel/events/hw_breakpoint.c:560: warning: Function parameter or member 'context' not described in 'register_wide_hw_breakpoint'
>
> Could you please fix all of them, and send them as a 3-patch series?

OK, I will fix these warnings and resend the 3-patch series later.

>
> Doesn't make much sense to just partially fix W=1 warnings in a subsystem.
>
> Thanks,
>
>         Ingo

Thanks for your kind advice.

Best regards,

Haocheng Xie