[v3,40/46] tools/lib/traceevent: Man page for tep_data_lat_fmt()
diff mbox series

Message ID 20181127154153.11315-41-tstoyanov@vmware.com
State New, archived
Headers show
  • Libtraceevent MAN pages
Related show

Commit Message

Tzvetomir Stoyanov Nov. 27, 2018, 3:42 p.m. UTC
Create man page for tep_data_lat_fmt()
as part of the libtraceevent APIs.

Signed-off-by: Tzvetomir Stoyanov <tstoyanov@vmware.com>
 .../libtraceevent-record_lat.txt              | 77 +++++++++++++++++++
 1 file changed, 77 insertions(+)
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-record_lat.txt

diff mbox series

diff --git a/tools/lib/traceevent/Documentation/libtraceevent-record_lat.txt b/tools/lib/traceevent/Documentation/libtraceevent-record_lat.txt
new file mode 100644
index 000000000000..5c8f5ec0599d
--- /dev/null
+++ b/tools/lib/traceevent/Documentation/libtraceevent-record_lat.txt
@@ -0,0 +1,77 @@ 
+tep_data_lat_fmt - Parses the data for the latency format.
+*#include <event-parse.h>*
+void *tep_data_lat_fmt*(struct tep_handle pass:[*]_tep_, struct trace_seq pass:[*]_s_, struct tep_record pass:[*]_record_);
+The _tep_data_lat_fmt()_ function parses out the latency format (interrupts 
+disabled, need rescheduling, in hard/soft interrupt, preempt count and 
+lock depth) from _record_ and places it into the _s_.  The _tep_ argument is 
+the trace event parser context.
+#include <event-parse.h>
+#include <trace-seq.h>
+struct tep_handle *tep = tep_alloc();
+struct trace_seq seq;
+void process_record(struct tep_record *record)
+	/* Place latency information in the seq */
+	tep_data_lat_fmt(tep, &seq, record);
+	Header file to include in order to have access to the library APIs.
+	Header file to include in order to have access to trace sequences related APIs.
+	Trace sequences are used to allow a function to call several other functions 
+	to create a string of data to use.
+	Linker switch to add when building a program that uses the library.
+_libtraceevent(3)_, _trace-cmd(1)_,_tep_set_latency_format(3)_
+*Steven Rostedt* <rostedt@goodmis.org>, author of *libtraceevent*.
+*Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page.
+Report bugs to  <linux-trace-devel@vger.kernel.org>
+libtraceevent is Free Software licensed under the GNU LGPL 2.1