doc: implement REUSE with SPDX identifiers

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

diff --git a/doc/examples/getcpu-override/README.md b/doc/examples/getcpu-override/README.md
new file mode 100644 (file)
index 0000000..9dc19be
--- /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.