Doc: add LTTNG_UST_CLOCK_PLUGIN to man page

[lttng-ust.git] / doc / examples / clock-override / README

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.