linux-trace-devel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Tzvetomir Stoyanov (VMware)" <tz.stoyanov@gmail.com>
To: rostedt@goodmis.org, y.karadz@gmail.com
Cc: linux-trace-devel@vger.kernel.org
Subject: [PATCH v2 12/12] libtracefs: Document tracefs_dynevent_list_free() API
Date: Mon,  1 Nov 2021 11:09:04 +0200	[thread overview]
Message-ID: <20211101090904.81454-13-tz.stoyanov@gmail.com> (raw)
In-Reply-To: <20211101090904.81454-1-tz.stoyanov@gmail.com>

The newly added tracefs_dynevent_list_free() should be documented in the
library man pages.

Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
---
 Documentation/libtracefs-utils.txt | 6 +++++-
 Documentation/libtracefs.txt       | 1 +
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/Documentation/libtracefs-utils.txt b/Documentation/libtracefs-utils.txt
index 41544ab..3424673 100644
--- a/Documentation/libtracefs-utils.txt
+++ b/Documentation/libtracefs-utils.txt
@@ -3,7 +3,7 @@ libtracefs(3)
 
 NAME
 ----
-tracefs_tracers, tracefs_get_clock, tracefs_list_free -
+tracefs_tracers, tracefs_get_clock, tracefs_list_free, tracefs_dynevent_list_free -
 Helper functions for working with trace file system.
 
 SYNOPSIS
@@ -15,6 +15,7 @@ SYNOPSIS
 char pass:[*]pass:[*]*tracefs_tracers*(const char pass:[*]_tracing_dir_);
 char pass:[*]*tracefs_get_clock*(struct tracefs_instance pass:[*]_instance_);
 void *tracefs_list_free*(char pass:[*]pass:[*]_list_);
+void *tracefs_dynevent_list_free*(struct tracefs_dynevent pass:[*]pass:[*]_events_);
 --
 
 DESCRIPTION
@@ -36,6 +37,9 @@ The _tracefs_list_free()_ function frees an array of strings, returned by
 _tracefs_event_systems()_, _tracefs_system_events()_ and _tracefs_tracers()_
 APIs.
 
+The _tracefs_dynevent_list_free()_ functions frees an array of pointers to dynamic event contexts,
+returned by_tracefs_kprobes_get()_ API.
+
 RETURN VALUE
 ------------
 The _tracefs_tracers()_ returns array of strings. The last element in that
diff --git a/Documentation/libtracefs.txt b/Documentation/libtracefs.txt
index 4a356c8..7889048 100644
--- a/Documentation/libtracefs.txt
+++ b/Documentation/libtracefs.txt
@@ -45,6 +45,7 @@ Trace helper functions:
 	void *tracefs_list_free*(char pass:[*]pass:[*]_list_);
 	char pass:[*]pass:[*]*tracefs_tracers*(const char pass:[*]_tracing_dir_);
 	char pass:[*]*tracefs_get_clock*(struct tracefs_instance pass:[*]_instance_);
+	void *tracefs_dynevent_list_free*(struct tracefs_dynevent pass:[*]pass:[*]_events_);
 	int *tracefs_trace_is_on*(struct tracefs_instance pass:[*]_instance_);
 	int *tracefs_trace_on*(struct tracefs_instance pass:[*]_instance_);
 	int *tracefs_trace_off*(struct tracefs_instance pass:[*]_instance_);
-- 
2.31.1


  parent reply	other threads:[~2021-11-01  9:09 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-01  9:08 [PATCH v2 00/12] libtracefs dynamic events support Tzvetomir Stoyanov (VMware)
2021-11-01  9:08 ` [PATCH v2 01/12] libtracefs: Add new internal APIs for dynamic events Tzvetomir Stoyanov (VMware)
2021-11-01 17:06   ` Yordan Karadzhov
2021-11-02  4:33     ` Tzvetomir Stoyanov
2021-11-02 13:25       ` Steven Rostedt
2021-11-01  9:08 ` [PATCH v2 02/12] libtracefs: Rename tracefs_get_kprobes API Tzvetomir Stoyanov (VMware)
2021-11-01  9:08 ` [PATCH v2 03/12] libtracefs: New kprobes APIs Tzvetomir Stoyanov (VMware)
2021-11-01 17:22   ` Yordan Karadzhov
2021-11-02  4:58     ` Tzvetomir Stoyanov
2021-11-02  7:43       ` Yordan Karadzhov
2021-11-02 13:49         ` Steven Rostedt
2021-11-01  9:08 ` [PATCH v2 04/12] libtracefs: Remove redundant " Tzvetomir Stoyanov (VMware)
2021-11-01  9:08 ` [PATCH v2 05/12] libtracefs: Reimplement tracefs_kprobes_get API Tzvetomir Stoyanov (VMware)
2021-11-01  9:08 ` [PATCH v2 06/12] libtracefs: Change tracefs_kprobe_info API Tzvetomir Stoyanov (VMware)
2021-11-01  9:08 ` [PATCH v2 07/12] libtracefs: Reimplement kprobe raw APIs Tzvetomir Stoyanov (VMware)
2021-11-01  9:09 ` [PATCH v2 08/12] libtracefs: Extend kprobes unit test Tzvetomir Stoyanov (VMware)
2021-11-01  9:09 ` [PATCH v2 09/12] libtracefs: Update kprobes man pages Tzvetomir Stoyanov (VMware)
2021-11-01  9:09 ` [PATCH v2 10/12] libtracefs: Rename tracefs_synth_init API Tzvetomir Stoyanov (VMware)
2021-11-01  9:09 ` [PATCH v2 11/12] libtracefs: Use the internal dynamic events API when creating synthetic events Tzvetomir Stoyanov (VMware)
2021-11-01  9:09 ` Tzvetomir Stoyanov (VMware) [this message]
2021-11-01 14:21 ` [PATCH v2 00/12] libtracefs dynamic events support Tzvetomir Stoyanov

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=20211101090904.81454-13-tz.stoyanov@gmail.com \
    --to=tz.stoyanov@gmail.com \
    --cc=linux-trace-devel@vger.kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=y.karadz@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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).