summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFrank Ch. Eigler <fche@elastic.org>2008-03-28 12:34:05 -0400
committerFrank Ch. Eigler <fche@elastic.org>2008-03-28 12:34:05 -0400
commit5e5189b38b0b1b788d32190361961d18e4456ae6 (patch)
treed388205113589bf73857efc6ef997bc8c39e112b /doc
parentbf6c85c35a749ca8cc6bea20a7774d063c218938 (diff)
parent1e00cfb1b6caa8b8ac343fac8e3d08f2d6a5d785 (diff)
downloadsystemtap-steved-5e5189b38b0b1b788d32190361961d18e4456ae6.tar.gz
systemtap-steved-5e5189b38b0b1b788d32190361961d18e4456ae6.tar.xz
systemtap-steved-5e5189b38b0b1b788d32190361961d18e4456ae6.zip
Merge branch 'master' of git://sources.redhat.com/git/systemtap
* 'master' of git://sources.redhat.com/git/systemtap: (24 commits) 2008-03-27 Frank Ch. Eigler <fche@elastic.org> 2008-03-27 Frank Ch. Eigler <fche@elastic.org> 2008-03-26 Frank Ch. Eigler <fche@elastic.org> Revert "dummy commit" dummy commit * clarify utility of epilogue-type probe aliases in documentation 2008-03-23 Frank Ch. Eigler <fche@elastic.org> 2008-03-23 Frank Ch. Eigler <fche@elastic.org> 2008-03-21 Eugene Teo <eugeneteo@kernel.sg> spelling fixes 2008-03-20 Frank Ch. Eigler <fche@elastic.org> * clarify $variables available in .return probes 2008-03-20 Frank Ch. Eigler <fche@elastic.org> 2008-03-17 Eugene Teo <eteo@redhat.com> * systemtap.base/maxactive.exp, probefunc.exp: Standardize pass msg. 2008-03-14 Masami Hiramatsu <mhiramat@redhat.com> 2008-03-13 Frank Ch. Eigler <fche@elastic.org> * release prep: 0.6.2 version bump 2008-03-12 Dave Brolley <brolley@redhat.com> 2008-03-11 Will Cohen <wcohen@redhat.com> ...
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog4
-rw-r--r--doc/langref.tex24
2 files changed, 14 insertions, 14 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 902e1d1e..e652078d 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,7 @@
+2008-03-25 Frank Ch. Eigler <fche@elastic.org>
+
+ * langref.tex: Clarify utility of epilogue-type probe aliases.
+
2008-03-04 David Smith <dsmith@redhat.com>
* tutorial.tex: Made minor changes to remove warnings.
diff --git a/doc/langref.tex b/doc/langref.tex
index 5b91d01d..973769d4 100644
--- a/doc/langref.tex
+++ b/doc/langref.tex
@@ -230,7 +230,7 @@ This prints:
\end{verbatim}
\end{vindent}
Any larger number input to the function may exceed the MAXACTION or MAXNESTING
-limits, which will be caught by the parser and result in an error. For more
+limits, which will be caught at run time and result in an error. For more
about limits see Section~\ref{sub:SystemTap-safety}.
\newpage{}
\subsection{The stap command}
@@ -436,8 +436,10 @@ probe syscall.read = kernel.function("sys_read") {
\index{epilogue-style aliases}
\index{+=}
The statement block that follows an alias definition is implicitly added
-as an epilogue to any probe that refers to the alias. The following is an
-example:
+as an epilogue to any probe that refers to the alias. It is not useful
+to define new variable there (since no subsequent code will see it), but
+rather the code can take action based upon variables left set by the
+prologue or by the user code. The following is an example:
\begin{vindent}
\begin{verbatim}
@@ -445,15 +447,15 @@ example:
# epilogue.
#
probe syscall.read += kernel.function("sys_read") {
- fildes = $fd
+ if (traceme) println ("tracing me")
}
\end{verbatim}
\end{vindent}
\subsubsection{Probe alias usage}
-Another probe definition may use a previously defined alias. The following
-is an example.
+A probe alias is used the same way as any built-in probe type, by
+naming it:
\begin{vindent}
\begin{verbatim}
@@ -1027,12 +1029,6 @@ type conversions between strings and numbers. Inconsistent type-related use
of identifiers signals an error.
-\subsubsection{Numbers}
-\index{numbers}
-Numbers are 64-bit signed integers. The parser will also accept (and wrap
-around) values above positive $2^{63}$.
-
-
\subsubsection{Literals}
\index{literals}
Literals are either strings or integers. Literals can be expressed as decimal,
@@ -1041,10 +1037,10 @@ octal, or hexadecimal, using C notation. Type suffixes (e.g., \emph{L} or
\subsubsection{Integers\label{sub:Integers}}
-\index{integers}
+\index{integers} \index{numbers}
Integers are decimal, hexadecimal, or octal, and use the same notation as
in C. Integers are 64-bit signed quantities, although the parser also accepts
-(and wraps around) values above positive $2^{63}$.
+(and wraps around) values above positive $2^{63}$ but below $2^{64}$.
\subsubsection{Strings\label{sub:Strings}}