This is the mail archive of the
systemtap@sourceware.org
mailing list for the systemtap project.
[PATCH doc/langref.tex] Restore and update marker probe info.
- From: Robb Romans <robb at linux dot vnet dot ibm dot com>
- To: systemtap at sources dot redhat dot com
- Cc: Prerna Saxena <prerna at linux dot vnet dot ibm dot com>
- Date: Tue, 1 Sep 2009 13:38:04 -0500 (CDT)
- Subject: [PATCH doc/langref.tex] Restore and update marker probe info.
Please review. Thanks.
Signed-off-by: Robb Romans <robb@linux.vnet.ibm.com>
---
doc/langref.tex | 43 +++++++++++++++++++++++++------------------
1 files changed, 25 insertions(+), 18 deletions(-)
diff --git a/doc/langref.tex b/doc/langref.tex
index 640ad79..781f014 100644
--- a/doc/langref.tex
+++ b/doc/langref.tex
@@ -912,26 +912,33 @@ function, use \textbf{.statement} probes. Do not use wildcards in
to not register. Also, run statement probes in guru mode only.
-\begin{comment}
\subsection{Marker probes}
+\index{marker probes}
+This family of probe points connects to static probe markers inserted
+into the kernel or a module. These markers are special macro calls in
+the kernel that make probing faster and more reliable than with
+DWARF-based probes. DWARF debugging information is not required to
+use probe markers.
+
+Marker probe points begin with a kernel or module (\texttt{"NAME"})
+prefix, the same as DWARF probes. This prefix identifies the source of
+the symbol table used for finding markers. The suffix names the marker
+itself: \texttt{mark."NAME"}. The marker name string, which can
+contain wildcard characters, is matched against the names given to the
+marker macros when the kernel or module is compiled.
+
+The handler associated with a marker probe reads any optional
+parameters specified at the macro call site named \texttt{\$arg1}
+through \texttt{\$argNN}, where \texttt{NN} is the number of
+parameters supplied by the macro. Number and string parameters are
+passed in a type-safe manner.
+
+The marker format string associated with a marker is available in
+\texttt{\$format}. The marker name string is available in \texttt{\$name}.
+
+For more information about marker probes, see
+\url{http://sourceware.org/systemtap/wiki/UsingMarkers}.
-This family of probe points connects to static probe markers inserted into
-the kernel or a module. These markers are special macro calls in the kernel
-that make probing faster and more reliable than with DWARF-based probes.
-DWARF debugging information is not required to use probe markers.
-
-Marker probe points begin with a kernel or module(\char`\"{}\emph{name}\char`\"{})
-prefix, the same as DWARF probes. This prefix identifies the source of the
-symbol table used for finding markers. The suffix names the marker itself:
-mark(\char`\"{}\emph{name}\char`\"{}). The marker name string, which may
-contain wildcard characters, is matched against the names given to the marker
-macros when the kernel or module was compiled.
-
-The handler associated with a marker probe reads any optional parameters
-specified at the macro call site named \$arg1 through \$argNN, where NN is
-the number of parameters supplied by the macro. Number and string parameters
-are passed in a type-safe manner.
-\end{comment}
\subsection{Timer probes}
\index{timer probes}
--
1.6.0.4
--
Robb Romans
IBM LTC Information Development
robb@linux.vnet.ibm.com