It may be necessary to prefix symbols with the tapset name to ensure
systemtap-wide uniqueness. All "external interfaces" expected to be
used by user scripts (or perhaps other tapsets) should be documented
- in stapfuncs.5, stapprobes.5. Major or incompatible changes should
- be mentioned in the NEWS file; see also the deprecation section below.
+ -- either in stapprobes.3stap if they are built into the language or
+ otherwise somehow essential; or in kernel-doc style comments if they
+ are defined in a tapset (see almost any existing tapset for an
+ example of how this is done); any new tapset should be mentioned in
+ doc/SystemTap_Tapset_Reference/tapsets.tmpl. Major or incompatible
+ changes should be mentioned in the NEWS file; see also the
+ deprecation section below.
Internal function, variable, probe identifiers should be prefixed
with "_" for extra uniqueness, and not documented in the man pages.
\section{Tapset-defined functions\label{sec:Predefined-Functions}}
Unlike built-in functions, tapset-defined functions are implemented in tapset scripts.
-These are individually documented in the in the \texttt{stapfuncs(3)},
+These are individually documented in the in \texttt{tapset::*(3stap)},
\texttt{function::*(3stap)},
and \texttt{probe::*(3stap)} man pages, and implemented under
\texttt{/usr/share/systemtap/tapset}.
Systemtap provides a variety of such contextual data, ready for
formatting. They usually appear as function calls within the handler,
like you already saw in Figure~\ref{fig:strace-open}. {\bf See the
-\verb+stapfuncs+ man page for those functions and more defined in the
+\verb+function::*+ man pages for those functions and more defined in the
tapset library}, but here's a sampling:
\begin{tabular}{rl}
\begin{tabular}{rl}
\verb+stap+ & systemtap program usage, language summary \\
\verb+stappaths+ & your systemtap installation paths \\
-\verb+stapfuncs+ & functions provided by tapsets \\
-\verb+stapprobes+ & probes / probe aliases provided by tapsets \\
-\verb+stapex+ & some example scripts \\
+\verb+stapprobes+ & probes / probe aliases provided by built-in tapsets \\
+\verb+stapex+ & a few basic example scripts \\
+\verb+tapset::*+ & summaries of the probes and functions in each tapset \\
+\verb+probe::*+ & detailed descriptions of each probe \\
+\verb+function::*+ & detailed descriptions of each function
\end{tabular}
There is much more documentation and sample scripts included. You