1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-20 11:40:18 +02:00

Fix uses of 'scm_gc_protect', which does not exist, in the manual.

* doc/ref/api-memory.texi (Garbage Collection Functions),
  doc/ref/libguile-concepts.texi (Garbage Collection): Change
  'scm_gc_protect' --> 'scm_gc_protect_object'.
This commit is contained in:
Mark H Weaver 2015-09-02 13:51:05 -04:00 committed by Andy Wingo
parent d77247b90b
commit 3cf70e36f1
2 changed files with 5 additions and 5 deletions

View file

@ -1,6 +1,6 @@
@c -*-texinfo-*- @c -*-texinfo-*-
@c This is part of the GNU Guile Reference Manual. @c This is part of the GNU Guile Reference Manual.
@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2009, 2010, 2012, 2013, 2014 @c Copyright (C) 1996, 1997, 2000-2004, 2009, 2010, 2012-2016
@c Free Software Foundation, Inc. @c Free Software Foundation, Inc.
@c See the file guile.texi for copying conditions. @c See the file guile.texi for copying conditions.
@ -36,7 +36,7 @@ explicitly. It is called automatically when appropriate.
Protects @var{obj} from being freed by the garbage collector, when it Protects @var{obj} from being freed by the garbage collector, when it
otherwise might be. When you are done with the object, call otherwise might be. When you are done with the object, call
@code{scm_gc_unprotect_object} on the object. Calls to @code{scm_gc_unprotect_object} on the object. Calls to
@code{scm_gc_protect}/@code{scm_gc_unprotect_object} can be nested, and @code{scm_gc_protect_object}/@code{scm_gc_unprotect_object} can be nested, and
the object remains protected until it has been unprotected as many times the object remains protected until it has been unprotected as many times
as it was protected. It is an error to unprotect an object more times as it was protected. It is an error to unprotect an object more times
than it has been protected. Returns the SCM object it was passed. than it has been protected. Returns the SCM object it was passed.

View file

@ -1,7 +1,7 @@
@c -*-texinfo-*- @c -*-texinfo-*-
@c This is part of the GNU Guile Reference Manual. @c This is part of the GNU Guile Reference Manual.
@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2005, 2010, @c Copyright (C) 1996-1997, 2000-2005, 2010-2011, 2013-2016
@c 2011, 2013, 2014 Free Software Foundation, Inc. @c Free Software Foundation, Inc.
@c See the file guile.texi for copying conditions. @c See the file guile.texi for copying conditions.
@node General Libguile Concepts @node General Libguile Concepts
@ -197,7 +197,7 @@ sections, function arguments or local variables on the C and Scheme
stacks, and values in machine registers. Other references to @code{SCM} stacks, and values in machine registers. Other references to @code{SCM}
objects, such as those in other random data structures in the C heap objects, such as those in other random data structures in the C heap
that contain fields of type @code{SCM}, can be made visible to the that contain fields of type @code{SCM}, can be made visible to the
garbage collector by calling the functions @code{scm_gc_protect} or garbage collector by calling the functions @code{scm_gc_protect_object} or
@code{scm_permanent_object}. Collectively, these values form the ``root @code{scm_permanent_object}. Collectively, these values form the ``root
set'' of garbage collection; any value on the heap that is referenced set'' of garbage collection; any value on the heap that is referenced
directly or indirectly by a member of the root set is preserved, and all directly or indirectly by a member of the root set is preserved, and all