Documentation/trace/tracepoints.txt: add links to TRACE_EVENT documentation
authorStefan Raspl <raspl@linux.vnet.ibm.com>
Tue, 12 Nov 2013 23:11:11 +0000 (15:11 -0800)
committerLinus Torvalds <torvalds@linux-foundation.org>
Wed, 13 Nov 2013 03:09:32 +0000 (12:09 +0900)
Existing tracepoint documentation doesn't mention the popular
TRACE_EVENT macro.  Since an excellent series of articles on proper
usage already exists, respective links are added to the existing
documentation.

Signed-off-by: Stefan Raspl <raspl@linux.vnet.ibm.com>
Cc: Rob Landley <rob@landley.net>
Cc: Jiri Kosina <jkosina@suse.cz>
Acked-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Cc: Zoltan Kiss <zoltan.kiss@citrix.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Documentation/trace/tracepoints.txt

index ac4170dd0f24d9adb67c9b857739e06926d39d0b..6b018b53177aa7ee499b5adb0e95d52e2e92d9ee 100644 (file)
@@ -114,3 +114,8 @@ core kernel image or in modules.
 If the tracepoint has to be used in kernel modules, an
 EXPORT_TRACEPOINT_SYMBOL_GPL() or EXPORT_TRACEPOINT_SYMBOL() can be
 used to export the defined tracepoints.
+
+Note: The convenience macro TRACE_EVENT provides an alternative way to
+      define tracepoints. Check http://lwn.net/Articles/379903,
+      http://lwn.net/Articles/381064 and http://lwn.net/Articles/383362
+      for a series of articles with more details.