guile/guile-core/doc scm.texi

[Thien-Thi Nguyen]

CVSROOT:        /cvs
Module name:    guile
Branch:         branch_release-1-6
Changes by:     Thien-Thi Nguyen <address@hidden>       01/07/19 00:46:46

Modified files:
        guile-core/doc : scm.texi 

Log message:
        Use American English spelling for "initialize".

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/guile/guile-core/doc/scm.texi.diff?cvsroot=OldCVS&only_with_tag=branch_release-1-6&tr1=1.2.4.1&tr2=1.2.4.2&r1=text&r2=text

Patches:
Index: guile/guile-core/doc/scm.texi
diff -u guile/guile-core/doc/scm.texi:1.1 guile/guile-core/doc/scm.texi:1.2
--- guile/guile-core/doc/scm.texi:1.1   Fri Mar  9 00:22:00 2001
+++ guile/guile-core/doc/scm.texi       Tue Apr 10 12:49:29 2001
@@ -326,88 +326,93 @@
 @node Handling Errors
 @chapter How to Handle Errors in C Code
 
-Error handling is based on catch and throw.  Errors are always thrown with
-a key and four arguments:
+Error handling is based on @code{catch} and @code{throw}.  Errors are
+always thrown with a @var{key} and four arguments:
 
 @itemize @bullet
 @item
-key: a symbol which indicates the type of error.  The symbols used
address@hidden: a symbol which indicates the type of error.  The symbols used
 by libguile are listed below.
 
 @item
-subr: the name of the procedure from which the error is thrown, or #f.
address@hidden: the name of the procedure from which the error is thrown, or
address@hidden
 
 @item
-message: a string (possibly language and system dependent) describing the
-error.  The tokens %s and %S can be embedded within the message: they
-will be replaced with members of the args list when the message is
-printed.  %s indicates an argument printed using "display", while %S
-indicates an argument printed using "write".  message can also be #f,
-to allow it to be derived from the key by the error handler (may be
-useful if the key is to be thrown from both C and Scheme).
address@hidden: a string (possibly language and system dependent)
+describing the error.  The tokens @code{~A} and @code{~S} can be
+embedded within the message: they will be replaced with members of the
address@hidden list when the message is printed.  @code{~A} indicates an
+argument printed using @code{display}, while @code{~S} indicates an
+argument printed using @code{write}.  @var{message} can also be
address@hidden, to allow it to be derived from the @var{key} by the error
+handler (may be useful if the @var{key} is to be thrown from both C and
+Scheme).
 
 @item
-args: a list of arguments to be used to expand %s and %S tokens in message.
-Can also be #f if no arguments are required.
address@hidden: a list of arguments to be used to expand @code{~A} and
address@hidden tokens in @var{message}.  Can also be @code{#f} if no
+arguments are required.
 
 @item
-rest: a list of any additional objects required. e.g., when the key is
-'system-error, this contains the C errno value.  Can also be #f if no
-additional objects are required.
address@hidden: a list of any additional objects required. e.g., when the
+key is @code{'system-error}, this contains the C errno value.  Can also
+be @code{#f} if no additional objects are required.
 @end itemize
 
-In addition to catch and throw, the following Scheme facilities are
-available:
+In addition to @code{catch} and @code{throw}, the following Scheme
+facilities are available:
 
address@hidden @bullet
address@hidden
-(scm-error key subr message args rest): throw an error, with arguments
address@hidden primitive scm-error key subr message args rest
+Throw an error, with arguments
 as described above.
address@hidden deffn
 
address@hidden
-(error msg arg ...)  Throw an error using the key 'misc-error.  The error
-message is created by displaying msg and writing the args.
address@hidden itemize
address@hidden procedure error msg arg @dots{}
+Throw an error using the key @code{'misc-error}.  The error
+message is created by displaying @var{msg} and writing the @var{args}.
address@hidden deffn
 
 The following are the error keys defined by libguile and the situations
 in which they are used:
 
 @itemize @bullet
 @item
-error-signal: thrown after receiving an unhandled fatal signal such as
-SIGSEV, SIGBUS, SIGFPE etc.  The "rest" argument in the throw contains
-the coded signal number (at present this is not the same as the usual
-Unix signal number).
address@hidden: thrown after receiving an unhandled fatal signal
+such as SIGSEV, SIGBUS, SIGFPE etc.  The @var{rest} argument in the throw
+contains the coded signal number (at present this is not the same as the
+usual Unix signal number).
 
 @item
-system-error: thrown after the operating system indicates an error
-condition.  The "rest" argument in the throw contains the errno value.
address@hidden: thrown after the operating system indicates an
+error condition.  The @var{rest} argument in the throw contains the
+errno value.
 
 @item
-numerical-overflow: numerical overflow.
address@hidden: numerical overflow.
 
 @item
-out-of-range: the arguments to a procedure do not fall within the
address@hidden: the arguments to a procedure do not fall within the
 accepted domain.
 
 @item
-wrong-type-arg: an argument to a procedure has the wrong thpe.
address@hidden: an argument to a procedure has the wrong thpe.
 
 @item
-wrong-number-of-args: a procedure was called with the wrong number of
-arguments.
address@hidden: a procedure was called with the wrong number
+of arguments.
 
 @item
-memory-allocation-error: memory allocation error.
address@hidden: memory allocation error.
 
 @item
-stack-overflow: stack overflow error.
address@hidden: stack overflow error.
 
 @item
-regex-error: errors generated by the regular expression library.
address@hidden: errors generated by the regular expression library.
 
 @item
-misc-error: other errors.
address@hidden: other errors.
 @end itemize