[tip: perf/core] perf/hw_breakpoint: Fix DocBook warnings in perf hw_breakpoint

From: tip-bot2 for Haocheng Xie
Date: Thu May 27 2021 - 03:38:29 EST


The following commit has been merged into the perf/core branch of tip:

Commit-ID: 875dd7bf548104bc1d2c5784a6af6cf38215a216
Gitweb: https://git.kernel.org/tip/875dd7bf548104bc1d2c5784a6af6cf38215a216
Author: Haocheng Xie <xiehaocheng.cn@xxxxxxxxx>
AuthorDate: Thu, 27 May 2021 11:19:47 +08:00
Committer: Ingo Molnar <mingo@xxxxxxxxxx>
CommitterDate: Thu, 27 May 2021 09:35:22 +02:00

perf/hw_breakpoint: Fix DocBook warnings in perf hw_breakpoint

Fix the following W=1 kernel build warning(s):

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'

Signed-off-by: Haocheng Xie <xiehaocheng.cn@xxxxxxxxx>
Signed-off-by: Ingo Molnar <mingo@xxxxxxxxxx>
Link: https://lore.kernel.org/r/20210527031947.1801-4-xiehaocheng.cn@xxxxxxxxx
---
kernel/events/hw_breakpoint.c | 2 ++
1 file changed, 2 insertions(+)

diff --git a/kernel/events/hw_breakpoint.c b/kernel/events/hw_breakpoint.c
index b48d703..8359734 100644
--- a/kernel/events/hw_breakpoint.c
+++ b/kernel/events/hw_breakpoint.c
@@ -451,6 +451,7 @@ int register_perf_hw_breakpoint(struct perf_event *bp)
* register_user_hw_breakpoint - register a hardware breakpoint for user space
* @attr: breakpoint attributes
* @triggered: callback to trigger when we hit the breakpoint
+ * @context: context data could be used in the triggered callback
* @tsk: pointer to 'task_struct' of the process to which the address belongs
*/
struct perf_event *
@@ -550,6 +551,7 @@ EXPORT_SYMBOL_GPL(unregister_hw_breakpoint);
* register_wide_hw_breakpoint - register a wide breakpoint in the kernel
* @attr: breakpoint attributes
* @triggered: callback to trigger when we hit the breakpoint
+ * @context: context data could be used in the triggered callback
*
* @return a set of per_cpu pointers to perf events
*/