libtracefs doc: State that tracefs_dynevent_create() is needed for tracefs_kprobe_alloc()

Commit Message

Steven Rostedt June 7, 2023, 6:28 p.m. UTC

From: "Steven Rostedt (Google)" <[e-mail]>

The man page for tracefs_kprobe_alloc() states that it does not create a
kprobe in the system, but fails to state how one should be created. Add a
comment that informs the reader that the returned descriptor can be passed
to tracefs_dynevent_create() to create it in the system.

Reported-by: Stevie Alvarez <[e-mail]>
Signed-off-by: Steven Rostedt (Google) <[e-mail]>
---
 Documentation/libtracefs-kprobes.txt | 2 ++
 1 file changed, 2 insertions(+)

Patch

diff --git a/Documentation/libtracefs-kprobes.txt b/Documentation/libtracefs-kprobes.txt
index f03b096778a5..199379ade7f7 100644
--- a/Documentation/libtracefs-kprobes.txt
+++ b/Documentation/libtracefs-kprobes.txt
@@ -30,6 +30,8 @@  int *tracefs_kprobe_destroy*(const char pass:[*]_system_, const char pass:[*]_ev
 DESCRIPTION
 -----------
 *tracefs_kprobe_alloc*() allocates a new kprobe context. The kbrobe is not configured in the system.
+The kprobe can be added to the system by passing in the returned descriptor into
+*tracefs_dynevent_create(3)*.
 The new kprobe will be in the _system_ group (or kprobes if _system_ is NULL) and have the name of
 _event_ (or _addr_ if _event_ is NULL). The kprobe will be inserted to _addr_ (function name, with
 or without offset, or a address), and the _format_ will define the format of the kprobe. See the