[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
minor doc changes regarding SCM and scm_t_bits
From: |
Richard Y. Kim |
Subject: |
minor doc changes regarding SCM and scm_t_bits |
Date: |
Sun, 31 Mar 2002 19:12:24 -0800 |
Patches for data-rep.texi and gh.texi are given below.
Two sets of changes in the patches are:
* Moved address@hidden {Data type} SCM' line from gh.texi to data-rep.texi.
Both files already had similar descriptions for SCM.
Given that gh.texi is deprecated, looking up `SCM' in the index
should take one to the primary location rather than deprecated
section. Hence this change.
* Added address@hidden' for scm_t_bits data type so that a proper index entry
is added for this.
Index: data-rep.texi
===================================================================
RCS file: /cvsroot/guile/guile/guile-core/doc/ref/data-rep.texi,v
retrieving revision 1.7
diff -u -r1.7 data-rep.texi
--- data-rep.texi 29 Mar 2002 20:25:23 -0000 1.7
+++ data-rep.texi 1 Apr 2002 03:11:51 -0000
@@ -1048,22 +1048,23 @@
In fact, there are two basic C data types to represent objects in Guile:
address@hidden @bullet
address@hidden
address@hidden {Data type} SCM
@code{SCM} is the user level abstract C type that is used to represent
all of Guile's Scheme objects, no matter what the Scheme object type is.
No C operation except assignment is guaranteed to work with variables of
type @code{SCM}, so you should only use macros and functions to work
with @code{SCM} values. Values are converted between C data types and
the @code{SCM} type with utility functions and macros.
address@hidden deftp
address@hidden SCM data type
address@hidden
address@hidden {Data type} scm_t_bits
@code{scm_t_bits} is an integral data type that is guaranteed to be
large enough to hold all information that is required to represent any
Scheme object. While this data type is mostly used to implement Guile's
internals, the use of this type is also necessary to write certain kinds
of extensions to Guile.
address@hidden itemize
address@hidden deftp
@menu
* Relationship between SCM and scm_t_bits::
Index: gh.texi
===================================================================
RCS file: /cvsroot/guile/guile/guile-core/doc/ref/gh.texi,v
retrieving revision 1.4
diff -u -r1.4 gh.texi
--- gh.texi 27 Feb 2002 15:41:00 -0000 1.4
+++ gh.texi 1 Apr 2002 03:11:16 -0000
@@ -97,13 +97,10 @@
The following C constants and data types are defined in gh:
address@hidden {Data type} SCM
-This is a C data type used to store all Scheme data, no matter what the
address@hidden is a C data type used to store all Scheme data, no matter what
the
Scheme type. Values are converted between C data types and the SCM type
with utility functions described below (@pxref{Converting data between C
and Scheme}). [FIXME: put in references to Jim's essay and so forth.]
address@hidden deftp
address@hidden SCM data type
@defvr Constant SCM_BOOL_T
@defvrx Constant SCM_BOOL_F
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- minor doc changes regarding SCM and scm_t_bits,
Richard Y. Kim <=