mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-01 12:20:26 +02:00
Code Activity

Doc fixes

Browse source
This commit is contained in:
Neil Jerram 2001-04-20 13:26:55 +00:00
parent a26fb67d83
commit ffda60939e
3 changed files with 17 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/ChangeLog
View file

@ -1,5 +1,12 @@
2001-04-20 Neil Jerram <neil@ossau.uklinux.net> 2001-04-20 Neil Jerram <neil@ossau.uklinux.net>
* 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 * recipe-guidelines.txt: New file: guidelines for contributions to
the Guile Recipes manual. the Guile Recipes manual.

15
doc/data-rep.texi
View file

@ -46,7 +46,7 @@
@c essay @sp 10 @c essay @sp 10
@c essay @comment The title is printed in a large font. @c essay @comment The title is printed in a large font.
@c essay @title Data Representation in Guile @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 @subtitle For use with Guile @value{VERSION}
@c essay @author Jim Blandy @c essay @author Jim Blandy
@c essay @author Free Software Foundation @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. exact complement of @code{SCM_IMP}, above.
@end deftypefn @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 @code{SCM_NIMP} macro before calling a finer-grained predicate to
determine @var{x}'s type, such as @code{SCM_CONSP} or determine @var{x}'s type, such as @code{SCM_CONSP} or
@code{SCM_VECTORP}. The definitions of all Guile type predicates @code{SCM_VECTORP}. This is no longer required: the definitions of all
now include a call to @code{SCM_NIMP} where necessary. Guile type predicates now include a call to @code{SCM_NIMP} where
necessary.
@node Immediate Datatypes @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 in the first word of the heap cell indicates more precisely the type of
that object. that object.
As of Guile 1.4, the type predicates for non-immediate values work The type predicates for non-immediate values work correctly on any
correctly on any @code{SCM} value; you do not need to call @code{SCM} value; you do not need to call @code{SCM_NIMP} first, to
@code{SCM_NIMP} first, to establish that a value is non-immediate. establish that a value is non-immediate.
@menu @menu
* Pair Data:: * Pair Data::

4
doc/gh.texi
View file

@ -244,8 +244,8 @@ parentheses, you must either concatenate them into one string, or use
@deftypefun SCM gh_eval_file (char *@var{fname}) @deftypefun SCM gh_eval_file (char *@var{fname})
@deftypefunx SCM gh_load (char *@var{fname}) @deftypefunx SCM gh_load (char *@var{fname})
@code{gh_eval_file} is completely analogous to @code{gh_eval_str()}, @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 except that a whole file is evaluated instead of a string.
result of the last expression evaluated. @code{gh_eval_file} returns @code{SCM_UNSPECIFIED}.
@code{gh_load} is identical to @code{gh_eval_file} (it's a macro that @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 calls @code{gh_eval_file} on its argument). It is provided to start