From 4338f2f91e1dd63a40384077d091295d90047926 Mon Sep 17 00:00:00 2001 From: Andy Wingo Date: Mon, 28 Apr 2014 18:00:05 +0200 Subject: Prefer foreign objects over smobs in manual * doc/ref/api-memory.texi (Memory Blocks): Recommend against scm_gc_free. Refer to foreign objects instead of smobs. Remove discussion of scm_must_malloc et al. * doc/ref/guile.texi (API Reference): Rename SMOB menu item. * doc/ref/libguile-snarf.texi (Function Snarfing): Update example to not refer to smobs. * doc/ref/tools.texi (How guile-snarf works): Likewise. --- doc/ref/tools.texi | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'doc/ref/tools.texi') diff --git a/doc/ref/tools.texi b/doc/ref/tools.texi index 2c624936f..e962a86ab 100644 --- a/doc/ref/tools.texi +++ b/doc/ref/tools.texi @@ -1,6 +1,6 @@ @c -*-texinfo-*- @c This is part of the GNU Guile Reference Manual. -@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2011 +@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2011, 2014 @c Free Software Foundation, Inc. @c See the file guile.texi for copying conditions. @@ -112,11 +112,11 @@ For example, here is how you might define a new subr called #include SCM_DEFINE (clear_image, "clear-image", 1, 0, 0, - (SCM image_smob), + (SCM image), "Clear the image.") #define FUNC_NAME s_clear_image @{ - /* C code to clear the image in @code{image_smob}... */ + /* C code to clear the image in @code{image}... */ @} #undef FUNC_NAME @@ -131,8 +131,8 @@ init_image_type () The @code{SCM_DEFINE} declaration says that the C function @code{clear_image} implements a Scheme subr called @code{clear-image}, which takes one required argument (of type @code{SCM} and named -@code{image_smob}), no optional arguments, and no rest argument. -@xref{Doc Snarfing}, for info on the docstring. +@code{image}), no optional arguments, and no rest argument. @xref{Doc +Snarfing}, for info on the docstring. This works in concert with @code{FUNC_NAME} to also define a static array of characters named @code{s_clear_image}, initialized to the -- cgit v1.2.3