All of lore.kernel.org
 help / color / mirror / Atom feed
From: Steven Rostedt <rostedt@goodmis.org>
To: Linux Trace Devel <linux-trace-devel@vger.kernel.org>
Cc: Stevie Alvarez <steviea@google.com>
Subject: [PATCH] libtracefs doc: State that tracefs_dynevent_create() is needed for tracefs_kprobe_alloc()
Date: Wed, 7 Jun 2023 14:28:00 -0400	[thread overview]
Message-ID: <20230607142800.61e56f3b@gandalf.local.home> (raw)

From: "Steven Rostedt (Google)" <rostedt@goodmis.org>

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 <steviea@google.com>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
---
 Documentation/libtracefs-kprobes.txt | 2 ++
 1 file changed, 2 insertions(+)

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
-- 
2.39.2


                 reply	other threads:[~2023-06-07 18:28 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230607142800.61e56f3b@gandalf.local.home \
    --to=rostedt@goodmis.org \
    --cc=linux-trace-devel@vger.kernel.org \
    --cc=steviea@google.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
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.