linux-trace-devel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Tzvetomir Stoyanov (VMware)" <tz.stoyanov@gmail.com>
To: rostedt@goodmis.org
Cc: linux-trace-devel@vger.kernel.org, namhyung@kernel.org
Subject: [PATCH v2 1/8] trace-cmd libtraceevent: Document tep_load_plugins_hook()
Date: Wed, 15 Jul 2020 05:30:02 +0300	[thread overview]
Message-ID: <20200715023009.2503879-2-tz.stoyanov@gmail.com> (raw)
In-Reply-To: <20200715023009.2503879-1-tz.stoyanov@gmail.com>

Add description of tep_load_plugins_hook() traceevent API.

Link: https://lore.kernel.org/linux-trace-devel/CAM9d7cgLBWCrEHwz+Lhv5x5EXGcNWB0QQoeGh3OKh2JfR=dV9Q@mail.gmail.com/
Suggested-by: Namhyung Kim <namhyung@kernel.org>
Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
---
 lib/traceevent/event-plugin.c | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/lib/traceevent/event-plugin.c b/lib/traceevent/event-plugin.c
index 30c1526d..c11636ce 100644
--- a/lib/traceevent/event-plugin.c
+++ b/lib/traceevent/event-plugin.c
@@ -544,6 +544,22 @@ load_plugins_dir(struct tep_handle *tep, const char *suffix,
 	closedir(dir);
 }
 
+/**
+ * tep_load_plugins_hook - call a user specified callback to load a plugin
+ * @tep: handler to traceevent context
+ * @suffix: filter only plugin files with given suffix
+ * @load_plugin: user specified callback, called for each plugin file
+ * @data: custom context, passed to @load_plugin
+ *
+ * Searches for traceevent plugin files and calls @load_plugin for each
+ * The order of plugins search is:
+ *  - Directories, specified in @tep->plugins_dir and priority TEP_PLUGIN_FIRST
+ *  - Directory, specified at compile time with PLUGIN_TRACEEVENT_DIR
+ *  - Directory, specified by environment variable TRACEEVENT_PLUGIN_DIR
+ *  - In user's home: ~/.local/lib/traceevent/plugins/
+ *  - Directories, specified in @tep->plugins_dir and priority TEP_PLUGIN_LAST
+ *
+ */
 void tep_load_plugins_hook(struct tep_handle *tep, const char *suffix,
 			   void (*load_plugin)(struct tep_handle *tep,
 					       const char *path,
-- 
2.26.2


  reply	other threads:[~2020-07-15  2:30 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-15  2:30 [PATCH v2 0/8] Few libtraceeevnt fixes, suggested Namhyung Kim Tzvetomir Stoyanov (VMware)
2020-07-15  2:30 ` Tzvetomir Stoyanov (VMware) [this message]
2020-07-15  2:30 ` [PATCH v2 2/8] trace-cmd libtraceevent: Handle strdup() error in parse_option_name() Tzvetomir Stoyanov (VMware)
2020-07-15  2:30 ` [PATCH v2 3/8] trace-cmd libtraceevent: Fix typo in tep_plugin_add_option() description Tzvetomir Stoyanov (VMware)
2020-07-15  2:30 ` [PATCH v2 4/8] trace-cmd libtraceevent: Improve error handling of tep_plugin_add_option() API Tzvetomir Stoyanov (VMware)
2020-07-15  2:30 ` [PATCH v2 5/8] trace-cmd libtraceevent: Fix broken indentation in parse_ip4_print_args() Tzvetomir Stoyanov (VMware)
2020-07-15  2:30 ` [PATCH v2 6/8] trace-cmd libtraceevent: Fix type in PRINT_FMT_STING Tzvetomir Stoyanov (VMware)
2020-07-15  2:30 ` [PATCH v2 7/8] trace-cmd libtraceevent: Fix description of tep_add_plugin_path() API Tzvetomir Stoyanov (VMware)
2020-07-15  2:30 ` [PATCH v2 8/8] trace-cmd libtraceevent: Handle possible strdup() error in " Tzvetomir Stoyanov (VMware)
2020-07-15  2:36 ` [PATCH v2 0/8] Few libtraceeevnt fixes, suggested Namhyung Kim Steven Rostedt
2020-07-15  4:12   ` Tzvetomir Stoyanov

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=20200715023009.2503879-2-tz.stoyanov@gmail.com \
    --to=tz.stoyanov@gmail.com \
    --cc=linux-trace-devel@vger.kernel.org \
    --cc=namhyung@kernel.org \
    --cc=rostedt@goodmis.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).