diff options
author | Andy Wingo <wingo@pobox.com> | 2010-10-07 22:27:00 +0200 |
---|---|---|
committer | Andy Wingo <wingo@pobox.com> | 2010-10-07 22:27:00 +0200 |
commit | 90729e71055f5c763bbcef500a548bf1786b6743 (patch) | |
tree | 5278ee91dc83a433ea3aa0b42009e49608347d1b /doc/ref/api-debug.texi | |
parent | 5db7c0bf4ae6266415b464f8e011209e7a7f55fd (diff) | |
download | guile-90729e71055f5c763bbcef500a548bf1786b6743.tar.gz |
document tracing traps
* doc/ref/api-debug.texi (Tracing Traps): Document the traps.
Diffstat (limited to 'doc/ref/api-debug.texi')
-rw-r--r-- | doc/ref/api-debug.texi | 28 |
1 files changed, 25 insertions, 3 deletions
diff --git a/doc/ref/api-debug.texi b/doc/ref/api-debug.texi index f6342b021..c577ca46d 100644 --- a/doc/ref/api-debug.texi +++ b/doc/ref/api-debug.texi @@ -1101,13 +1101,35 @@ trace: (facti 24 0) trace: 24 @end lisp -@deffn {Scheme Procedure} trace-calls-to-procedure proc #:key (width 80) (vm (the-vm)) (prefix "trace: ")) +The low-level traps below (@pxref{Low-Level Traps}) share some common +options: + +@table @code +@item #:width +The maximum width of trace output. Trace printouts will try not to +exceed this column, but for highly nested procedure calls, it may be +unavoidable. Defaults to 80. +@item #:vm +The VM on which to add the traps. Defaults to the current thread's VM. +@item #:prefix +A string to print out before each trace line. As seen above in the +examples, defaults to @code{"trace: "}. +@end table + +@deffn {Scheme Procedure} trace-calls-to-procedure proc @ + [#:width] [#:vm] [#:prefix] +Print a trace at applications of and returns from @var{proc}. @end deffn -@deffn {Scheme Procedure} trace-calls-in-procedure proc #:key (width 80) (vm (the-vm)) (prefix "trace: ")) +@deffn {Scheme Procedure} trace-calls-in-procedure proc @ + [#:width] [#:vm] [#:prefix] +Print a trace at all applications and returns within the dynamic extent +of calls to @var{proc}. @end deffn -@deffn {Scheme Procedure} trace-instructions-in-procedure proc #:key (width 80) (vm (the-vm)) +@deffn {Scheme Procedure} trace-instructions-in-procedure proc [#:width] [#:vm] +Print a trace at all instructions executed in the dynamic extent of +calls to @var{proc}. @end deffn In addition, Guile defines a procedure to call a thunk, tracing all |