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

Message ID 20181127154153.11315-14-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_register_trace_clock()
as part of the libtraceevent APIs.

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

diff mbox series

diff --git a/tools/lib/traceevent/Documentation/libtraceevent-reg_clock.txt b/tools/lib/traceevent/Documentation/libtraceevent-reg_clock.txt
new file mode 100644
index 000000000000..60dd81df6b37
--- /dev/null
+++ b/tools/lib/traceevent/Documentation/libtraceevent-reg_clock.txt
@@ -0,0 +1,77 @@ 
+tep_register_trace_clock - Registers the clock, used for the timestamp of
+the events. 
+*#include <event-parse.h>*
+int *tep_register_trace_clock*(struct tep_handle pass:[*]_tep_, const char pass:[*]_trace_clock_);
+The _tep_register_trace_clock()_ function registers the clock, used for 
+the timestamps of the events. When an event is recorded, a timestamp is attached 
+to it. This timestamp comes from a specified clock. Supported clocks can be seen 
+in tracefs/trace_clock, the selected one is in square brackets.
+The _tep_ argument is the trace event parser context. The _trace_clock_ argument 
+is the name of the clock, the string is copied internally. 
+The _tep_register_trace_clock()_ function returns 0 in case of success. 
+If there is not enough memory to copy the _trace_clock_ string -1 is returned 
+and errno is set to ENOMEM. 
+#include <event-parse.h>
+struct tep_handle *tep = tep_alloc();
+	if(tep_register_trace_clock(tep, "local") != 0) {
+		/* Failed to register the clock */
+	}
+	Header file to include in order to have access to the library APIs.
+	Linker switch to add when building a program that uses the library.
+_libtraceevent(3)_, _trace-cmd(1)_
+*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