Tracepoint event: Document search paths

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

diff --git a/include/ust/tracepoint-event.h b/include/ust/tracepoint-event.h
index 402810f937879ba51c086f20a580c63ff6f06b8b..aefe5061255c12b5e7dc7735ccded6595244d9e7 100644 (file)
--- a/include/ust/tracepoint-event.h
+++ b/include/ust/tracepoint-event.h
@@ -28,11 +28,13 @@
  *     TRACEPOINT_SYSTEM.h. This macro may be defined to tell
  *     define_trace.h what file to include.  Note, leave off the ".h".
  *
- * TRACEPOINT_INCLUDE_PATH if the path is something other than core
- *     kernel include/trace then this macro can define the path to use.
- *     Note, the path is relative to tracepoint_event.h, not the file
- *     including it. Full path names for out of tree modules must be
- *     used.
+ * TRACEPOINT_INCLUDE_PATH if the path is something other than within
+ *     the system's include/tracepoint/ path, then this macro can define
+ *     the path to use. This path is relative to tracepoint-event.h, or
+ *     to the include search path. Trick: Use a
+ *       #define TRACEPOINT_INCLUDE_PATH .
+ *     combined with -Ipath_to_header as compiler argument to allow
+ *     searching for a header within your project build tree.
  */
 
 #ifdef TRACEPOINT_CREATE_PROBES