From 4c878882a91392e5aacefd30efacde713747f627 Mon Sep 17 00:00:00 2001 From: Jonathan Rajotte Date: Thu, 23 Jul 2015 16:02:51 -0400 Subject: [PATCH] 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 Signed-off-by: Mathieu Desnoyers --- doc/examples/clock-override/README | 4 ++++ doc/man/lttng-ust.3 | 6 ++++++ 2 files changed, 10 insertions(+) diff --git a/doc/examples/clock-override/README b/doc/examples/clock-override/README index e3ddf22a..aabbee2a 100644 --- 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 4d86bfe0..39849891 100644 --- 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" -- 2.34.1