minor doc changes regarding SCM and scm_t_bits

minor doc changes regarding SCM and scm_t_bits

[Richard Y. Kim]

Patches for data-rep.texi and gh.texi are given below.
Two sets of changes in the patches are:

* Moved `@deftyp {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 `@deftp' 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:
 
-@itemize @bullet
-@item
+@deftp {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.
+@end deftp
+@cindex SCM data type
 
-@item
+@deftp {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.
-@end itemize
+@end 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:
 
-@deftp {Data type} SCM
-This is a C data type used to store all Scheme data, no matter what the
+@code{SCM} 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.]
-@end deftp
-@cindex SCM data type
 
 @defvr Constant SCM_BOOL_T
 @defvrx Constant SCM_BOOL_F


_______________________________________________
Bug-guile mailing list
Bug-guile@gnu.org
http://mail.gnu.org/mailman/listinfo/bug-guile

Re: minor doc changes regarding SCM and scm_t_bits

[Marius Vollmer]

"Richard Y. Kim" <ryk@dspwiz.com> writes:

> Patches for data-rep.texi and gh.texi are given below.

Thanks, applied!

_______________________________________________
Bug-guile mailing list
Bug-guile@gnu.org
http://mail.gnu.org/mailman/listinfo/bug-guile