diff options
| -rw-r--r-- | doc/SystemTap_Tapset_Reference/en-US/Introduction.xml | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/SystemTap_Tapset_Reference/en-US/Introduction.xml b/doc/SystemTap_Tapset_Reference/en-US/Introduction.xml index 84e960d4..31e8a784 100644 --- a/doc/SystemTap_Tapset_Reference/en-US/Introduction.xml +++ b/doc/SystemTap_Tapset_Reference/en-US/Introduction.xml @@ -20,4 +20,43 @@ <firstterm>tapset</firstterm> library. This document describes the various probe points and functions. </para> + +<section id="format"> + <title>Tapset Name Format</title> + +<para>In this guide, tapset definitions appear in the following format:</para> + +<screen> +name:return (parameters) + definition +</screen> + +<para> + The <replaceable>return</replaceable> field specifies what data type the tapset extracts + and returns from the kernel during a probe (and thus, returns). + Tapsets use 2 data types for <replaceable>return</replaceable>: + <literal>long</literal> (tapset extracts and returns an integer) and + <literal>string</literal> (tapset extracts and returns a string). +</para> + +<para> + In some cases, tapsets do not have a <replaceable>return</replaceable> value. This + simply means that the tapset does not extract anything from the kernel. This is common among + asynchronous events such as timers, exit functions, and print functions. +</para> + + + +<!-- +<varlistentry> +<term></term> +<listitem> + <para></para> +</listitem> +</varlistentry> +--> + +</section> + + </chapter> |