From ffda60939e37a76f2804fcd818a4b927748c77b4 Mon Sep 17 00:00:00 2001 From: Neil Jerram Date: Fri, 20 Apr 2001 13:26:55 +0000 Subject: [PATCH] Doc fixes --- doc/ChangeLog | 7 +++++++ doc/data-rep.texi | 15 ++++++++------- doc/gh.texi | 4 ++-- 3 files changed, 17 insertions(+), 9 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index c2cecee39..2d662f6a2 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,5 +1,12 @@ 2001-04-20 Neil Jerram + * gh.texi (Executing Scheme code): gh_eval_file returns + SCM_UNSPECIFIED. Thanks to Dirk for the report! + + * data-rep.texi (Non-immediate Datatypes, Immediates vs + Non-immediates): Emphasize current rather than pre-1.4 practice + when talking about not needing to call SCM_NIMP. + * recipe-guidelines.txt: New file: guidelines for contributions to the Guile Recipes manual. diff --git a/doc/data-rep.texi b/doc/data-rep.texi index f758df3f8..83edcb87c 100644 --- a/doc/data-rep.texi +++ b/doc/data-rep.texi @@ -46,7 +46,7 @@ @c essay @sp 10 @c essay @comment The title is printed in a large font. @c essay @title Data Representation in Guile -@c essay @subtitle $Id: data-rep.texi,v 1.21 2001-04-16 09:38:32 ossau Exp $ +@c essay @subtitle $Id: data-rep.texi,v 1.22 2001-04-20 13:26:55 ossau Exp $ @c essay @subtitle For use with Guile @value{VERSION} @c essay @author Jim Blandy @c essay @author Free Software Foundation @@ -577,11 +577,12 @@ Return non-zero iff @var{x} is a non-immediate object. This is the exact complement of @code{SCM_IMP}, above. @end deftypefn -Note that, as of Guile 1.4, it is no longer necessary to use the +Note that for versions of Guile prior to 1.4 it was necessary to use the @code{SCM_NIMP} macro before calling a finer-grained predicate to determine @var{x}'s type, such as @code{SCM_CONSP} or -@code{SCM_VECTORP}. The definitions of all Guile type predicates -now include a call to @code{SCM_NIMP} where necessary. +@code{SCM_VECTORP}. This is no longer required: the definitions of all +Guile type predicates now include a call to @code{SCM_NIMP} where +necessary. @node Immediate Datatypes @@ -750,9 +751,9 @@ non-immediate --- in other words stored in a heap cell. The tag stored in the first word of the heap cell indicates more precisely the type of that object. -As of Guile 1.4, the type predicates for non-immediate values work -correctly on any @code{SCM} value; you do not need to call -@code{SCM_NIMP} first, to establish that a value is non-immediate. +The type predicates for non-immediate values work correctly on any +@code{SCM} value; you do not need to call @code{SCM_NIMP} first, to +establish that a value is non-immediate. @menu * Pair Data:: diff --git a/doc/gh.texi b/doc/gh.texi index 691fd5515..106ed057a 100644 --- a/doc/gh.texi +++ b/doc/gh.texi @@ -244,8 +244,8 @@ parentheses, you must either concatenate them into one string, or use @deftypefun SCM gh_eval_file (char *@var{fname}) @deftypefunx SCM gh_load (char *@var{fname}) @code{gh_eval_file} is completely analogous to @code{gh_eval_str()}, -except that a whole file is evaluated instead of a string. Returns the -result of the last expression evaluated. +except that a whole file is evaluated instead of a string. +@code{gh_eval_file} returns @code{SCM_UNSPECIFIED}. @code{gh_load} is identical to @code{gh_eval_file} (it's a macro that calls @code{gh_eval_file} on its argument). It is provided to start