guile/guile-core/doc ChangeLog scheme-debug.texi

[Neil Jerram]

CVSROOT:        /cvs
Module name:    guile
Changes by:     Neil Jerram <address@hidden>    01/08/02 13:27:42

Modified files:
        guile-core/doc : ChangeLog scheme-debug.texi 

Log message:
        * Improve `make-stack' doc by explaining cutting args.

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/guile/guile-core/doc/ChangeLog.diff?cvsroot=OldCVS&tr1=1.112&tr2=1.113&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/guile/guile-core/doc/scheme-debug.texi.diff?cvsroot=OldCVS&tr1=1.3&tr2=1.4&r1=text&r2=text

Patches:
Index: guile/guile-core/doc/ChangeLog
diff -u guile/guile-core/doc/ChangeLog:1.112 
guile/guile-core/doc/ChangeLog:1.113
--- guile/guile-core/doc/ChangeLog:1.112        Thu Jul 19 10:58:37 2001
+++ guile/guile-core/doc/ChangeLog      Thu Aug  2 13:27:42 2001
@@ -1,3 +1,8 @@
+2001-08-02  Neil Jerram  <address@hidden>
+
+       * scheme-debug.texi (Debugging): Improve `make-stack' doc by
+       explaining cutting args.
+
 2001-07-19  Rob Browning  <address@hidden>
 
        * posix.texi (Signals): add docs for setitimer and getitimer.
Index: guile/guile-core/doc/scheme-debug.texi
diff -u guile/guile-core/doc/scheme-debug.texi:1.3 
guile/guile-core/doc/scheme-debug.texi:1.4
--- guile/guile-core/doc/scheme-debug.texi:1.3  Fri May  4 14:54:00 2001
+++ guile/guile-core/doc/scheme-debug.texi      Thu Aug  2 13:27:42 2001
@@ -139,8 +139,30 @@
 evaluation stack is used for creating the stack frames,
 otherwise the frames are taken from @var{obj} (which must be
 either a debug object or a continuation).
address@hidden must be a list of integers and specifies how the
-resulting stack will be narrowed.
+
address@hidden should be a list containing any combination of
+integer, procedure and @code{#t} values.
+
+These values specify various ways of cutting away uninteresting
+stack frames from the top and bottom of the stack that
address@hidden returns.  They come in pairs like this:
address@hidden(@var{inner_cut_1} @var{outer_cut_1} @var{inner_cut_2}
address@hidden @dots{})}.
+
+Each @var{inner_cut_N} can be @code{#t}, an integer, or a
+procedure.  @code{#t} means to cut away all frames up to but
+excluding the first user module frame.  An integer means to cut
+away exactly that number of frames.  A procedure means to cut
+away all frames up to but excluding the application frame whose
+procedure matches the specified one.
+
+Each @var{outer_cut_N} can be an integer or a procedure.  An
+integer means to cut away that number of frames.  A procedure
+means to cut away frames down to but excluding the application
+frame whose procedure matches the specified one.
+
+If the @var{outer_cut_N} of the last pair is missing, it is
+taken as 0.
 @end deffn
 
 @deffn primitive stack-id stack