Re: [PATCH 1/8] trace-cmd: Document tep_load_plugins_hook()

[Steven Rostedt <rostedt@goodmis.org>]

On Tue, 14 Jul 2020 13:30:20 +0300
"Tzvetomir Stoyanov (VMware)" <tz.stoyanov@gmail.com> wrote:

> Add description of tep_load_plugins_hook() traceevent API.
> 

Should add:

Link: https://lore.kernel.org/r/CAM9d7cgLBWCrEHwz+Lhv5x5EXGcNWB0QQoeGh3OKh2JfR=dV9Q@mail.gmail.com

(you get that part after '/r/' from the message ID in the email.)

> 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

We should probably have a man page as well.

Thanks Tzvetomir!

-- Steve

> + *
> + */
>  void tep_load_plugins_hook(struct tep_handle *tep, const char *suffix,
>  			   void (*load_plugin)(struct tep_handle *tep,
>  					       const char *path,