aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSteven Rostedt (Google) <rostedt@goodmis.org>2022-09-22 11:25:08 -0400
committerSteven Rostedt (Google) <rostedt@goodmis.org>2022-09-22 17:53:20 -0400
commit6e18ecc6afb987f62fb5afd11f49eacfefc5f5b2 (patch)
tree8e75ff11e78a4f452165c7abf7650bbfebd616ef
parent67387137e650a0d2330b09541ce549aadd49b4ac (diff)
downloadlibtraceevent-6e18ecc6afb987f62fb5afd11f49eacfefc5f5b2.tar.gz
libtraceevent: Add man page for tep_plugin_add_option()
The man page for tep_plugin_add_option() was missing, so add it. Link: https://lore.kernel.org/linux-trace-devel/20220922152510.3335601-8-rostedt@goodmis.org Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
-rw-r--r--Documentation/libtraceevent-plugins.txt9
-rw-r--r--Documentation/libtraceevent.txt1
2 files changed, 9 insertions, 1 deletions
diff --git a/Documentation/libtraceevent-plugins.txt b/Documentation/libtraceevent-plugins.txt
index 24d8ad8..4ca78d4 100644
--- a/Documentation/libtraceevent-plugins.txt
+++ b/Documentation/libtraceevent-plugins.txt
@@ -3,7 +3,8 @@ libtraceevent(3)
NAME
----
-tep_load_plugins, tep_unload_plugins, tep_load_plugins_hook, tep_add_plugin_path - Load / unload traceevent plugins.
+tep_load_plugins, tep_unload_plugins, tep_load_plugins_hook, tep_add_plugin_path,
+tep_plugin_add_option - Load / unload traceevent plugins.
SYNOPSIS
--------
@@ -21,6 +22,7 @@ void *tep_load_plugins_hook*(struct tep_handle pass:[*]_tep_, const char pass:[*
void pass:[*]_data_);
int *tep_add_plugin_path*(struct tep_handle pass:[*]tep, char pass:[*]path,
enum tep_plugin_load_priority prio);
+int *tep_plugin_add_option*(const char pass:[*]_name_, const char pass:[*]_val_);
--
DESCRIPTION
@@ -76,6 +78,11 @@ plugin wins. The priority can be:
Where the plugins in TEP_PLUGIN_LAST" will take precedence over the
plugins in the other directories.
+The *tep_plugin_add_option()* sets options defined by a plugin. The _name_ is the
+name of the option to set to _val_. Plugins can add options to change its behavior
+and *tep_plugin_add_option()* is used by the application to make those modifications.
+
+
RETURN VALUE
------------
The *tep_load_plugins()* function returns a list of successfully loaded plugins,
diff --git a/Documentation/libtraceevent.txt b/Documentation/libtraceevent.txt
index 6f342a8..045437c 100644
--- a/Documentation/libtraceevent.txt
+++ b/Documentation/libtraceevent.txt
@@ -45,6 +45,7 @@ Trace printk parsing:
void *tep_print_funcs*(struct tep_handle pass:[*]tep);
void *tep_set_test_filters*(struct tep_handle pass:[*]tep, int test_filters);
void *tep_plugin_print_options*(struct trace_seq pass:[*]s);
+ int *tep_plugin_add_option*(const char pass:[*]_name_, const char pass:[*]_val_);
Meta data parsing:
int *tep_parse_saved_cmdlines*(struct tep_handle pass:[*]_tep_, const char pass:[*]_buf_);