Doc: add LTTNG_UST_CLOCK_PLUGIN to man page

Also add indications on how to use the plugin with lttng-tools.

Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

diff --git a/doc/examples/clock-override/README b/doc/examples/clock-override/README
index e3ddf22a915f8959f487f3a234e3410088d0d6a0..aabbee2ae012f56e52ca823b1db6e0e5fc710dd2 100644 (file)
--- a/doc/examples/clock-override/README
+++ b/doc/examples/clock-override/README
@@ -2,3 +2,7 @@ This clock override example shows how to implement and load a clock
 override plugin for LTTng-UST. This can be useful in cases where direct
 hardware access is available for architecture-specific clocks, and where
 it should be used rather than the Linux kernel Monotonic clock.
+
+When using LTTng-tools keep in mind that lttng-sessiond uses lttng-ust's clock
+definition and functions. Thus LTTNG_UST_CLOCK_PLUGIN needs to be defined when
+launching lttng-sessiond.

diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3
index 4d86bfe0268076f05e1bfffb6f913a6156bc7106..398498913f104e6456bb87abedf38b7fc7f12e84 100644 (file)
--- a/doc/man/lttng-ust.3
+++ b/doc/man/lttng-ust.3
@@ -503,6 +503,12 @@ provides the path to the shared object which will act as the getcpu override
 plugin. An example can be found in the lttng-ust documentation under
 examples/getcpu-override .
 .PP
+.IP "LTTNG_UST_CLOCK_PLUGIN"
+Used by the clock override plugin system. The environment variable
+provides the path to the shared object wich will act as the clock override
+plugin. An example can be found in the lttng-ust documentation under
+doc/examples/clock-override .
+.PP
 
 .SH "SEE ALSO"