guile/guile-core/libguile ChangeLog stacks.c

[Neil Jerram]

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

Modified files:
        guile-core/libguile: ChangeLog stacks.c 

Log message:
        * Explain cutting args for `make-stack'.

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/guile/guile-core/libguile/ChangeLog.diff?cvsroot=OldCVS&tr1=1.1487&tr2=1.1488&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/guile/guile-core/libguile/stacks.c.diff?cvsroot=OldCVS&tr1=1.65&tr2=1.66&r1=text&r2=text

Patches:
Index: guile/guile-core/libguile/ChangeLog
diff -u guile/guile-core/libguile/ChangeLog:1.1487 
guile/guile-core/libguile/ChangeLog:1.1488
--- guile/guile-core/libguile/ChangeLog:1.1487  Wed Aug  1 14:28:20 2001
+++ guile/guile-core/libguile/ChangeLog Thu Aug  2 13:26:21 2001
@@ -1,3 +1,8 @@
+2001-08-02  Neil Jerram  <address@hidden>
+
+       * stacks.c (scm_make_stack): Improve docstring by explaining use
+       of cutting args.
+
 2001-08-01  Marius Vollmer  <address@hidden>
 
        * chars.c (scm_char_alphabetic_p, scm_char_numeric_p,
Index: guile/guile-core/libguile/stacks.c
diff -u guile/guile-core/libguile/stacks.c:1.65 
guile/guile-core/libguile/stacks.c:1.66
--- guile/guile-core/libguile/stacks.c:1.65     Mon Jul  9 00:36:47 2001
+++ guile/guile-core/libguile/stacks.c  Thu Aug  2 13:26:21 2001
@@ -420,9 +420,26 @@
            "Create a new stack. If @var{obj} is @code{#t}, the current\n"
            "evaluation stack is used for creating the stack frames,\n"
            "otherwise the frames are taken from @var{obj} (which must be\n"
-           "either a debug object or a continuation).\n"
-           "@var{args} must be a list of integers and specifies how the\n"
-           "resulting stack will be narrowed.")
+           "either a debug object or a continuation).\n\n"
+           "@var{args} should be a list containing any combination of\n"
+           "integer, procedure and @code{#t} values.\n\n"
+           "These values specify various ways of cutting away uninteresting\n"
+           "stack frames from the top and bottom of the stack that\n"
+           "@code{make-stack} returns.  They come in pairs like this:\n"
+           "@code{(@var{inner_cut_1} @var{outer_cut_1} @var{inner_cut_2}\n"
+           "@var{outer_cut_2} @dots{})}.\n\n"
+           "Each @var{inner_cut_N} can be @code{#t}, an integer, or a\n"
+           "procedure.  @code{#t} means to cut away all frames up to but\n"
+           "excluding the first user module frame.  An integer means to cut\n"
+           "away exactly that number of frames.  A procedure means to cut\n"
+           "away all frames up to but excluding the application frame whose\n"
+           "procedure matches the specified one.\n\n"
+           "Each @var{outer_cut_N} can be an integer or a procedure.  An\n"
+           "integer means to cut away that number of frames.  A procedure\n"
+           "means to cut away frames down to but excluding the application\n"
+           "frame whose procedure matches the specified one.\n\n"
+           "If the @var{outer_cut_N} of the last pair is missing, it is\n"
+           "taken as 0.")
 #define FUNC_NAME s_scm_make_stack
 {
   long n, size;