mirror of
https://git.savannah.gnu.org/git/guile.git
synced 2025-06-16 08:40:19 +02:00
* Miscellaneous doc and docstring fixes.
This commit is contained in:
Neil Jerram
parent
8334250f0f
commit
39d2ee3ba5
33 changed files with 2429 additions and 2803 deletions
|
|
@ -1,3 +1,7 @@
|
|||
2001-11-13 Neil Jerram <neil@ossau.uklinux.net>
|
||||
|
||||
* guile.texi: Replaced by autogenerated libguile version.
|
||||
|
||||
2001-11-12 Neil Jerram <neil@ossau.uklinux.net>
|
||||
|
||||
* docstring.el, README: Sync up with unstable version of these
|
||||
|
|
|
|||
4795
doc/maint/guile.texi
4795
doc/maint/guile.texi
File diff suppressed because it is too large
Load diff
|
|
@ -1,5 +1,14 @@
|
|||
2001-11-13 Neil Jerram <neil@ossau.uklinux.net>
|
||||
|
||||
* scheme-data.texi, scheme-evaluation.texi, scheme-io.texi: Merge
|
||||
appropriate recent doc enhancements from unstable branch.
|
||||
|
||||
* new-docstrings.texi, posix.texi, scheme-binding.texi,
|
||||
scheme-control.texi, scheme-data.texi, scheme-debug.texi,
|
||||
scheme-evaluation.texi, scheme-io.texi, scheme-memory.texi,
|
||||
scheme-options.texi: Automatic updates corresponding to changed
|
||||
docstrings in libguile's C source code.
|
||||
|
||||
* scheme-data.texi (String Predicates): Correct doc for
|
||||
string-null?. Thanks to Scott Lenser!
|
||||
|
||||
|
|
|
|||
|
|
@ -304,9 +304,11 @@ If @var{l} does not hold a value for @var{key}, the value
|
|||
@end deffn
|
||||
|
||||
@deffn primitive slot-ref-using-class class obj slot_name
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive slot-set-using-class! class obj slot_name value
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive class-of x
|
||||
|
|
@ -319,33 +321,43 @@ on the C level which depends on the loaded GOOPS modules.
|
|||
@end deffn
|
||||
|
||||
@deffn primitive %method-more-specific? m1 m2 targs
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive find-method . l
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive primitive-generic-generic subr
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive enable-primitive-generic! . subrs
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive generic-capability? proc
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive %invalidate-method-cache! gf
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive %invalidate-class class
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive %modify-class old new
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive %modify-instance old new
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive %set-object-setter! obj setter
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive %allocate-instance class initargs
|
||||
|
|
@ -367,9 +379,11 @@ Set the slot named @var{slot_name} of @var{obj} to @var{value}.
|
|||
@end deffn
|
||||
|
||||
@deffn primitive slot-exists-using-class? class obj slot_name
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive slot-bound-using-class? class obj slot_name
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive %fast-slot-set! obj index value
|
||||
|
|
@ -460,9 +474,11 @@ Return @code{#t} if @var{obj} is an instance.
|
|||
@end deffn
|
||||
|
||||
@deffn primitive %inherit-magic! class dsupers
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive %prep-layout! class
|
||||
|
||||
@end deffn
|
||||
|
||||
@deffn primitive %initialize-object obj initargs
|
||||
|
|
@ -490,7 +506,7 @@ Internal GOOPS magic---don't use this function!
|
|||
@end deffn
|
||||
|
||||
@deffn primitive list*
|
||||
scm_cons_star
|
||||
implemented by the C function "scm_cons_star"
|
||||
@end deffn
|
||||
|
||||
@deffn primitive set-current-module module
|
||||
|
|
@ -530,3 +546,60 @@ this specific @var{msg}. Do nothing otherwise.
|
|||
The argument @var{msgs} should be a list of strings;
|
||||
they are printed in turn, each one followed by a newline.
|
||||
@end deffn
|
||||
|
||||
@deffn primitive variable-set-name-hint! var hint
|
||||
Do not use this function.
|
||||
@end deffn
|
||||
|
||||
@deffn primitive valid-object-procedure? proc
|
||||
Return @code{#t} iff @var{proc} is a procedure that can be used with @code{set-object-procedure}. It is always valid to use a closure constructed by @code{lambda}.
|
||||
@end deffn
|
||||
|
||||
@deffn primitive %get-pre-modules-obarray
|
||||
Return the obarray that is used for all new bindings before the module system is booted. The first call to @code{set-current-module} will boot the module system.
|
||||
@end deffn
|
||||
|
||||
@deffn primitive standard-interface-eval-closure module
|
||||
Return a interface eval closure for the module @var{module}. Such a closure does not allow new bindings to be added.
|
||||
@end deffn
|
||||
|
||||
@deffn primitive env-module env
|
||||
Return the module of @var{ENV}, a lexical environment.
|
||||
@end deffn
|
||||
|
||||
@deffn primitive load-extension lib init
|
||||
Load and initialize the extension designated by LIB and INIT.
|
||||
When there is no pre-registered function for LIB/INIT, this is
|
||||
equivalent to
|
||||
|
||||
@lisp
|
||||
(dynamic-call INIT (dynamic-link LIB))
|
||||
@end lisp
|
||||
|
||||
When there is a pre-registered function, that function is called
|
||||
instead.
|
||||
|
||||
Normally, there is no pre-registered function. This option exists
|
||||
only for situations where dynamic linking is unavailable or unwanted.
|
||||
In that case, you would statically link your program with the desired
|
||||
library, and register its init function right after Guile has been
|
||||
initialized.
|
||||
|
||||
LIB should be a string denoting a shared library without any file type
|
||||
suffix such as ".so". The suffix is provided automatically. It
|
||||
should also not contain any directory components. Libraries that
|
||||
implement Guile Extensions should be put into the normal locations for
|
||||
shared libraries. We recommend to use the naming convention
|
||||
libguile-bla-blum for a extension related to a module `(bla blum)'.
|
||||
|
||||
The normal way for a extension to be used is to write a small Scheme
|
||||
file that defines a module, and to load the extension into this
|
||||
module. When the module is auto-loaded, the extension is loaded as
|
||||
well. For example,
|
||||
|
||||
@lisp
|
||||
(define-module (bla blum))
|
||||
|
||||
(load-extension "libguile-bla-blum" "bla_init_blum")
|
||||
@end lisp
|
||||
@end deffn
|
||||
|
|
|
|||
|
|
@ -1457,26 +1457,35 @@ all platforms.
|
|||
@end deffn
|
||||
|
||||
@deffn primitive setitimer which_timer interval_seconds interval_microseconds value_seconds value_microseconds
|
||||
|
||||
Set the timer specified by @var{which_timer} according to the given
|
||||
@var{interval_seconds}, @var{interval_microseconds},
|
||||
@var{value_seconds}, and @var{value_microseconds} values, and return
|
||||
information about the timer's previous setting. The timers available
|
||||
are: @code{ITIMER_REAL}, @code{ITIMER_VIRTUAL}, and @code{ITIMER_PROF},
|
||||
and the return value will be a list of two cons pairs representing the
|
||||
@var{value_seconds}, and @var{value_microseconds} values.
|
||||
|
||||
Return information about the timer's previous setting.
|
||||
Errors are handled as described in the guile info pages under ``POSIX
|
||||
Interface Conventions''.
|
||||
|
||||
The timers available are: @code{ITIMER_REAL}, @code{ITIMER_VIRTUAL},
|
||||
and @code{ITIMER_PROF}.
|
||||
|
||||
The return value will be a list of two cons pairs representing the
|
||||
current state of the given timer. The first pair is the seconds and
|
||||
microseconds of the timer @code{it_interval}, and the second pair is the
|
||||
seconds and microseconds of the timer @code{it_value}.
|
||||
microseconds of the timer @code{it_interval}, and the second pair is
|
||||
the seconds and microseconds of the timer @code{it_value}.
|
||||
@end deffn
|
||||
|
||||
@deffn primitive getitimer which_timer
|
||||
Return information about the timer specified by @var{which_timer}. The
|
||||
timers available are: @code{ITIMER_REAL}, @code{ITIMER_VIRTUAL}, and
|
||||
@code{ITIMER_PROF}, and the return value will be a list of two cons
|
||||
pairs representing the current state of the given timer. The first pair
|
||||
is the seconds and microseconds of the timer @code{it_interval}, and the
|
||||
second pair is the seconds and microseconds of the timer
|
||||
@code{it_value}.
|
||||
Return information about the timer specified by @var{which_timer}
|
||||
Errors are handled as described in the guile info pages under ``POSIX
|
||||
Interface Conventions''.
|
||||
|
||||
The timers available are: @code{ITIMER_REAL}, @code{ITIMER_VIRTUAL},
|
||||
and @code{ITIMER_PROF}.
|
||||
|
||||
The return value will be a list of two cons pairs representing the
|
||||
current state of the given timer. The first pair is the seconds and
|
||||
microseconds of the timer @code{it_interval}, and the second pair is
|
||||
the seconds and microseconds of the timer @code{it_value}.
|
||||
@end deffn
|
||||
|
||||
|
||||
|
|
@ -2310,7 +2319,7 @@ documentation before using them.
|
|||
|
||||
@deffn primitive crypt key salt
|
||||
Encrypt @var{key} using @var{salt} as the salt value to the
|
||||
crypt(3) library call
|
||||
crypt(3) library call.
|
||||
@end deffn
|
||||
|
||||
@code{getpass} is no encryption procedure at all, but it is often used
|
||||
|
|
|
|||
|
|
@ -233,7 +233,7 @@ bound in expression, you can use the @code{bound?} macro from the module
|
|||
|
||||
@c NJFIXME explain [env]
|
||||
@deffn primitive defined? sym [env]
|
||||
Return @code{#t} if @var{sym} is defined in the top-level environment.
|
||||
Return @code{#t} if @var{sym} is defined in the lexical environment @var{env}. When @var{env} is not specified, look in the top-level environment as defined by the current module.
|
||||
@end deffn
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -956,32 +956,33 @@ Return the hyperbolic arctangent of @var{x}.
|
|||
@subsection Bitwise Operations
|
||||
|
||||
@deffn primitive logand n1 n2
|
||||
Return the integer which is the bit-wise AND of the two integer
|
||||
arguments.
|
||||
Return the bitwise AND of the integer arguments.
|
||||
|
||||
@lisp
|
||||
(number->string (logand #b1100 #b1010) 2)
|
||||
@result{} "1000"
|
||||
(logand) @result{} -1
|
||||
(logand 7) @result{} 7
|
||||
(logand #b111 #b011 #b001) @result{} 1
|
||||
@end lisp
|
||||
@end deffn
|
||||
|
||||
@deffn primitive logior n1 n2
|
||||
Return the integer which is the bit-wise OR of the two integer
|
||||
arguments.
|
||||
Return the bitwise OR of the integer arguments.
|
||||
|
||||
@lisp
|
||||
(number->string (logior #b1100 #b1010) 2)
|
||||
@result{} "1110"
|
||||
(logior) @result{} 0
|
||||
(logior 7) @result{} 7
|
||||
(logior #b000 #b001 #b011) @result{} 3
|
||||
@end lisp
|
||||
@end deffn
|
||||
|
||||
@deffn primitive logxor n1 n2
|
||||
Return the integer which is the bit-wise XOR of the two integer
|
||||
arguments.
|
||||
|
||||
Return the bitwise XOR of the integer arguments. A bit is
|
||||
set in the result if it is set in an odd number of arguments.
|
||||
@lisp
|
||||
(number->string (logxor #b1100 #b1010) 2)
|
||||
@result{} "110"
|
||||
(logxor) @result{} 0
|
||||
(logxor 7) @result{} 7
|
||||
(logxor #b000 #b001 #b011) @result{} 2
|
||||
(logxor #b000 #b001 #b011 #b011) @result{} 1
|
||||
@end lisp
|
||||
@end deffn
|
||||
|
||||
|
|
@ -1554,7 +1555,7 @@ y
|
|||
@deffnx primitive substring-move-left! str1 start1 end1 str2 start2
|
||||
@deffnx primitive substring-move-right! str1 start1 end1 str2 start2
|
||||
Copy the substring of @var{str1} bounded by @var{start1} and @var{end1}
|
||||
into @var{str2} beginning at position @var{end2}.
|
||||
into @var{str2} beginning at position @var{start2}.
|
||||
@code{substring-move-right!} begins copying from the rightmost character
|
||||
and moves left, and @code{substring-move-left!} copies from the leftmost
|
||||
character moving right.
|
||||
|
|
@ -1916,6 +1917,20 @@ Match the compiled regular expression @var{rx} against
|
|||
provided, begin matching from that position in the string.
|
||||
Return a match structure describing the results of the match,
|
||||
or @code{#f} if no match could be found.
|
||||
|
||||
The @var{flags} arguments change the matching behavior.
|
||||
The following flags may be supplied:
|
||||
|
||||
@table @code
|
||||
@item regexp/notbol
|
||||
Operator @samp{^} always fails (unless @code{regexp/newline}
|
||||
is used). Use this when the beginning of the string should
|
||||
not be considered the beginning of a line.
|
||||
@item regexp/noteol
|
||||
Operator @samp{$} always fails (unless @code{regexp/newline}
|
||||
is used). Use this when the end of the string should not be
|
||||
considered the end of a line.
|
||||
@end table
|
||||
@end deffn
|
||||
|
||||
@deffn primitive regexp? obj
|
||||
|
|
@ -2390,7 +2405,7 @@ part of an object returned as the value of a literal expression
|
|||
Report on Scheme}) or by a call to the @code{read} procedure,
|
||||
and its name contains alphabetic characters, then the string
|
||||
returned will contain characters in the implementation's
|
||||
preferred standard case--some implementations will prefer
|
||||
preferred standard case---some implementations will prefer
|
||||
upper case, others lower case. If the symbol was returned by
|
||||
@code{string->symbol}, the case of characters in the string
|
||||
returned will be the same as the case in the string that was
|
||||
|
|
@ -2525,20 +2540,12 @@ Return the built-in variable with the name @var{name}.
|
|||
Then use @code{variable-ref} to access its value.
|
||||
@end deffn
|
||||
|
||||
@deffn primitive make-undefined-variable [name-hint]
|
||||
Return a variable object initialized to an undefined value.
|
||||
If given, uses @var{name-hint} as its internal (debugging)
|
||||
name, otherwise just treat it as an anonymous variable.
|
||||
Remember, of course, that multiple bindings to the same
|
||||
variable may exist, so @var{name-hint} is just that---a hint.
|
||||
@deffn primitive make-undefined-variable
|
||||
Return a variable that is initially unbound.
|
||||
@end deffn
|
||||
|
||||
@deffn primitive make-variable init [name-hint]
|
||||
Return a variable object initialized to value @var{init}.
|
||||
If given, uses @var{name-hint} as its internal (debugging)
|
||||
name, otherwise just treat it as an anonymous variable.
|
||||
Remember, of course, that multiple bindings to the same
|
||||
variable may exist, so @var{name-hint} is just that---a hint.
|
||||
@deffn primitive make-variable init
|
||||
Return a variable initialized to value @var{init}.
|
||||
@end deffn
|
||||
|
||||
@deffn primitive variable-bound? var
|
||||
|
|
@ -2560,7 +2567,7 @@ value. Return an unspecified value.
|
|||
|
||||
@deffn primitive variable? obj
|
||||
Return @code{#t} iff @var{obj} is a variable object, else
|
||||
return @code{#f}
|
||||
return @code{#f}.
|
||||
@end deffn
|
||||
|
||||
|
||||
|
|
@ -3711,7 +3718,7 @@ For more information, see the documentation for @code{make-vtable-vtable}.
|
|||
@end deffn
|
||||
|
||||
@deffn primitive struct? x
|
||||
Return @code{#t} iff @var{obj} is a structure object, else
|
||||
Return @code{#t} iff @var{x} is a structure object, else
|
||||
@code{#f}.
|
||||
@end deffn
|
||||
|
||||
|
|
@ -3744,7 +3751,7 @@ Return the vtable structure that describes the type of @var{struct}.
|
|||
@end deffn
|
||||
|
||||
@deffn primitive struct-vtable? x
|
||||
Return @code{#t} iff obj is a vtable structure.
|
||||
Return @code{#t} iff @var{x} is a vtable structure.
|
||||
@end deffn
|
||||
|
||||
If you have a vtable structure, @code{V}, you can create an instance of
|
||||
|
|
@ -4217,7 +4224,7 @@ returned by @code{(current-input-port)}.
|
|||
|
||||
@deffn primitive uniform-array-write v [port_or_fd [start [end]]]
|
||||
@deffnx primitive uniform-vector-write uve [port-or-fdes] [start] [end]
|
||||
Write all elements of @var{ura} as binary objects to
|
||||
Writes all elements of @var{ura} as binary objects to
|
||||
@var{port-or-fdes}.
|
||||
|
||||
The optional arguments @var{start}
|
||||
|
|
|
|||
|
|
@ -151,8 +151,8 @@ Return the identifier given to @var{stack} by @code{start-stack}.
|
|||
Return the length of @var{stack}.
|
||||
@end deffn
|
||||
|
||||
@deffn primitive stack-ref stack i
|
||||
Return the @var{i}'th frame from @var{stack}.
|
||||
@deffn primitive stack-ref stack index
|
||||
Return the @var{index}'th frame from @var{stack}.
|
||||
@end deffn
|
||||
|
||||
@deffn primitive stack? obj
|
||||
|
|
|
|||
|
|
@ -352,7 +352,7 @@ is implicit).
|
|||
|
||||
The behaviour of Guile's evaluator can be modified by manipulating the
|
||||
evaluator options. For more information about options, @xref{General
|
||||
option interface}. If you want to know which reader options are
|
||||
option interface}. If you want to know which evaluator options are
|
||||
available, @xref{Evaluator options}.
|
||||
|
||||
@c FIXME::martin: This is taken from libguile/options.c. Is there
|
||||
|
|
|
|||
|
|
@ -119,8 +119,20 @@ unread characters will be read again in last-in first-out order. If
|
|||
@end deffn
|
||||
|
||||
@deffn primitive drain-input port
|
||||
Drain @var{port}'s read buffers (including any pushed-back
|
||||
characters) and return the content as a single string.
|
||||
This procedure clears a port's input buffers, similar
|
||||
to the way that force-output clears the output buffer. The
|
||||
contents of the buffers are returned as a single string, e.g.,
|
||||
|
||||
@lisp
|
||||
(define p (open-input-file ...))
|
||||
(drain-input p) => empty string, nothing buffered yet.
|
||||
(unread-char (read-char p) p)
|
||||
(drain-input p) => initial chars from p, up to the buffer size.
|
||||
@end lisp
|
||||
|
||||
Draining the buffers may be useful for cleanly finishing
|
||||
buffered I/O so that the file descriptor can be used directly
|
||||
for further input.
|
||||
@end deffn
|
||||
|
||||
@deffn primitive port-column port
|
||||
|
|
@ -162,7 +174,7 @@ escaped), and characters are rendered as if with @code{write-char}.
|
|||
|
||||
@rnindex newline
|
||||
@deffn primitive newline [port]
|
||||
Send a newline to @var{port}.
|
||||
Send a newline to @var{port} (default @var{current-output-port} if omitted).
|
||||
@end deffn
|
||||
|
||||
@deffn primitive port-with-print-state port pstate
|
||||
|
|
@ -419,7 +431,7 @@ The Block-string-I/O module can be accessed with:
|
|||
It currently contains procedures that help to implement the
|
||||
@code{(scsh rw)} module in guile-scsh.
|
||||
|
||||
@deffn primitive read-string!/partial str [port_or_fdes start end]
|
||||
@deffn primitive read-string!/partial str [port_or_fdes [start [end]]]
|
||||
Read characters from a port or file descriptor into a
|
||||
string @var{str}. A port must have an underlying file
|
||||
descriptor --- a so-called fport. This procedure is
|
||||
|
|
|
|||
|
|
@ -202,7 +202,7 @@ Return @code{#t} if @var{obj} is an operator.
|
|||
@end deffn
|
||||
|
||||
@deffn primitive set-object-procedure! obj proc
|
||||
Return the object procedure of @var{obj} to @var{proc}.
|
||||
Set the object procedure of @var{obj} to @var{proc}.
|
||||
@var{obj} must be either an entity or an operator.
|
||||
@end deffn
|
||||
|
||||
|
|
|
|||
|
|
@ -279,14 +279,14 @@ Guile's configuration at run time.
|
|||
@deffnx primitive major-version
|
||||
@deffnx primitive minor-version
|
||||
@deffnx primitive micro-version
|
||||
Return a string describing Guile's version number, or its major or minor
|
||||
version numbers, respectively.
|
||||
Return a string describing Guile's version number, or its major, minor
|
||||
or micro version number, respectively.
|
||||
|
||||
@lisp
|
||||
(version) @result{} "1.6.5"
|
||||
(version) @result{} "1.6.0"
|
||||
(major-version) @result{} "1"
|
||||
(minor-version) @result{} "6"
|
||||
(micro-version) @result{} "5"
|
||||
(micro-version) @result{} "0"
|
||||
@end lisp
|
||||
@end deffn
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,37 @@
|
|||
2001-11-13 Neil Jerram <neil@ossau.uklinux.net>
|
||||
|
||||
* extensions.c (scm_load_extension): Canonicalize docstring
|
||||
whitespace and correct spelling typo.
|
||||
|
||||
* random.c (scm_random_solid_sphere_x,
|
||||
scm_random_hollow_sphere_x): Correct "shere" typos.
|
||||
|
||||
* hashtab.c (scm_hash_fold): Add missing apostrophe to docstring.
|
||||
|
||||
* version.c (scm_version): Update docstring to include
|
||||
`micro-version'.
|
||||
|
||||
* eval.c (scm_eval2), modules.c (s_scm_set_current_module): Add
|
||||
missing newline to docstring.
|
||||
|
||||
* unif.c (scm_uniform_array_write), ports.c
|
||||
(scm_current_output_port, scm_force_output), dynwind.c
|
||||
(scm_dynamic_wind), scmsigs.c (scm_setitimer, scm_getitimer),
|
||||
filesys.c (scm_open, scm_lstat), struct.c
|
||||
(scm_make_struct_layout), random.c (scm_random,
|
||||
scm_random_solid_sphere_x, scm_random_hollow_sphere_x), strop.c
|
||||
(scm_i_index): Remove superfluous whitespace from end of docstring
|
||||
lines.
|
||||
|
||||
* guardians.c (scm_guardian_greedy_p), strings.c
|
||||
(scm_make_string), ports.c (scm_port_for_each), variable.c
|
||||
(scm_make_variable, scm_make_undefined_variable, scm_variable_p,
|
||||
scm_variable_set_x, scm_variable_bound_p, scm_builtin_variable),
|
||||
scmsigs.c (scm_setitimer, scm_getitimer), struct.c
|
||||
(scm_make_vtable_vtable), posix.c (scm_crypt), hashtab.c
|
||||
(scm_hash_fold), filesys.c (scm_select): Remove superfluous
|
||||
newline at end of docstring.
|
||||
|
||||
2001-11-13 Marius Vollmer <mvo@zagadka.ping.de>
|
||||
|
||||
* strop.h, strop.c (scm_substring_move_left_x,
|
||||
|
|
|
|||
|
|
@ -4141,7 +4141,7 @@ scm_eval_3 (SCM obj, int copyp, SCM env)
|
|||
SCM_DEFINE (scm_eval2, "eval2", 2, 0, 0,
|
||||
(SCM obj, SCM env_thunk),
|
||||
"Evaluate @var{exp}, a Scheme expression, in the environment\n"
|
||||
"designated by @var{lookup}, a symbol-lookup function."
|
||||
"designated by @var{lookup}, a symbol-lookup function.\n"
|
||||
"Do not use this version of eval, it does not play well\n"
|
||||
"with the module system. Use @code{eval} or\n"
|
||||
"@code{primitive-eval} instead.")
|
||||
|
|
|
|||
|
|
@ -117,36 +117,40 @@ scm_c_load_extension (const char *lib, const char *init)
|
|||
|
||||
SCM_DEFINE (scm_load_extension, "load-extension", 2, 0, 0,
|
||||
(SCM lib, SCM init),
|
||||
"Load and initilize the extension designated by LIB and INIT."
|
||||
"When there is no pre-registered function for LIB/INIT, this is "
|
||||
"equivalent to "
|
||||
" "
|
||||
" (dynamic-call INIT (dynamic-link LIB)) "
|
||||
" "
|
||||
"When there is a pre-registered function, that function is called "
|
||||
"instead. "
|
||||
" "
|
||||
"Normally, there is no pre-registered function. This option exists "
|
||||
"only for situations where dynamic linking is unavailable or unwanted. "
|
||||
"In that case, you would statically link your program with the desired "
|
||||
"library, and register its init function right after Guile has been "
|
||||
"initialized. "
|
||||
" "
|
||||
"LIB should be a string denoting a shared library without any file type "
|
||||
"suffix such as \".so\". The suffix is provided automatically. It "
|
||||
"should also not contain any directory components. Libraries that "
|
||||
"implement Guile Extensions should be put into the normal locations for "
|
||||
"shared libraries. We recommend to use the naming convention "
|
||||
"libguile-bla-blum for a extension related to a module `(bla blum)'. "
|
||||
" "
|
||||
"The normal way for a extension to be used is to write a small Scheme "
|
||||
"file that defines a module, and to load the extension into this "
|
||||
"module. When the module is auto-loaded, the extension is loaded as "
|
||||
"well. For example, "
|
||||
" "
|
||||
" (define-module (bla blum)) "
|
||||
" "
|
||||
" (load-extension \"libguile-bla-blum\" \"bla_init_blum\")")
|
||||
"Load and initialize the extension designated by LIB and INIT.\n"
|
||||
"When there is no pre-registered function for LIB/INIT, this is\n"
|
||||
"equivalent to\n"
|
||||
"\n"
|
||||
"@lisp\n"
|
||||
"(dynamic-call INIT (dynamic-link LIB))\n"
|
||||
"@end lisp\n"
|
||||
"\n"
|
||||
"When there is a pre-registered function, that function is called\n"
|
||||
"instead.\n"
|
||||
"\n"
|
||||
"Normally, there is no pre-registered function. This option exists\n"
|
||||
"only for situations where dynamic linking is unavailable or unwanted.\n"
|
||||
"In that case, you would statically link your program with the desired\n"
|
||||
"library, and register its init function right after Guile has been\n"
|
||||
"initialized.\n"
|
||||
"\n"
|
||||
"LIB should be a string denoting a shared library without any file type\n"
|
||||
"suffix such as \".so\". The suffix is provided automatically. It\n"
|
||||
"should also not contain any directory components. Libraries that\n"
|
||||
"implement Guile Extensions should be put into the normal locations for\n"
|
||||
"shared libraries. We recommend to use the naming convention\n"
|
||||
"libguile-bla-blum for a extension related to a module `(bla blum)'.\n"
|
||||
"\n"
|
||||
"The normal way for a extension to be used is to write a small Scheme\n"
|
||||
"file that defines a module, and to load the extension into this\n"
|
||||
"module. When the module is auto-loaded, the extension is loaded as\n"
|
||||
"well. For example,\n"
|
||||
"\n"
|
||||
"@lisp\n"
|
||||
"(define-module (bla blum))\n"
|
||||
"\n"
|
||||
"(load-extension \"libguile-bla-blum\" \"bla_init_blum\")\n"
|
||||
"@end lisp")
|
||||
#define FUNC_NAME s_scm_load_extension
|
||||
{
|
||||
SCM_VALIDATE_STRING (1, lib);
|
||||
|
|
|
|||
|
|
@ -1048,8 +1048,7 @@ SCM_DEFINE (scm_select, "select", 3, 2, 0,
|
|||
"The @var{usecs} argument is not supported.\n"
|
||||
"Multiple values are returned instead of a list.\n"
|
||||
"Duplicates in the input vectors appear only once in output.\n"
|
||||
"An additional @code{select!} interface is provided.\n"
|
||||
)
|
||||
"An additional @code{select!} interface is provided.")
|
||||
#define FUNC_NAME s_scm_select
|
||||
{
|
||||
struct timeval timeout;
|
||||
|
|
|
|||
|
|
@ -377,7 +377,7 @@ SCM_DEFINE (scm_guardian_destroyed_p, "guardian-destroyed?", 1, 0, 0,
|
|||
|
||||
SCM_DEFINE (scm_guardian_greedy_p, "guardian-greedy?", 1, 0, 0,
|
||||
(SCM guardian),
|
||||
"Return @code{#t} if @var{guardian} is a greedy guardian, otherwise @code{#f}.\n")
|
||||
"Return @code{#t} if @var{guardian} is a greedy guardian, otherwise @code{#f}.")
|
||||
#define FUNC_NAME s_scm_guardian_greedy_p
|
||||
{
|
||||
return SCM_BOOL (GREEDY_P (GUARDIAN (guardian)));
|
||||
|
|
|
|||
|
|
@ -523,8 +523,8 @@ SCM_DEFINE (scm_hash_fold, "hash-fold", 3, 0, 0,
|
|||
"and value are successive pairs from the hash table TABLE, and\n"
|
||||
"prior-result is either INIT (for the first application of PROC)\n"
|
||||
"or the return value of the previous application of PROC.\n"
|
||||
"For example, @code{(hash-fold acons () tab)} will convert a hash\n"
|
||||
"table into an a-list of key-value pairs.\n")
|
||||
"For example, @code{(hash-fold acons '() tab)} will convert a hash\n"
|
||||
"table into an a-list of key-value pairs.")
|
||||
#define FUNC_NAME s_scm_hash_fold
|
||||
{
|
||||
SCM_VALIDATE_PROC (1,proc);
|
||||
|
|
|
|||
|
|
@ -77,7 +77,7 @@ static void scm_post_boot_init_modules (void);
|
|||
|
||||
SCM_DEFINE (scm_set_current_module, "set-current-module", 1, 0, 0,
|
||||
(SCM module),
|
||||
"Set the current module to @var{module} and return"
|
||||
"Set the current module to @var{module} and return\n"
|
||||
"the previous current module.")
|
||||
#define FUNC_NAME s_scm_set_current_module
|
||||
{
|
||||
|
|
|
|||
|
|
@ -720,7 +720,7 @@ SCM_DEFINE (scm_port_for_each, "port-for-each", 1, 0, 0,
|
|||
"@var{proc} is applied exactly once to every port that exists\n"
|
||||
"in the system at the time @var{port-for-each} is invoked.\n"
|
||||
"Changes to the port table while @var{port-for-each} is running\n"
|
||||
"have no effect as far as @var{port-for-each} is concerned.\n")
|
||||
"have no effect as far as @var{port-for-each} is concerned.")
|
||||
#define FUNC_NAME s_scm_port_for_each
|
||||
{
|
||||
long i;
|
||||
|
|
|
|||
|
|
@ -1347,7 +1347,7 @@ SCM_DEFINE (scm_sync, "sync", 0, 0, 0,
|
|||
SCM_DEFINE (scm_crypt, "crypt", 2, 0, 0,
|
||||
(SCM key, SCM salt),
|
||||
"Encrypt @var{key} using @var{salt} as the salt value to the\n"
|
||||
"crypt(3) library call\n")
|
||||
"crypt(3) library call.")
|
||||
#define FUNC_NAME s_scm_crypt
|
||||
{
|
||||
char * p;
|
||||
|
|
|
|||
|
|
@ -492,7 +492,7 @@ SCM_DEFINE (scm_random_solid_sphere_x, "random:solid-sphere!", 1, 1, 0,
|
|||
"the sum of whose squares is less than 1.0.\n"
|
||||
"Thinking of vect as coordinates in space of\n"
|
||||
"dimension n = (vector-length vect), the coordinates\n"
|
||||
"are uniformly distributed within the unit n-shere.\n"
|
||||
"are uniformly distributed within the unit n-sphere.\n"
|
||||
"The sum of the squares of the numbers is returned.")
|
||||
#define FUNC_NAME s_scm_random_solid_sphere_x
|
||||
{
|
||||
|
|
@ -516,7 +516,7 @@ SCM_DEFINE (scm_random_hollow_sphere_x, "random:hollow-sphere!", 1, 1, 0,
|
|||
"Thinking of vect as coordinates in space of\n"
|
||||
"dimension n = (vector-length vect), the coordinates\n"
|
||||
"are uniformly distributed over the surface of the\n"
|
||||
"unit n-shere.")
|
||||
"unit n-sphere.")
|
||||
#define FUNC_NAME s_scm_random_hollow_sphere_x
|
||||
{
|
||||
SCM_VALIDATE_VECTOR_OR_DVECTOR (1,v);
|
||||
|
|
|
|||
|
|
@ -439,7 +439,7 @@ SCM_DEFINE (scm_setitimer, "setitimer", 5, 0, 0,
|
|||
"The return value will be a list of two cons pairs representing the\n"
|
||||
"current state of the given timer. The first pair is the seconds and\n"
|
||||
"microseconds of the timer @code{it_interval}, and the second pair is\n"
|
||||
"the seconds and microseconds of the timer @code{it_value}.\n")
|
||||
"the seconds and microseconds of the timer @code{it_value}.")
|
||||
#define FUNC_NAME s_scm_setitimer
|
||||
{
|
||||
int rv;
|
||||
|
|
@ -480,7 +480,7 @@ SCM_DEFINE (scm_getitimer, "getitimer", 1, 0, 0,
|
|||
"The return value will be a list of two cons pairs representing the\n"
|
||||
"current state of the given timer. The first pair is the seconds and\n"
|
||||
"microseconds of the timer @code{it_interval}, and the second pair is\n"
|
||||
"the seconds and microseconds of the timer @code{it_value}.\n")
|
||||
"the seconds and microseconds of the timer @code{it_value}.")
|
||||
#define FUNC_NAME s_scm_getitimer
|
||||
{
|
||||
int rv;
|
||||
|
|
|
|||
|
|
@ -256,7 +256,7 @@ SCM_DEFINE (scm_make_string, "make-string", 1, 1, 0,
|
|||
"Return a newly allocated string of\n"
|
||||
"length @var{k}. If @var{chr} is given, then all elements of\n"
|
||||
"the string are initialized to @var{chr}, otherwise the contents\n"
|
||||
"of the @var{string} are unspecified.\n")
|
||||
"of the @var{string} are unspecified.")
|
||||
#define FUNC_NAME s_scm_make_string
|
||||
{
|
||||
if (SCM_INUMP (k))
|
||||
|
|
|
|||
|
|
@ -523,7 +523,7 @@ SCM_DEFINE (scm_make_vtable_vtable, "make-vtable-vtable", 2, 0, 1,
|
|||
"(define (make-ball type owner) (make-struct type 0 owner))\n\n"
|
||||
"(define ball (make-ball green 'Nisse))\n"
|
||||
"ball @result{} #<a green ball owned by Nisse>\n"
|
||||
"@end lisp\n")
|
||||
"@end lisp")
|
||||
#define FUNC_NAME s_scm_make_vtable_vtable
|
||||
{
|
||||
SCM fields;
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ make_variable (SCM init)
|
|||
|
||||
SCM_DEFINE (scm_make_variable, "make-variable", 1, 0, 0,
|
||||
(SCM init),
|
||||
"Return a variable initialized to value @var{init}.\n")
|
||||
"Return a variable initialized to value @var{init}.")
|
||||
#define FUNC_NAME s_scm_make_variable
|
||||
{
|
||||
return make_variable (init);
|
||||
|
|
@ -98,7 +98,7 @@ SCM_DEFINE (scm_make_variable, "make-variable", 1, 0, 0,
|
|||
|
||||
SCM_DEFINE (scm_make_undefined_variable, "make-undefined-variable", 0, 0, 0,
|
||||
(),
|
||||
"Return a variable that is initially unbound.\n")
|
||||
"Return a variable that is initially unbound.")
|
||||
#define FUNC_NAME s_scm_make_undefined_variable
|
||||
{
|
||||
return make_variable (SCM_UNDEFINED);
|
||||
|
|
@ -109,7 +109,7 @@ SCM_DEFINE (scm_make_undefined_variable, "make-undefined-variable", 0, 0, 0,
|
|||
SCM_DEFINE (scm_variable_p, "variable?", 1, 0, 0,
|
||||
(SCM obj),
|
||||
"Return @code{#t} iff @var{obj} is a variable object, else\n"
|
||||
"return @code{#f}\n")
|
||||
"return @code{#f}.")
|
||||
#define FUNC_NAME s_scm_variable_p
|
||||
{
|
||||
return SCM_BOOL (SCM_VARIABLEP (obj));
|
||||
|
|
@ -137,7 +137,7 @@ SCM_DEFINE (scm_variable_set_x, "variable-set!", 2, 0, 0,
|
|||
(SCM var, SCM val),
|
||||
"Set the value of the variable @var{var} to @var{val}.\n"
|
||||
"@var{var} must be a variable object, @var{val} can be any\n"
|
||||
"value. Return an unspecified value.\n")
|
||||
"value. Return an unspecified value.")
|
||||
#define FUNC_NAME s_scm_variable_set_x
|
||||
{
|
||||
SCM_VALIDATE_VARIABLE (1, var);
|
||||
|
|
@ -149,7 +149,7 @@ SCM_DEFINE (scm_variable_set_x, "variable-set!", 2, 0, 0,
|
|||
SCM_DEFINE (scm_variable_bound_p, "variable-bound?", 1, 0, 0,
|
||||
(SCM var),
|
||||
"Return @code{#t} iff @var{var} is bound to a value.\n"
|
||||
"Throws an error if @var{var} is not a variable object.\n")
|
||||
"Throws an error if @var{var} is not a variable object.")
|
||||
#define FUNC_NAME s_scm_variable_bound_p
|
||||
{
|
||||
SCM_VALIDATE_VARIABLE (1, var);
|
||||
|
|
@ -177,7 +177,7 @@ SCM_DEFINE (scm_builtin_variable, "builtin-variable", 1, 0, 0,
|
|||
(SCM name),
|
||||
"Return the built-in variable with the name @var{name}.\n"
|
||||
"@var{name} must be a symbol (not a string).\n"
|
||||
"Then use @code{variable-ref} to access its value.\n")
|
||||
"Then use @code{variable-ref} to access its value.")
|
||||
#define FUNC_NAME s_scm_builtin_variable
|
||||
{
|
||||
SCM_VALIDATE_SYMBOL (1,name);
|
||||
|
|
|
|||
|
|
@ -94,12 +94,14 @@ SCM_DEFINE (scm_version, "version", 0, 0, 0,
|
|||
(),
|
||||
"@deffnx primitive major-version\n"
|
||||
"@deffnx primitive minor-version\n"
|
||||
"Return a string describing Guile's version number, or its major or minor\n"
|
||||
"version numbers, respectively.\n\n"
|
||||
"@deffnx primitive micro-version\n"
|
||||
"Return a string describing Guile's version number, or its major, minor\n"
|
||||
"or micro version number, respectively.\n\n"
|
||||
"@lisp\n"
|
||||
"(version) @result{} \"1.3a\"\n"
|
||||
"(version) @result{} \"1.6.0\"\n"
|
||||
"(major-version) @result{} \"1\"\n"
|
||||
"(minor-version) @result{} \"3a\"\n"
|
||||
"(minor-version) @result{} \"6\"\n"
|
||||
"(micro-version) @result{} \"0\"\n"
|
||||
"@end lisp")
|
||||
#define FUNC_NAME s_scm_version
|
||||
{
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
2001-11-13 Neil Jerram <neil@ossau.uklinux.net>
|
||||
|
||||
* srfi-13.c (scm_string_unfold, scm_string_unfold_right),
|
||||
srfi-14.c (scm_char_set_unfold, scm_char_set_unfold_x): Remove
|
||||
superfluous whitespace from end of docstring lines.
|
||||
|
||||
2001-11-06 Thien-Thi Nguyen <ttn@glug.org>
|
||||
|
||||
* srfi-19.scm (time-monotonic->time-monotonic): Spurious;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue