]> sourceware.org Git - systemtap.git/commitdiff
PR14208: Removed final few mentions of stapfuncs(3stap).
authorSerguei Makarov <smakarov@redhat.com>
Thu, 7 Jun 2012 20:38:01 +0000 (16:38 -0400)
committerSerguei Makarov <smakarov@redhat.com>
Thu, 7 Jun 2012 20:38:01 +0000 (16:38 -0400)
HACKING
doc/langref.tex
doc/tutorial.tex

diff --git a/HACKING b/HACKING
index 3f779e962b75a897dd5fb1b44ff723d709a6f3e9..6029ba82a01255905d895af546d07c98cf84c9de 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -90,8 +90,13 @@ the <systemtap@sourceware.org> 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.
index f510658c830077c93f75796eab74fb3a5ea11998..572ca328dcdb37f9aeeb0ae6ea013d22f37eb251 100644 (file)
@@ -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}.
index 5d279ccc6a779e0c3ab2314bfd2ad51f61cb03ca..5c5616381333d3b0d4d57d97fd9a87aba158e92a 100644 (file)
@@ -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
This page took 0.030087 seconds and 5 git commands to generate.