diff options
author | Andy Wingo <wingo@pobox.com> | 2014-04-28 17:45:07 +0200 |
---|---|---|
committer | Andy Wingo <wingo@pobox.com> | 2014-04-28 17:45:07 +0200 |
commit | d9a4a1cde13422a8e9656bb7745dc31692deb955 (patch) | |
tree | 5b23dc5b58ace811e12b993bab7a458f3836dfb6 /doc/ref/api-control.texi | |
parent | 6e4630e01a7192451e2d1806b26ebf38816464e4 (diff) | |
download | guile-d9a4a1cde13422a8e9656bb7745dc31692deb955.tar.gz |
Remove SMOB tutorial; update manual.
* doc/ref/libguile-smobs.texi: Remove; this tutorial is superseded by
libguile-foreign-objects.
* doc/ref/libguile-foreign-objects.texi: Proofreading.
* doc/ref/libguile-program.texi: Update Dia examples to refer to foreign
objects.
* doc/ref/libguile-concepts.texi (Garbage Collection): Update to
accurately describe the BDW-GC, and to avoid reference to mark
functions.
* doc/ref/guile.texi: Remove libguile-smobs, and reword API menu.
* doc/ref/api-utility.texi (Equality): Mention GOOPS instead of SMOBs.
* doc/ref/api-smobs.texi (Smobs): Describe as a legacy interface.
Exhort readers against the writing of mark functions.
* doc/ref/api-foreign-objects.texi (Foreign Objects): Proofreading.
* doc/ref/api-control.texi (Catch): Fix ref to point to foreign
objects.
* doc/ref/Makefile.am: Remove libguile-smobs.texi.
Diffstat (limited to 'doc/ref/api-control.texi')
-rw-r--r-- | doc/ref/api-control.texi | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/ref/api-control.texi b/doc/ref/api-control.texi index 7ffb3f740..0b08dced1 100644 --- a/doc/ref/api-control.texi +++ b/doc/ref/api-control.texi @@ -1,7 +1,7 @@ @c -*-texinfo-*- @c This is part of the GNU Guile Reference Manual. @c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2009, 2010, -@c 2011, 2012, 2013 Free Software Foundation, Inc. +@c 2011, 2012, 2013, 2014 Free Software Foundation, Inc. @c See the file guile.texi for copying conditions. @node Control Mechanisms @@ -1184,13 +1184,13 @@ The @var{body_data} and @var{handler_data} parameters are passed to the respective calls so an application can communicate extra information to those functions. -If the data consists of an @code{SCM} object, care should be taken -that it isn't garbage collected while still required. If the -@code{SCM} is a local C variable, one way to protect it is to pass a -pointer to that variable as the data parameter, since the C compiler -will then know the value must be held on the stack. Another way is to -use @code{scm_remember_upto_here_1} (@pxref{Remembering During -Operations}). +If the data consists of an @code{SCM} object, care should be taken that +it isn't garbage collected while still required. If the @code{SCM} is a +local C variable, one way to protect it is to pass a pointer to that +variable as the data parameter, since the C compiler will then know the +value must be held on the stack. Another way is to use +@code{scm_remember_upto_here_1} (@pxref{Foreign Object Memory +Management}). @end deftypefn |