guile/guile-doc/ref ChangeLog scheme.texi posix...

[Neil Jerram]

CVSROOT:        /cvs
Module name:    guile
Changes by:     Neil Jerram <address@hidden>    00/09/22 06:54:38

Modified files:
        guile-doc/ref  : ChangeLog scheme.texi posix.texi scm.texi 
                         gh.texi 

Log message:
        * Docstring updates and texinfo warning fixes.

CVSWeb URLs:
http://subversions.gnu.org/cgi-bin/cvsweb/guile/guile-doc/ref/ChangeLog.diff?r1=1.67&r2=1.68
http://subversions.gnu.org/cgi-bin/cvsweb/guile/guile-doc/ref/scheme.texi.diff?r1=1.53&r2=1.54
http://subversions.gnu.org/cgi-bin/cvsweb/guile/guile-doc/ref/posix.texi.diff?r1=1.14&r2=1.15
http://subversions.gnu.org/cgi-bin/cvsweb/guile/guile-doc/ref/scm.texi.diff?r1=1.7&r2=1.8
http://subversions.gnu.org/cgi-bin/cvsweb/guile/guile-doc/ref/gh.texi.diff?r1=1.14&r2=1.15

Patches:
Index: guile/guile-doc/ref/ChangeLog
diff -u guile/guile-doc/ref/ChangeLog:1.67 guile/guile-doc/ref/ChangeLog:1.68
--- guile/guile-doc/ref/ChangeLog:1.67  Fri Sep 22 05:59:00 2000
+++ guile/guile-doc/ref/ChangeLog       Fri Sep 22 06:54:38 2000
@@ -1,5 +1,26 @@
 2000-09-22  Neil Jerram  <address@hidden>
 
+       * scm.texi (I/O internals): Add full stops (periods) after
+       standalone uses of @xref.
+
+       * scheme.texi (Structure Layout): Doc for make-struct-layout
+       changed to remove reference to "read-only" strings, which no
+       longer exist.
+       (Structure Basics): Use @pxref rather than @xref for parenthetical
+       reference.
+       (Dynamic Roots): Use @code rather than @var for code, in doc for
+       call-with-dynamic-root.
+       (Low level thread primitives): Ditto call-with-new-thread.
+       (Higher level thread procedures): Ditto call-with-new-thread.
+       (Symbols and Variables): Docs for gensym and symbol-hash updated
+       according to libguile changes.
+
+       * posix.texi (Generic Port Operations): Synchronized docstring
+       for unread-string.
+
+       * gh.texi (Defining new Scheme procedures in C): Avoid texinfo
+       warning by using @code rather than @var for code.
+
        * scheme.texi: Lots more docstring comments added, and docs
        synchronized with libguile source.
        (interaction-environment, make-struct, make-vtable-vtable): Newer,
Index: guile/guile-doc/ref/gh.texi
diff -u guile/guile-doc/ref/gh.texi:1.14 guile/guile-doc/ref/gh.texi:1.15
--- guile/guile-doc/ref/gh.texi:1.14    Mon Oct 26 22:09:47 1998
+++ guile/guile-doc/ref/gh.texi Fri Sep 22 06:54:38 2000
@@ -332,7 +332,7 @@
 
 @cartouche
 There are several important considerations to be made when writing the C
-routine @var{(*fn)()}.
+routine @code{(*fn)()}.
 
 First of all the C routine has to return type @code{SCM}.
 
Index: guile/guile-doc/ref/posix.texi
diff -u guile/guile-doc/ref/posix.texi:1.14 guile/guile-doc/ref/posix.texi:1.15
--- guile/guile-doc/ref/posix.texi:1.14 Fri Sep 22 05:02:58 2000
+++ guile/guile-doc/ref/posix.texi      Fri Sep 22 06:54:38 2000
@@ -293,7 +293,8 @@
 @end deffn
 
 @c docstring begin (c-doc-string "ports.c" "unread-string")
address@hidden primitive unread-string str [port]
address@hidden docstring md5 "7b185a3d540acdf2ec7f6b114c6c3c80"
address@hidden primitive unread-string str port
 Place the string @var{str} in @var{port} so that its characters will be
 read in subsequent read operations.  If called multiple times, the
 unread characters will be read again in last-in first-out order.  If
Index: guile/guile-doc/ref/scheme.texi
diff -u guile/guile-doc/ref/scheme.texi:1.53 
guile/guile-doc/ref/scheme.texi:1.54
--- guile/guile-doc/ref/scheme.texi:1.53        Fri Sep 22 05:58:59 2000
+++ guile/guile-doc/ref/scheme.texi     Fri Sep 22 06:54:38 2000
@@ -1739,11 +1739,11 @@
 structure layout, use this procedure:
 
 @c docstring begin (c-doc-string "struct.c" "make-struct-layout")
address@hidden docstring md5 "3db9fa14eec939642d6915c37115a9bf"
address@hidden docstring md5 "47b54dfa8fa09a3fffda1fb1aa69f981"
 @deffn primitive make-struct-layout fields
 Return a new structure layout object.
 
address@hidden must be a read-only string made up of pairs of characters
address@hidden must be a string made up of pairs of characters
 strung together.  The first character of each pair describes a field
 type, the second a field protection.  Allowed types are 'p' for
 GC-protected Scheme data, 'u' for unprotected binary data, and 's' for
@@ -1762,11 +1762,11 @@
 structures.
 
 @c docstring begin (c-doc-string "struct.c" "make-struct")
address@hidden docstring md5 "faf2cbc82f2fc9386cc47a8c1da462f5"
address@hidden docstring md5 "9401449ba9dff362d7b489f1a154a0e1"
 @deffn primitive make-struct vtable tail_array_size . init
 Create a new structure.
 
address@hidden must be a vtable structure (@xref{Vtables}).
address@hidden must be a vtable structure (@pxref{Vtables}).
 
 @var{tail-elts} must be a non-negative integer.  If the layout
 specification indicated by @var{type} includes a tail-array,
@@ -6813,9 +6813,9 @@
 the procedure under a new dynamic root will do the job.
 
 @c docstring begin (c-doc-string "root.c" "call-with-dynamic-root")
address@hidden docstring md5 "74fe942888f21340a4aaa5c1012492d0"
address@hidden docstring md5 "684d60639b8939251fef9785bf2883a9"
 @deffn primitive call-with-dynamic-root thunk handler
-Evaluate @var{(thunk)} in a new dynamic context, returning its value.
+Evaluate @code{(thunk)} in a new dynamic context, returning its value.
 
 If an error occurs during evaluation, apply @var{handler} to the
 arguments to the throw, just as @code{throw} would.  If this happens,
@@ -6936,7 +6936,7 @@
 
 @c begin (c-doc-string "threads.c" "call-with-new-thread")
 @deffn primitive call-with-new-thread thunk error-thunk
-Evaluate @var{(thunk)} in a new thread, and new dynamic context,
+Evaluate @code{(thunk)} in a new thread, and new dynamic context,
 returning a new thread object representing the thread.
 
 If an error occurs during evaluation, call error-thunk, passing it an
@@ -7001,7 +7001,7 @@
 
 @c begin (c-doc-string "threads.c" "call-with-new-thread")
 @deffn primitive call-with-new-thread thunk error-thunk
-Evaluate @var{(thunk)} in a new thread, and new dynamic context,
+Evaluate @code{(thunk)} in a new thread, and new dynamic context,
 returning a new thread object representing the thread.
 
 If an error occurs during evaluation, call error-thunk, passing it an
@@ -7339,11 +7339,12 @@
 @end deffn
 
 @c docstring begin (c-doc-string "symbols.c" "gensym")
address@hidden docstring md5 "d1d5a91644bfdb7f7d8bd7425d5665c1"
address@hidden primitive gensym [name [obarray]]
-Create a new, unique symbol in @var{obarray}, using the global symbol
-table by default.  If @var{name} is specified, it should be used as a
-prefix for the new symbol's name.  The default prefix is @code{%%gensym}.
address@hidden docstring md5 "6ac7c070d8b6f845e75d71807596b613"
address@hidden primitive gensym [prefix]
+Create a new symbol with name constructed from a prefix and a counter value.
+The string PREFIX can be specified as an optional argument.
+Default prefix is @code{g}.  The counter is increased by 1 at each call.
+There is no provision for resetting the counter.
 @end deffn
 
 @c docstring begin (c-doc-string "symbols.c" "intern-symbol")
@@ -7465,10 +7466,9 @@
 @end deffn
 
 @c docstring begin (c-doc-string "symbols.c" "symbol-hash")
address@hidden docstring md5 "1e7a307da0194d2035391c43d37adf0f"
address@hidden primitive symbol-hash s
-Return the hash value derived from @var{symbol}'s name, i.e. the integer
-index into @var{symbol}'s obarray at which it is stored.
address@hidden docstring md5 "97407eb455f85ab0b49523c8c0021041"
address@hidden primitive symbol-hash symbol
+Return a hash value for @var{symbol}.
 @end deffn
 
 @c docstring begin (c-doc-string "symbols.c" "symbol-interned?")
Index: guile/guile-doc/ref/scm.texi
diff -u guile/guile-doc/ref/scm.texi:1.7 guile/guile-doc/ref/scm.texi:1.8
--- guile/guile-doc/ref/scm.texi:1.7    Sun Aug  6 17:53:05 2000
+++ guile/guile-doc/ref/scm.texi        Fri Sep 22 06:54:38 2000
@@ -113,9 +113,10 @@
 @node I/O internals
 @chapter I/O internals
 
address@hidden Port Interface}
address@hidden Port Interface}.
 
address@hidden Implementation}
address@hidden Implementation}.
+
 @node libguile error handling
 @chapter libguile error handling