From cc9ee6059e4d3fb51c0695a8a57f75eb988a1786 Mon Sep 17 00:00:00 2001
From: fche <fche>
Date: Mon, 5 Sep 2005 22:00:43 +0000
Subject: 2005-09-05  Frank Ch. Eigler  <fche@elastic.org>

	PR 1172.
	* staptree.h, staptree.cxx: Make all ::print*(), operator<<
	functions take const staptree objects.
	(literal_string::print): \-prefix double-quotes.
	* translate.cxx (emit_common_header): Add context probe_point field.
	Switch to atomic_t busy flags.
	(emit_module_exit): Use atomic operations for busy flag.
	(visit_*): Use lex_cast_qstring for last_stmt strings.
	* tapsets.cxx (lex_cast_quoted): \-prefix double-quotes too.
	(*::emit_probe_entries): Populate probe_point.  Use atomic operations
	for busy flag.
	* tapset/context.stp (pp): New function.
	* stapfuncs.5.in: Document it.
	* testsuite/buildok/context_test.stp: Test it.
---
 stapfuncs.5.in | 39 ++++++++++++++++++++++-----------------
 1 file changed, 22 insertions(+), 17 deletions(-)

(limited to 'stapfuncs.5.in')

diff --git a/stapfuncs.5.in b/stapfuncs.5.in
index 212e5193..dbecf0d3 100644
--- a/stapfuncs.5.in
+++ b/stapfuncs.5.in
@@ -15,13 +15,13 @@ Examples:
 
 .TP
 example1:long (v:string, k:long)
-Function "example1" does something with the given string and integer.
-It returns some integer.
+In function "example1", do something with the given string and integer.
+Return some integer.
 
 .TP
 example2:unknown ()
-Function "example2" does something.  There is no explicit return value
-and it takes no parameters.
+In function "example2", do something.  There is no explicit return value
+and take no parameters.
 
 .SS LOGGING
 
@@ -98,52 +98,57 @@ Return the number of seconds since the UNIX epoch.
 
 .TP
 execname:string ()
-Returns the name of the current process.
+Return the name of the current process.
 
 .TP
 pexecname:string()
-Returns the name of the parent process.
+Return the name of the parent process.
 
 .TP
 pid:long ()
-Returns the current pid. 
+Return the current pid. 
 
 .TP
 ppid:long ()
-Returns the current pid.
+Return the current pid.
 
 .TP
 uid:long ()
-Returns the uid of the current process.
+Return the uid of the current process.
 
 .TP
 euid:long ()
-Returns the effective uid of the current process.
+Return the effective uid of the current process.
 
 .TP
 gid:long ()
-Returns the gid of the current process.
+Return the gid of the current process.
 
 .TP
 egid:long ()
-Returns the effective gid of the current process.
+Return the effective gid of the current process.
 
 .TP
 print_regs:unknown ()
-Prints a register dump.
+Print a register dump.
 
 .TP
 print_backtrace:unknown ()
-Prints a symbolic backtrace.  Use with care. May be timeconsuming.
+Print a symbolic backtrace.  Use with care.  May be timeconsuming.
 
 .TP
 backtrace:string ()
-Returns a string of hex addresses that are a backtrace of the stack.
+Return a string of hex addresses that are a backtrace of the stack.
 May be truncated due to maximum string length.
 
 .TP
-print_stack(bt:string)
-Does a symbolic lookup of the addresses in bt and prints one per line.
+print_stack (bt:string)
+Perform a symbolic lookup of the addresses in bt and prints one per line.
+
+.TP
+pp:string ()
+Return the probe point associated with the currently running probe handler,
+including alias and wildcard expansion effects.
 
 .SH FILES
 .nh
-- 
cgit