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

diff --git a/doc/examples/getcpu-override/README.md b/doc/examples/getcpu-override/README.md
new file mode 100644
index 00000000..9dc19be8
--- /dev/null
+++ b/doc/examples/getcpu-override/README.md
@@ -0,0 +1,11 @@
+<!--
+SPDX-FileCopyrightText: 2014 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
+This getcpu override example shows how to implement and load a getcpu
+override plugin for LTTng-UST. This can be useful in cases where direct
+hardware access is available for architecture-specific registers holding
+the CPU number, and where it should be used rather than the Linux kernel
+sched_getcpu() vDSO/syscall.