From 976159f2a2491a49090ea180ab17078fe84cc795 Mon Sep 17 00:00:00 2001
From: William Cohen <wcohen@redhat.com>
Date: Wed, 15 Jul 2009 18:31:35 -0400
Subject: Add desciption of tracepoint event.

---
 doc/SystemTap_Beginners_Guide/en-US/Scripts.xml | 26 +++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

(limited to 'doc/SystemTap_Beginners_Guide')

diff --git a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml
index 88aa42ab..d6f7733f 100644
--- a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml
+++ b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml
@@ -376,6 +376,32 @@ probe kernel.function("*@net/socket.c").return { }
 
       </varlistentry>
 
+      <varlistentry>
+	<term>kernel.trace("<replaceable>tracepoint</replaceable>")</term>
+	<listitem>
+<indexterm><primary>tracepoint</primary></indexterm>
+<indexterm>
+<primary>Events</primary>
+<secondary><command>kernel.trace("<replaceable>tracepoint</replaceable>")</command></secondary>
+</indexterm>
+
+<indexterm>
+<primary><command>kernel.trace("<replaceable>tracepoint</replaceable>")</command></primary>
+<secondary>Events</secondary>
+</indexterm>
+	  <para>
+	    The static probe for <replaceable>tracepoint</replaceable>.
+	    Recent kernels (2.6.30 and newer)
+	    include instrumentation for specific events in the kernel. These
+	    events are statically marked with tracepoints.  One example of a
+	    tracepoint available in systemtap is
+	    <command>kernel.trace("kfree_skb")</command> which indicates each
+	    time a network buffer is freed in the kernel.
+	  </para>
+	</listitem>
+
+      </varlistentry>
+
       <varlistentry>
 	<term>module("<replaceable>module</replaceable>").function("<replaceable>function</replaceable>")</term>
 	<listitem>
-- 
cgit