Cleanup: Move lttng-modules instrumentation headers

[lttng-modules.git] / include / instrumentation / events / README

* Workflow for updating patches from newer kernel:

Pull the new headers from mainline kernel to this subdirectory.
Update those headers to fix the lttng-modules instrumentation style.


* Workflow to add new Tracepoint instrumentation to newer kernel,
  and add support for it into LTTng:

a) instrument the kernel with new trace events headers. If you want that
   instrumentation distributed, you will have to push those changes into
   the upstream Linux kernel first,
b) copy those headers into this subdirectory,
c) look at a diff from other headers between mainline kernel version and 
   those in this subdirectory, and use that as a recipe to alter the new
   headers copy.
d) create a new file in probes/ for the new trace event header you added,
e) add it to probes/Makefile,
f) build, make modules_install,
g) don't forget to load that new module too.

Currently, LTTng policy is to only accept headers derived from trace
event headers accepted into the Linux kernel upstream for tracepoints
related to upstream kernel instrumentation.