summaryrefslogtreecommitdiffstats
path: root/stapfuncs.5.in
diff options
context:
space:
mode:
authorfche <fche>2006-05-12 17:50:35 +0000
committerfche <fche>2006-05-12 17:50:35 +0000
commit8b181aa4a0ae696d349b45a45e584ea527e8e26b (patch)
tree9b79858ee0348f5830aa97015f2342bb93580808 /stapfuncs.5.in
parent17926083bb5a1538bf41951d15e23d0e9027d4ef (diff)
downloadsystemtap-steved-8b181aa4a0ae696d349b45a45e584ea527e8e26b.tar.gz
systemtap-steved-8b181aa4a0ae696d349b45a45e584ea527e8e26b.tar.xz
systemtap-steved-8b181aa4a0ae696d349b45a45e584ea527e8e26b.zip
2006-05-12 Frank Ch. Eigler <fche@elastic.org>
* stapfuncs.5.in: Clarify backtrace-related functions.
Diffstat (limited to 'stapfuncs.5.in')
-rw-r--r--stapfuncs.5.in19
1 files changed, 13 insertions, 6 deletions
diff --git a/stapfuncs.5.in b/stapfuncs.5.in
index 0bfac1b8..2d3d0678 100644
--- a/stapfuncs.5.in
+++ b/stapfuncs.5.in
@@ -141,15 +141,22 @@ Return the effective gid of the current process.
print_regs:unknown ()
Print a register dump.
.TP
-print_backtrace:unknown ()
-Print a symbolic backtrace. Use with care. May be timeconsuming.
-.TP
backtrace:string ()
Return a string of hex addresses that are a backtrace of the stack.
-May be truncated due to maximum string length.
+It may be truncated due to maximum string length.
.TP
-print_stack (bt:string)
-Perform a symbolic lookup of the addresses in bt and prints one per line.
+print_stack:unknown (bt:string)
+Perform a symbolic lookup of the addresses in the given string,
+which is assumed to be the result of a prior call to
+.IR backtrace() .
+Print one line per address, including the address, the name of the
+function containing the address, and an estimate of its position
+within that function. Return nothing.
+.TP
+print_backtrace:unknown ()
+Equivalent to
+.IR print_stack(backtrace()) ,
+except that deeper stack nesting may be supported. Return nothing.
.TP
pp:string ()
Return the probe point associated with the currently running probe handler,