Linux-Trace-Devel Archive on lore.kernel.org
 help / color / Atom feed
From: Steven Rostedt <rostedt@goodmis.org>
To: "Tzvetomir Stoyanov (VMware)" <tz.stoyanov@gmail.com>
Cc: arnaldo.melo@gmail.com, linux-trace-devel@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	"Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
Subject: Re: [PATCH 1/2] tools lib traceevent: Man page for tep_add_plugin_path() API
Date: Tue, 29 Sep 2020 17:56:55 -0400
Message-ID: <20200929175655.43c71137@gandalf.local.home> (raw)
In-Reply-To: <20200929173632.252076-1-tz.stoyanov@gmail.com>


[ Added Michael to the Cc ]

On Tue, 29 Sep 2020 20:36:32 +0300
"Tzvetomir Stoyanov (VMware)" <tz.stoyanov@gmail.com> wrote:

> Add documentation of tep_add_plugin_path() API in the libtraceevent plugin man page.


Nit, but the above should be no more than 74 (I do 76) characters wide.

> 
> Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
> ---
>  .../Documentation/libtraceevent-plugins.txt   | 22 +++++++++++++++++--
>  1 file changed, 20 insertions(+), 2 deletions(-)
> 
> diff --git a/tools/lib/traceevent/Documentation/libtraceevent-plugins.txt b/tools/lib/traceevent/Documentation/libtraceevent-plugins.txt
> index 4d6394397d92..e584b8c777ad 100644
> --- a/tools/lib/traceevent/Documentation/libtraceevent-plugins.txt
> +++ b/tools/lib/traceevent/Documentation/libtraceevent-plugins.txt
> @@ -3,7 +3,7 @@ libtraceevent(3)
>  
>  NAME
>  ----
> -tep_load_plugins, tep_unload_plugins, tep_load_plugins_hook - Load / unload traceevent plugins.
> +tep_load_plugins, tep_unload_plugins, tep_load_plugins_hook, tep_add_plugin_path - Load / unload traceevent plugins.
>  
>  SYNOPSIS
>  --------
> @@ -19,6 +19,8 @@ void *tep_load_plugins_hook*(struct tep_handle pass:[*]_tep_, const char pass:[*
>  					       const char pass:[*]name,
>  					       void pass:[*]data),
>  			   void pass:[*]_data_);
> +int *tep_add_plugin_path*(struct tep_handle pass:[*]tep, char pass:[*]path,
> +			  enum tep_plugin_load_priority prio);
>  --
>  
>  DESCRIPTION
> @@ -52,16 +54,30 @@ _tep_load_plugins()_. The _tep_ argument is trace event parser context. The
>  _plugin_list_ is the list of loaded plugins, returned by
>  the _tep_load_plugins()_ function.
>  
> -The _tep_load_plugins_hook_ function walks through all directories with plugins
> +The _tep_load_plugins_hook()_ function walks through all directories with plugins
>  and calls user specified _load_plugin()_ hook for each plugin file. Only files
>  with given _suffix_ are considered to be plugins. The _data_ is a user specified
>  context, passed to _load_plugin()_. Directories and the walk order are the same
>  as in _tep_load_plugins()_ API.
>  
> +The _tep_add_plugin_path()_ functions adds additional directories with plugins in
> +the _tep_->plugins_dir list. It must be called before _tep_load_plugins()_ in order
> +the plugins from the new directories to be loaded. The _tep_ argument is trace event

"in order for the plugins" .. "is the trace event parser"


> +parser context. The _path_ is the full path to the new plugin directory. The _prio_
> +argument specifies the loading priority of plugins from the new directory. The loading

"specifies the loading priority order for the new directory of plugins"

> +priority is important in case of different versions of the same plugin located in
> +multiple plugin directories.The last loaded plugin wins. The priority can be:
> +[verse]
> +--
> +	_TEP_PLUGIN_FIRST_	- Load plugins from this directory first
> +	_TEP_PLUGIN_LAST_	- Load plugins from this directory last
> +--

"Where the plugins in TEP_PLUGIN_LAST" will take precedence over the
plugins in the other directories."

> +
>  RETURN VALUE
>  ------------
>  The _tep_load_plugins()_ function returns a list of successfully loaded plugins,
>  or NULL in case no plugins are loaded.
> +The _tep_add_plugin_path()_ function returns -1 in case of an error, 0 otherwise.
>  

-- Steve

>  EXAMPLE
>  -------
> @@ -71,6 +87,8 @@ EXAMPLE
>  ...
>  struct tep_handle *tep = tep_alloc();
>  ...
> +tep_add_plugin_path(tep, "~/dev_plugins", TEP_PLUGIN_LAST);
> +...
>  struct tep_plugin_list *plugins = tep_load_plugins(tep);
>  if (plugins == NULL) {
>  	/* no plugins are loaded */


  reply index

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-29 17:36 Tzvetomir Stoyanov (VMware)
2020-09-29 21:56 ` Steven Rostedt [this message]
  -- strict thread matches above, loose matches on Subject: below --
2020-09-24  8:57 Tzvetomir Stoyanov (VMware)

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=20200929175655.43c71137@gandalf.local.home \
    --to=rostedt@goodmis.org \
    --cc=arnaldo.melo@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-trace-devel@vger.kernel.org \
    --cc=mtk.manpages@gmail.com \
    --cc=tz.stoyanov@gmail.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

Linux-Trace-Devel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-trace-devel/0 linux-trace-devel/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-trace-devel linux-trace-devel/ https://lore.kernel.org/linux-trace-devel \
		linux-trace-devel@vger.kernel.org
	public-inbox-index linux-trace-devel

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-trace-devel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git