diff options
| author | Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com> | 2023-04-26 07:11:23 +0300 |
|---|---|---|
| committer | Steven Rostedt (Google) <rostedt@goodmis.org> | 2023-04-26 13:05:48 -0400 |
| commit | dd620f429ede93730282f01346a793ad52d06235 (patch) | |
| tree | e1e1f46d8382fb99dd4f7e0ad6f68f83cbe394ac | |
| parent | 789e82d70cd246f7fb1b05cff50d67433772d410 (diff) | |
| download | libtracefs-dd620f429ede93730282f01346a793ad52d06235.tar.gz | |
libtracefs: Documentation for tracefs_instance_reset()
The newly introduced API tracefs_instance_reset() should be described in
the tracefs man pages.
Link: https://lore.kernel.org/linux-trace-devel/20230426041124.69544-3-tz.stoyanov@gmail.com
Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
| -rw-r--r-- | Documentation/libtracefs-instances-manage.txt | 7 | ||||
| -rw-r--r-- | Documentation/libtracefs.txt | 1 |
2 files changed, 6 insertions, 2 deletions
diff --git a/Documentation/libtracefs-instances-manage.txt b/Documentation/libtracefs-instances-manage.txt index c03a272..1e0735e 100644 --- a/Documentation/libtracefs-instances-manage.txt +++ b/Documentation/libtracefs-instances-manage.txt @@ -4,7 +4,7 @@ libtracefs(3) NAME ---- tracefs_instance_create, tracefs_instance_destroy, tracefs_instance_alloc, tracefs_instance_free, -tracefs_instance_is_new, tracefs_instances - Manage trace instances. +tracefs_instance_is_new, tracefs_instances, tracefs_instance_reset - Manage trace instances. SYNOPSIS -------- @@ -18,6 +18,7 @@ struct tracefs_instance pass:[*]*tracefs_instance_alloc*(const char pass:[*]_tra void *tracefs_instance_free*(struct tracefs_instance pass:[*]_instance_); bool *tracefs_instance_is_new*(struct tracefs_instance pass:[*]_instance_); char pass:[**]*tracefs_instances*(const char pass:[*]_regex_); +void *tracefs_instance_reset*(struct tracefs_instance pass:[*]_instance_); -- @@ -60,6 +61,8 @@ it will match all instances that exist. The returned list must be freed with *tracefs_list_free*(3). Note, if no instances are found an empty list is returned and that too needs to be free with *tracefs_list_free*(3). +The *tracefs_instance_reset*() function resets the given _instance_ to its default state. + RETURN VALUE ------------ The *tracefs_instance_create()* and *tracefs_instance_alloc()* functions return a pointer to @@ -106,7 +109,7 @@ struct tracefs_instance *inst = tracefs_instance_alloc(NULL, "bar"); } ... - + tracefs_instance_reset(inst); tracefs_instance_free(inst); -- FILES diff --git a/Documentation/libtracefs.txt b/Documentation/libtracefs.txt index c3f448d..052e1c9 100644 --- a/Documentation/libtracefs.txt +++ b/Documentation/libtracefs.txt @@ -25,6 +25,7 @@ Trace instances: struct tracefs_instance pass:[*]*tracefs_instance_alloc*(const char pass:[*]_tracing_dir_, const char pass:[*]_name_); void *tracefs_instance_free*(struct tracefs_instance pass:[*]_instance_); char pass:[**]*tracefs_instances*(const char pass:[*]_regex_); + void *tracefs_instance_reset*(struct tracefs_instance pass:[*]_instance_); bool *tracefs_instance_is_new*(struct tracefs_instance pass:[*]_instance_); bool *tracefs_file_exists*(struct tracefs_instance pass:[*]_instance_, char pass:[*]_name_); bool *tracefs_dir_exists*(struct tracefs_instance pass:[*]_instance_, char pass:[*]_name_); |