1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-04-30 11:50:28 +02:00

more typo fixes

More spelling corrections and fixes for doubled words (e.g. "the the")

--
Brian Gough

Network Theory Ltd,
Publishing Free Software Manuals --- http://www.network-theory.co.uk/

>From 7be02beedc739c32cce2c8ec8f4ac814c994a13f Mon Sep 17 00:00:00 2001
From: Brian Gough <bjg@gnu.org>
Date: Mon, 14 Dec 2009 22:06:22 +0000
Subject: [PATCH] fix various documentation typos (spelling & doubled words)
This commit is contained in:
Brian Gough 2009-12-15 10:16:14 +00:00 committed by Neil Jerram
parent 2e4ef7eda1
commit 72b3aa56af
13 changed files with 30 additions and 30 deletions

View file

@ -470,7 +470,7 @@ Return a list comprising the elements of @var{lst}, in reverse order.
@code{reverse} constructs a new list, @code{reverse!} modifies @code{reverse} constructs a new list, @code{reverse!} modifies
@var{lst} in constructing its return. @var{lst} in constructing its return.
For @code{reverse!}, the optional @var{newtail} is appended to to the For @code{reverse!}, the optional @var{newtail} is appended to the
result. @var{newtail} isn't reversed, it simply becomes the list result. @var{newtail} isn't reversed, it simply becomes the list
tail. For @code{scm_reverse_x}, the @var{newtail} parameter is tail. For @code{scm_reverse_x}, the @var{newtail} parameter is
mandatory, but can be @code{SCM_EOL} if no further tail is required. mandatory, but can be @code{SCM_EOL} if no further tail is required.
@ -1057,7 +1057,7 @@ being a @code{double}
The external representation (ie.@: read syntax) for these vectors is The external representation (ie.@: read syntax) for these vectors is
similar to normal Scheme vectors, but with an additional tag from the similar to normal Scheme vectors, but with an additional tag from the
table above indiciating the vector's type. For example, table above indicating the vector's type. For example,
@lisp @lisp
#u16(1 2 3) #u16(1 2 3)
@ -1475,7 +1475,7 @@ are displayed as a sequence of @code{0}s and @code{1}s prefixed by
#*00000000 #*00000000
@end example @end example
Bit vectors are are also generalized vectors, @xref{Generalized Bit vectors are also generalized vectors, @xref{Generalized
Vectors}, and can thus be used with the array procedures, @xref{Arrays}. Vectors}, and can thus be used with the array procedures, @xref{Arrays}.
Bit vectors are the special case of one dimensional bit arrays. Bit vectors are the special case of one dimensional bit arrays.
@ -1567,7 +1567,7 @@ Return a count of how many entries in @var{bitvector} are equal to
@deffn {Scheme Procedure} bit-position bool bitvector start @deffn {Scheme Procedure} bit-position bool bitvector start
@deffnx {C Function} scm_bit_position (bool, bitvector, start) @deffnx {C Function} scm_bit_position (bool, bitvector, start)
Return the index of the first occurrance of @var{bool} in Return the index of the first occurrence of @var{bool} in
@var{bitvector}, starting from @var{start}. If there is no @var{bool} @var{bitvector}, starting from @var{start}. If there is no @var{bool}
entry between @var{start} and the end of @var{bitvector}, then return entry between @var{start} and the end of @var{bitvector}, then return
@code{#f}. For example, @code{#f}. For example,
@ -1777,7 +1777,7 @@ In more words, the array tag is of the form
where @code{<rank>} is a positive integer in decimal giving the rank of where @code{<rank>} is a positive integer in decimal giving the rank of
the array. It is omitted when the rank is 1 and the array is non-shared the array. It is omitted when the rank is 1 and the array is non-shared
and has zero-origin (see below). For shared arrays and for a non-zero and has zero-origin (see below). For shared arrays and for a non-zero
origin, the rank is always printed even when it is 1 to dinstinguish origin, the rank is always printed even when it is 1 to distinguish
them from ordinary vectors. them from ordinary vectors.
The @code{<vectag>} part is the tag for a uniform numeric vector, like The @code{<vectag>} part is the tag for a uniform numeric vector, like
@ -1902,7 +1902,7 @@ Equivalent to @code{(make-typed-array #t @var{fill} @var{bound} ...)}.
Create and return an array that has as many dimensions as there are Create and return an array that has as many dimensions as there are
@var{bound}s and (maybe) fill it with @var{fill}. @var{bound}s and (maybe) fill it with @var{fill}.
The underlaying storage vector is created according to @var{type}, The underlying storage vector is created according to @var{type},
which must be a symbol whose name is the `vectag' of the array as which must be a symbol whose name is the `vectag' of the array as
explained above, or @code{#t} for ordinary, non-specialized arrays. explained above, or @code{#t} for ordinary, non-specialized arrays.
@ -2025,7 +2025,7 @@ For example,
@deffn {Scheme Procedure} array-shape array @deffn {Scheme Procedure} array-shape array
@deffnx {Scheme Procedure} array-dimensions array @deffnx {Scheme Procedure} array-dimensions array
@deffnx {C Function} scm_array_dimensions (array) @deffnx {C Function} scm_array_dimensions (array)
Return a list of the bounds for each dimenson of @var{array}. Return a list of the bounds for each dimension of @var{array}.
@code{array-shape} gives @code{(@var{lower} @var{upper})} for each @code{array-shape} gives @code{(@var{lower} @var{upper})} for each
dimension. @code{array-dimensions} instead returns just dimension. @code{array-dimensions} instead returns just
@ -2485,7 +2485,7 @@ for (i = 0; i < RANK; i++)
Compute the position corresponding to @var{indices}, a list of Compute the position corresponding to @var{indices}, a list of
indices. The position is computed as described above for indices. The position is computed as described above for
@code{scm_array_handle_dims}. The number of the indices and their @code{scm_array_handle_dims}. The number of the indices and their
range is checked and an approrpiate error is signalled for invalid range is checked and an appropriate error is signalled for invalid
indices. indices.
@end deftypefn @end deftypefn
@ -3379,7 +3379,7 @@ Return the value from the first entry in @var{alist} with the given
@code{eqv?} and @code{assoc-ref} uses @code{equal?}. @code{eqv?} and @code{assoc-ref} uses @code{equal?}.
Notice these functions have the @var{key} argument last, like other Notice these functions have the @var{key} argument last, like other
@code{-ref} functions, but this is opposite to what what @code{assq} @code{-ref} functions, but this is opposite to what @code{assq}
etc above use. etc above use.
When the return is @code{#f} it can be either @var{key} not found, or When the return is @code{#f} it can be either @var{key} not found, or

View file

@ -1284,7 +1284,7 @@ table.
@table @code @table @code
@item SCM_F_DYNWIND_REWINDABLE @item SCM_F_DYNWIND_REWINDABLE
The dynamic context is @dfn{rewindable}. This means that it can be The dynamic context is @dfn{rewindable}. This means that it can be
reentered non-locally (via the invokation of a continuation). The reentered non-locally (via the invocation of a continuation). The
default is that a dynwind context can not be reentered non-locally. default is that a dynwind context can not be reentered non-locally.
@end table @end table

View file

@ -3477,7 +3477,7 @@ with the strings in the list @var{ls}.
@deffn {Scheme Procedure} string-concatenate-reverse/shared ls [final_string [end]] @deffn {Scheme Procedure} string-concatenate-reverse/shared ls [final_string [end]]
@deffnx {C Function} scm_string_concatenate_reverse_shared (ls, final_string, end) @deffnx {C Function} scm_string_concatenate_reverse_shared (ls, final_string, end)
Like @code{string-concatenate-reverse}, but the result may Like @code{string-concatenate-reverse}, but the result may
share memory with the the strings in the @var{ls} arguments. share memory with the strings in the @var{ls} arguments.
@end deffn @end deffn
@node Mapping Folding and Unfolding @node Mapping Folding and Unfolding

View file

@ -459,7 +459,7 @@ be used (@pxref{Gettext Support}).
Example uses of some of these functions are the implementation of the Example uses of some of these functions are the implementation of the
@code{number->locale-string} and @code{monetary-amount->locale-string} @code{number->locale-string} and @code{monetary-amount->locale-string}
procedures (@pxref{Number Input and Output}), as well as that the procedures (@pxref{Number Input and Output}), as well as that the
SRFI-19 date and time convertion to/from strings (@pxref{SRFI-19}). SRFI-19 date and time conversion to/from strings (@pxref{SRFI-19}).
@node Gettext Support, , Accessing Locale Information, Internationalization @node Gettext Support, , Accessing Locale Information, Internationalization

View file

@ -114,7 +114,7 @@ encoding names are those
@end deffn @end deffn
@defvr {Scheme Variable} %default-port-encoding @defvr {Scheme Variable} %default-port-encoding
A fluid containing containing @code{#f} or the name of the encoding to A fluid containing @code{#f} or the name of the encoding to
be used by default for newly created ports (@pxref{Fluids and Dynamic be used by default for newly created ports (@pxref{Fluids and Dynamic
States}). The value @code{#f} is equivalent to @code{"ISO-8859-1"}. States}). The value @code{#f} is equivalent to @code{"ISO-8859-1"}.

View file

@ -138,7 +138,7 @@ Return @code{#t} if @var{x} and @var{y} are the same type, and their
contents or value are equal. contents or value are equal.
For a pair, string, vector, array or structure, @code{equal?} compares the For a pair, string, vector, array or structure, @code{equal?} compares the
contents, and does so using using the same @code{equal?} recursively, contents, and does so using the same @code{equal?} recursively,
so a deep structure can be traversed. so a deep structure can be traversed.
@example @example
@ -819,7 +819,7 @@ accessible from C with the name @code{scm_after_gc_hook}.)
@end defvr @end defvr
All the C hooks listed here have type @code{SCM_C_HOOK_NORMAL}, are All the C hooks listed here have type @code{SCM_C_HOOK_NORMAL}, are
initialized with hook closure data NULL, are are invoked by initialized with hook closure data NULL, are invoked by
@code{scm_c_hook_run} with call closure data NULL. @code{scm_c_hook_run} with call closure data NULL.
@cindex guardians, testing for GC'd objects @cindex guardians, testing for GC'd objects

View file

@ -71,7 +71,7 @@ Lisp.
Due to a naming conflict with another programming language, Jim Blandy Due to a naming conflict with another programming language, Jim Blandy
suggested a new name for GEL: ``Guile''. Besides being a recursive suggested a new name for GEL: ``Guile''. Besides being a recursive
acroymn, ``Guile'' craftily follows the naming of its ancestors, acronym, ``Guile'' craftily follows the naming of its ancestors,
``Planner'', ``Conniver'', and ``Schemer''. (The latter was truncated ``Planner'', ``Conniver'', and ``Schemer''. (The latter was truncated
to ``Scheme'' due to a 6-character file name limit on an old operating to ``Scheme'' due to a 6-character file name limit on an old operating
system.) Finally, ``Guile'' suggests ``guy-ell'', or ``Guy L. system.) Finally, ``Guile'' suggests ``guy-ell'', or ``Guy L.
@ -102,7 +102,7 @@ applications and a more fully dynamic programming environment is still
with us today. with us today.
@node A Scheme of Many Maintainers @node A Scheme of Many Maintainers
@subsection A Scheme of Many Mantainers @subsection A Scheme of Many Maintainers
Surveying the field, it seems that Scheme implementations correspond Surveying the field, it seems that Scheme implementations correspond
with their maintainers on an N-to-1 relationship. That is to say, that with their maintainers on an N-to-1 relationship. That is to say, that
@ -112,7 +112,7 @@ maintainership of one individual.
Guile is atypical in this regard. Guile is atypical in this regard.
Tom Lord maintaned Guile for its first year and a half or so, Tom Lord maintained Guile for its first year and a half or so,
corresponding to the end of 1994 through the middle of 1996. The corresponding to the end of 1994 through the middle of 1996. The
releases made in this time constitute an arc from SCM as a standalone releases made in this time constitute an arc from SCM as a standalone
program to Guile as a reusable, embeddable library, but passing program to Guile as a reusable, embeddable library, but passing

View file

@ -109,7 +109,7 @@ my_incrementing_function (SCM a, SCM flag)
@} @}
@end example @end example
Often, you need to convert between @code{SCM} values and approriate C Often, you need to convert between @code{SCM} values and appropriate C
values. For example, we needed to convert the integer @code{1} to its values. For example, we needed to convert the integer @code{1} to its
@code{SCM} representation in order to add it to @var{a}. Libguile @code{SCM} representation in order to add it to @var{a}. Libguile
provides many function to do these conversions, both from C to provides many function to do these conversions, both from C to
@ -206,7 +206,7 @@ Other references to @code{SCM} objects, such as global variables of type
@code{SCM} or other random data structures in the heap that contain @code{SCM} or other random data structures in the heap that contain
fields of type @code{SCM}, can be made visible to the garbage collector fields of type @code{SCM}, can be made visible to the garbage collector
by calling the functions @code{scm_gc_protect} or by calling the functions @code{scm_gc_protect} or
@code{scm_permanent_object}. You normally use these funtions for long @code{scm_permanent_object}. You normally use these functions for long
lived objects such as a hash table that is stored in a global variable. lived objects such as a hash table that is stored in a global variable.
For temporary references in local variables or function arguments, using For temporary references in local variables or function arguments, using
these functions would be too expensive. these functions would be too expensive.
@ -239,7 +239,7 @@ However, a local variable or function parameter is only protected as
long as it is really on the stack (or in some register). As an long as it is really on the stack (or in some register). As an
optimization, the C compiler might reuse its location for some other optimization, the C compiler might reuse its location for some other
value and the @code{SCM} object would no longer be protected. Normally, value and the @code{SCM} object would no longer be protected. Normally,
this leads to exactly the right behabvior: the compiler will only this leads to exactly the right behavior: the compiler will only
overwrite a reference when it is no longer needed and thus the object overwrite a reference when it is no longer needed and thus the object
becomes unprotected precisely when the reference disappears, just as becomes unprotected precisely when the reference disappears, just as
wanted. wanted.
@ -311,7 +311,7 @@ Scheme offers a few syntactic abstractions (@code{do} and @dfn{named}
But only Scheme functions can call other functions in a tail position: But only Scheme functions can call other functions in a tail position:
C functions can not. This matters when you have, say, two functions C functions can not. This matters when you have, say, two functions
that call each other recursively to form a common loop. The following that call each other recursively to form a common loop. The following
(unrealistic) example shows how one might go about determing whether a (unrealistic) example shows how one might go about determining whether a
non-negative integer @var{n} is even or odd. non-negative integer @var{n} is even or odd.
@lisp @lisp

View file

@ -192,7 +192,7 @@ This procedure ensures that the smob is in a valid state as soon as it
exists, that all resources that are allocated for the smob are exists, that all resources that are allocated for the smob are
properly associated with it so that they can be properly freed, and properly associated with it so that they can be properly freed, and
that no @code{SCM} values that need to be protected are stored in it that no @code{SCM} values that need to be protected are stored in it
while the smob does not yet competely exist and thus can not protect while the smob does not yet completely exist and thus can not protect
them. them.
Continuing the example from above, if the global variable Continuing the example from above, if the global variable

View file

@ -21,7 +21,7 @@ will extract this information from your source code, and automatically
generate a file of calls to @code{scm_c_define_gsubr} which you can generate a file of calls to @code{scm_c_define_gsubr} which you can
@code{#include} into an initialization function. @code{#include} into an initialization function.
The snarfing mechanism works for many kind of initialiation actions, The snarfing mechanism works for many kind of initialization actions,
not just for collecting calls to @code{scm_c_define_gsubr}. For a not just for collecting calls to @code{scm_c_define_gsubr}. For a
full list of what can be done, @xref{Snarfing Macros}. full list of what can be done, @xref{Snarfing Macros}.

View file

@ -629,7 +629,7 @@ argument list, a reverse of what the @nicode{@@} modifier does.
(format #t "~#*~2:*~a" 'a 'b 'c 'd) @print{} c (format #t "~#*~2:*~a" 'a 'b 'c 'd) @print{} c
@end example @end example
At the end of the format string the current argument postion doesn't At the end of the format string the current argument position doesn't
matter, any further arguments are ignored. matter, any further arguments are ignored.
@item @nicode{~t} @item @nicode{~t}
@ -1273,7 +1273,7 @@ is empty, a @code{q-empty} exception is thrown.
@end deffn @end deffn
@deffn {Scheme Procedure} q-remove! q obj @deffn {Scheme Procedure} q-remove! q obj
Remove all occurences of @var{obj} from @var{q}, and return @var{q}. Remove all occurrences of @var{obj} from @var{q}, and return @var{q}.
@var{obj} is compared to queue elements using @code{eq?}. @var{obj} is compared to queue elements using @code{eq?}.
@end deffn @end deffn

View file

@ -144,7 +144,7 @@ start with @code{@@}), which is equivalent to @code{(@@ (symbol ...)
main)}, or @code{(symbol ...) symbol} (that is, a list of only symbols main)}, or @code{(symbol ...) symbol} (that is, a list of only symbols
followed by a symbol), which is equivalent to @code{(@@ (symbol ...) followed by a symbol), which is equivalent to @code{(@@ (symbol ...)
symbol)}. We recommend to use the equivalent forms directly since they symbol)}. We recommend to use the equivalent forms directly since they
corresponf to the @code{(@@ ...)} read syntax that can be used in correspond to the @code{(@@ ...)} read syntax that can be used in
normal code, @xref{Using Guile Modules}. normal code, @xref{Using Guile Modules}.
@xref{Scripting Examples}. @xref{Scripting Examples}.

View file

@ -2815,7 +2815,7 @@ specified by @var{c}.
If @var{c} is a compound condition, extract the field values from the If @var{c} is a compound condition, extract the field values from the
subcondition belonging to @var{type} that appeared first in the call to subcondition belonging to @var{type} that appeared first in the call to
@code{make-compound-condition} that created the the condition. @code{make-compound-condition} that created the condition.
@end deffn @end deffn
Convenience macros are also available to create condition types and Convenience macros are also available to create condition types and
@ -3030,7 +3030,7 @@ the new locations.
(my-param) @result{} 456 (my-param) @result{} 456
@end example @end example
Parameters are like dynamically bound variables in other Lisp dialets. Parameters are like dynamically bound variables in other Lisp dialects.
They allow an application to establish parameter settings (as the name They allow an application to establish parameter settings (as the name
suggests) just for the execution of a particular bit of code, suggests) just for the execution of a particular bit of code,
restoring when done. Examples of such parameters might be restoring when done. Examples of such parameters might be
@ -3038,7 +3038,7 @@ case-sensitivity for a search, or a prompt for user input.
Global variables are not as good as parameter objects for this sort of Global variables are not as good as parameter objects for this sort of
thing. Changes to them are visible to all threads, but in Guile thing. Changes to them are visible to all threads, but in Guile
parameter object locations are per-thread, thereby truely limiting the parameter object locations are per-thread, thereby truly limiting the
effect of @code{parameterize} to just its dynamic execution. effect of @code{parameterize} to just its dynamic execution.
Passing arguments to functions is thread-safe, but that soon becomes Passing arguments to functions is thread-safe, but that soon becomes