From 5fae6ccbceb7a6524a84eecde86a1c1f43c38714 Mon Sep 17 00:00:00 2001 From: Serguei Makarov Date: Thu, 7 Jun 2012 16:38:01 -0400 Subject: [PATCH] PR14208: Removed final few mentions of stapfuncs(3stap). --- HACKING | 9 +++++++-- doc/langref.tex | 2 +- doc/tutorial.tex | 10 ++++++---- 3 files changed, 14 insertions(+), 7 deletions(-) diff --git a/HACKING b/HACKING index 3f779e962..6029ba82a 100644 --- a/HACKING +++ b/HACKING @@ -90,8 +90,13 @@ the mailing list. 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. diff --git a/doc/langref.tex b/doc/langref.tex index f510658c8..572ca328d 100644 --- a/doc/langref.tex +++ b/doc/langref.tex @@ -2700,7 +2700,7 @@ rather than printing it. \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}. diff --git a/doc/tutorial.tex b/doc/tutorial.tex index 5d279ccc6..5c5616381 100644 --- a/doc/tutorial.tex +++ b/doc/tutorial.tex @@ -228,7 +228,7 @@ the line. 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} @@ -1079,9 +1079,11 @@ There are \verb+man+ pages: \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 -- 2.43.5