| Message ID | 20190730125040.24864-1-tz.stoyanov@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Delegated to: | Steven Rostedt |
| Headers | show |
| Series | [v8] tools/lib/traceevent: Man pages for tep plugins APIs | expand |
On Tue, 30 Jul 2019 15:50:40 +0300 "Tzvetomir Stoyanov (VMware)" <tz.stoyanov@gmail.com> wrote: > From: Tzvetomir Stoyanov <tstoyanov@vmware.com> > > Create man pages for libtraceevent APIs: > tep_load_plugins(), > tep_unload_plugin() > > Suggested-by: Patrick McLean <chutzpah@gentoo.org> > Signed-off-by: Tzvetomir Stoyanov <tstoyanov@vmware.com> > --- > [ > v8 changes: > - the user's plugin directory changed from > ~/.config/traceevent/plugins/ to ~/.local/lib/traceevent/plugins/, > as suggested by Patrick McLean. > https://lore.kernel.org/linux-trace-devel/20190313144206.41e75cf8@patrickm/ > ] > > .../Documentation/libtraceevent-plugins.txt | 98 +++++++++++++++++++ > 1 file changed, 98 insertions(+) > create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-plugins.txt > > diff --git a/tools/lib/traceevent/Documentation/libtraceevent-plugins.txt b/tools/lib/traceevent/Documentation/libtraceevent-plugins.txt > new file mode 100644 > index 000000000000..ce0288719939 > --- /dev/null > +++ b/tools/lib/traceevent/Documentation/libtraceevent-plugins.txt > @@ -0,0 +1,98 @@ > +libtraceevent(3) > +================ > + > +NAME > +---- > +tep_load_plugins, tep_unload_plugins - Load / unload traceevent plugins. > + > +SYNOPSIS > +-------- > +[verse] > +-- > +*#include <event-parse.h>* > + > +struct tep_plugin_list pass:[*]*tep_load_plugins*(struct tep_handle pass:[*]_tep_); > +void *tep_unload_plugins*(struct tep_plugin_list pass:[*]_plugin_list_, struct tep_handle pass:[*]_tep_); > +-- > + > +DESCRIPTION > +----------- > +The _tep_load_plugins()_ function loads all plugins, located in the plugin > +directories. The _tep_ argument is trace event parser context. > +The plugin directories are : > +[verse] > +-- > + - System's plugin directory, defined at the library compile time. It > + depends on the library installation prefix and usually is > + _(install_preffix)/lib/traceevent/plugins_ > + - Directory, defined by the environment variable _TRACEEVENT_PLUGIN_DIR_ > + - User's plugin directory, located at _~/.local/lib/traceevent/plugins_ > +-- > +Loading of plugins can be controlled by the _tep_flags_, using the > +_tep_set_flag()_ API: > +[verse] > +-- > + _TEP_DISABLE_SYS_PLUGINS_ - do not load plugins, located in > + the system's plugin directory. > + _TEP_DISABLE_PLUGINS_ - do not load any plugins. > +-- > +The _tep_set_flag()_ API must be called before _tep_load_plugins()_. I wouldn't say tep_set_flag() must be called, but instead say that it needs to be called first if the default (of loading all possible plugins) is not the desired case. -- Steve > + > +The _tep_unload_plugins()_ function unloads the plugins, previously loaded by > +_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. > + > +RETURN VALUE > +------------ > +The _tep_load_plugins()_ function returns a list of successfully loaded plugins, > +or NULL in case no plugins are loaded. > + > +EXAMPLE > +------- > +[source,c] > +-- > +#include <event-parse.h> > +... > +struct tep_handle *tep = tep_alloc(); > +... > +struct tep_plugin_list *plugins = tep_load_plugins(tep); > +if (plugins == NULL) { > + /* no plugins are loaded */ > +} > +... > +tep_unload_plugins(plugins, tep); > +-- > + > +FILES > +----- > +[verse] > +-- > +*event-parse.h* > + Header file to include in order to have access to the library APIs. > +*-ltraceevent* > + Linker switch to add when building a program that uses the library. > +-- > + > +SEE ALSO > +-------- > +_libtraceevent(3)_, _trace-cmd(1)_, _tep_set_flag(3)_ > + > +AUTHOR > +------ > +[verse] > +-- > +*Steven Rostedt* <rostedt@goodmis.org>, author of *libtraceevent*. > +*Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page. > +-- > +REPORTING BUGS > +-------------- > +Report bugs to <linux-trace-devel@vger.kernel.org> > + > +LICENSE > +------- > +libtraceevent is Free Software licensed under the GNU LGPL 2.1 > + > +RESOURCES > +--------- > +https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
diff --git a/tools/lib/traceevent/Documentation/libtraceevent-plugins.txt b/tools/lib/traceevent/Documentation/libtraceevent-plugins.txt new file mode 100644 index 000000000000..ce0288719939 --- /dev/null +++ b/tools/lib/traceevent/Documentation/libtraceevent-plugins.txt @@ -0,0 +1,98 @@ +libtraceevent(3) +================ + +NAME +---- +tep_load_plugins, tep_unload_plugins - Load / unload traceevent plugins. + +SYNOPSIS +-------- +[verse] +-- +*#include <event-parse.h>* + +struct tep_plugin_list pass:[*]*tep_load_plugins*(struct tep_handle pass:[*]_tep_); +void *tep_unload_plugins*(struct tep_plugin_list pass:[*]_plugin_list_, struct tep_handle pass:[*]_tep_); +-- + +DESCRIPTION +----------- +The _tep_load_plugins()_ function loads all plugins, located in the plugin +directories. The _tep_ argument is trace event parser context. +The plugin directories are : +[verse] +-- + - System's plugin directory, defined at the library compile time. It + depends on the library installation prefix and usually is + _(install_preffix)/lib/traceevent/plugins_ + - Directory, defined by the environment variable _TRACEEVENT_PLUGIN_DIR_ + - User's plugin directory, located at _~/.local/lib/traceevent/plugins_ +-- +Loading of plugins can be controlled by the _tep_flags_, using the +_tep_set_flag()_ API: +[verse] +-- + _TEP_DISABLE_SYS_PLUGINS_ - do not load plugins, located in + the system's plugin directory. + _TEP_DISABLE_PLUGINS_ - do not load any plugins. +-- +The _tep_set_flag()_ API must be called before _tep_load_plugins()_. + +The _tep_unload_plugins()_ function unloads the plugins, previously loaded by +_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. + +RETURN VALUE +------------ +The _tep_load_plugins()_ function returns a list of successfully loaded plugins, +or NULL in case no plugins are loaded. + +EXAMPLE +------- +[source,c] +-- +#include <event-parse.h> +... +struct tep_handle *tep = tep_alloc(); +... +struct tep_plugin_list *plugins = tep_load_plugins(tep); +if (plugins == NULL) { + /* no plugins are loaded */ +} +... +tep_unload_plugins(plugins, tep); +-- + +FILES +----- +[verse] +-- +*event-parse.h* + Header file to include in order to have access to the library APIs. +*-ltraceevent* + Linker switch to add when building a program that uses the library. +-- + +SEE ALSO +-------- +_libtraceevent(3)_, _trace-cmd(1)_, _tep_set_flag(3)_ + +AUTHOR +------ +[verse] +-- +*Steven Rostedt* <rostedt@goodmis.org>, author of *libtraceevent*. +*Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page. +-- +REPORTING BUGS +-------------- +Report bugs to <linux-trace-devel@vger.kernel.org> + +LICENSE +------- +libtraceevent is Free Software licensed under the GNU LGPL 2.1 + +RESOURCES +--------- +https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git