From: Serguei Makarov <smakarov@redhat.com>
Date: Thu, 9 May 2013 18:54:44 +0000 (-0400)
Subject: java/byteman docs oops: document context variables in java probes
X-Git-Tag: release-2.2~24
X-Git-Url: https://sourceware.org/git/?a=commitdiff_plain;h=a26d56a4cf119c941b8573d83f25a81aee7fe0fc;p=systemtap.git

java/byteman docs oops: document context variables in java probes
---

diff --git a/doc/langref.tex b/doc/langref.tex
index 3e3c8d005..9494c5a76 100644
--- a/doc/langref.tex
+++ b/doc/langref.tex
@@ -1442,6 +1442,13 @@ The last two probe points work analogously, but refer to Java
 processes by PID. (PIDs for already running processes can be obtained
 using the \texttt{jps} utility.)
 
+Context variables defined within java probes include \verb+$provider+
+(which identifies the class providing the definition of the triggered
+method) and \verb+$name+ (which gives the signature of the method).
+Arguments to the method can be accessed using context variables
+\verb+$arg1$+ through \verb+$arg10+, for up to the first 10 arguments
+of a method.
+
 \subsection{PROCFS probes}
 \index{PROCFS probes}
 These probe points allow procfs pseudo-files in
diff --git a/man/stapprobes.3stap b/man/stapprobes.3stap
index 203cea3de..6e2d1bbc8 100644
--- a/man/stapprobes.3stap
+++ b/man/stapprobes.3stap
@@ -857,6 +857,18 @@ java(PID).class("CLASSNAME").method("PATTERN").return
 (PIDs for an already running process can be obtained using the
 .IR jps (1)
 utility.)
+.PP
+Context variables defined within java probes include
+.IR $provider
+(which identifies the class providing the definition of the triggered
+method) and
+.IR $name
+(which gives the signature of the method). Arguments to the method can be
+accessed using context variables
+.IR $arg1
+through
+.IR $arg10
+(for up to the first 10 arguments of a method).
 
 .SS PROCFS