Skip to content
Snippets Groups Projects
Commit caad0f09 authored by Vladimir Stoiakin's avatar Vladimir Stoiakin Committed by Adrien Béraud
Browse files

tracepoints: correct documentation

Change-Id: Ibaf31d0e8401ea2ffb23e171323a0edd6f5a71b9
parent acfbf582
Branches
No related tags found
No related merge requests found
...@@ -39,7 +39,7 @@ To enable tracepoints in Jami, you should configure the project using the ...@@ -39,7 +39,7 @@ To enable tracepoints in Jami, you should configure the project using the
How to define a tracepoint How to define a tracepoint
-------------------------- --------------------------
To define a new tracepoints, you need to add the definition in src/tracepoint.h To define a new tracepoints, you need to add the definition in src/jami/tracepoint.h
It's recommended to use the ``LTTNG_UST_TRACEPOINT_EVENT`` macro and avoid using It's recommended to use the ``LTTNG_UST_TRACEPOINT_EVENT`` macro and avoid using
the others except if you know what you're doing. the others except if you know what you're doing.
...@@ -56,7 +56,7 @@ NOTE! As the documentation of LTTng says, the concatenation of provider name + ...@@ -56,7 +56,7 @@ NOTE! As the documentation of LTTng says, the concatenation of provider name +
tracepoint name must **not exceed 254 characters** or you will get bite. tracepoint name must **not exceed 254 characters** or you will get bite.
For example, here's the definition of a tracepoint for the scheduled executor in For example, here's the definition of a tracepoint for the scheduled executor in
src/tracepoint.h:: src/jami/tracepoint.h::
LTTNG_UST_TRACEPOINT_EVENT( LTTNG_UST_TRACEPOINT_EVENT(
jami, jami,
...@@ -99,12 +99,10 @@ How to use a tracepoint ...@@ -99,12 +99,10 @@ How to use a tracepoint
----------------------- -----------------------
Now that you have defined a tracepoint, you perhaps want to use it in Jami or Now that you have defined a tracepoint, you perhaps want to use it in Jami or
reuse an existing one. The first thing to do is to import src/tracepoint.h in reuse an existing one. The first thing to do is to import src/jami/tracepoint.h in
your compilation unit. Then you need to use the ``jami_tracepoint()`` your compilation unit. Then you need to use the ``jami_tracepoint()``
macro. It takes at least two arguments followed by a variable number of macro. It takes the tracepoint name followed by a variable number of
arguments. The first argument is the provider name which is always ``jami`` in arguments defined by the tracepoint.
our case. The second argument is the tracepoint name. The rest of the
arguments are the arguments defined by the tracepoint.
For example, here's how the tracepoint ``secheduled_executor_task_begin`` is For example, here's how the tracepoint ``secheduled_executor_task_begin`` is
used in src/scheduled_executor.h:: used in src/scheduled_executor.h::
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment