X-Git-Url: https://git.lttng.org/?p=lttng-ust.git;a=blobdiff_plain;f=doc%2Fexamples%2Fclock-override%2FREADME.md;fp=doc%2Fexamples%2Fclock-override%2FREADME.md;h=9f945b91522c0a6b6a0f46bbdcca2934ebe525a5;hp=0000000000000000000000000000000000000000;hb=53f7d0d7404de911dd62dff06f08539e33ea7519;hpb=1c1968450409b3c159a3000f9e1a968ff1e5f7e8

diff --git a/doc/examples/clock-override/README.md b/doc/examples/clock-override/README.md
new file mode 100644
index 00000000..9f945b91
--- /dev/null
+++ b/doc/examples/clock-override/README.md
@@ -0,0 +1,14 @@
+<!--
+SPDX-FileCopyrightText: 2014 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
+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.