documentation: Add links to TRACE_EVENT documentation
authorStefan Raspl <raspl@linux.vnet.ibm.com>
Wed, 6 Nov 2013 21:18:28 +0000 (13:18 -0800)
committerJiri Kosina <jkosina@suse.cz>
Mon, 2 Dec 2013 13:47:05 +0000 (14:47 +0100)
documentation: Add links to TRACE_EVENT documentation

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>
Acked-by: Rob Landley <rob@landley.net>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>
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.