[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Guile-commits] GNU Guile branch, master, updated. release_1-9-6-42-g332
|
From: |
Neil Jerram |
|
Subject: |
[Guile-commits] GNU Guile branch, master, updated. release_1-9-6-42-g3323ec0 |
|
Date: |
Sun, 27 Dec 2009 23:24:51 +0000 |
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GNU Guile".
http://git.savannah.gnu.org/cgit/guile.git/commit/?id=3323ec063ccc87b210e6da04c57c625af270b230
The branch, master has been updated
via 3323ec063ccc87b210e6da04c57c625af270b230 (commit)
from 211a5b04251424f17f659257718329af7a3cdc0c (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 3323ec063ccc87b210e6da04c57c625af270b230
Author: Neil Jerram <address@hidden>
Date: Sun Dec 27 23:24:09 2009 +0000
Automatic manual updates following libguile docstring changes
Affecting the following procedures:
* doc/ref/api-compound.texi (Uniform Numeric Vectors):
uniform-array-read!
* doc/ref/api-data.texi (Complex): make-rectangular, string=?,
string<?, string<=?, string>?, string>=?, string-ci=?, string-ci<?,
string-ci<=?, string-ci>?, string-ci>=?, string-append/shared
* doc/ref/api-evaluation.texi (Reader Extensions): read-hash-extend
* doc/ref/api-procedures.texi (Procedures with Setters): procedure,
macro?, macro-type
* doc/ref/api-undocumented.texi: module-import-interface,
%method-more-specific?
* doc/ref/new-docstrings.texi: uniform-array->bytevector,
%start-stack, guardian-destroyed?, guardian-greedy?,
destroy-guardian!, gc-dump, gc-disable, gc-enable,
make-generalized-vector, set-primitive-generic!, nl-langinfo,
%warn-autocompilation-enabled, make-syncase-macro,
make-extended-syncase-macro, syncase-macro-type,
syncase-macro-binding, memoize-expression, unmemoize-expression,
memoized-expression-typecode, memoized-expression-data,
memoized-typecode, memoize-variable-access!, module-local-variable,
module-variable, eval-closure-module, module-transformer,
module-public-interface, define!, module-reverse-lookup, cddr,
make-promise, %get-stack-size, %string-dump, %symbol-dump,
string-bytes-per-char, uniform-vector-element-type,
uniform-vector-element-size, canonicalize-path, getrlimit, setrlimit
* doc/maint/guile.texi: Corresponding tracking updates.
-----------------------------------------------------------------------
Summary of changes:
doc/maint/guile.texi | 109 +++++++++--------
doc/ref/api-compound.texi | 37 +++----
doc/ref/api-data.texi | 46 +++++---
doc/ref/api-evaluation.texi | 4 +-
doc/ref/api-procedures.texi | 18 ++--
doc/ref/api-undocumented.texi | 4 +-
doc/ref/new-docstrings.texi | 271 +++++++++++++++++++++++++++++++++++++++++
7 files changed, 385 insertions(+), 104 deletions(-)
diff --git a/doc/maint/guile.texi b/doc/maint/guile.texi
index 127f0bb..d521f98 100644
--- a/doc/maint/guile.texi
+++ b/doc/maint/guile.texi
@@ -2130,7 +2130,7 @@ all necessary initialization information.
@c snarfed from goops.c:2318
@deffn {Scheme Procedure} %method-more-specific? m1 m2 targs
@deffnx {C Function} scm_sys_method_more_specific_p (m1, m2, targs)
-
+Return true if method @var{m1} is more specific than @var{m2} given the
argument types (classes) listed in @var{targs}.
@end deffn
%goops-loaded
@@ -3220,19 +3220,19 @@ environment. For example:
@c snarfed from macros.c:165
@deffn {Scheme Procedure} macro? obj
@deffnx {C Function} scm_macro_p (obj)
-Return @code{#t} if @var{obj} is a regular macro, a memoizing macro or a
-syntax transformer.
+Return @code{#t} if @var{obj} is a regular macro, a memoizing macro, a
+syntax transformer, or a syntax-case macro.
@end deffn
macro-type
@c snarfed from macros.c:186
@deffn {Scheme Procedure} macro-type m
@deffnx {C Function} scm_macro_type (m)
-Return one of the symbols @code{syntax}, @code{macro} or
address@hidden, depending on whether @var{m} is a syntax
-transformer, a regular macro, or a memoizing macro,
-respectively. If @var{m} is not a macro, @code{#f} is
-returned.
+Return one of the symbols @code{syntax}, @code{macro},
address@hidden, or @code{syntax-case}, depending on whether
address@hidden is a syntax transformer, a regular macro, a memoizing
+macro, or a syntax-case macro, respectively. If @var{m} is
+not a macro, @code{#f} is returned.
@end deffn
macro-name
@@ -3300,7 +3300,7 @@ Return a interface eval closure for the module
@var{module}. Such a closure does
@c snarfed from modules.c:399
@deffn {Scheme Procedure} module-import-interface module sym
@deffnx {C Function} scm_module_import_interface (module, sym)
-
+Return the module or interface from which @var{sym} is imported in
@var{module}. If @var{sym} is not imported (i.e., it is not defined in
@var{module} or it is a module-local binding instead of an imported one), then
@code{#f} is returned.
@end deffn
%get-pre-modules-obarray
@@ -3689,10 +3689,9 @@ procedure does not accept complex arguments.
make-rectangular
@c snarfed from numbers.c:5286
address@hidden {Scheme Procedure} make-rectangular real imaginary
address@hidden {C Function} scm_make_rectangular (real, imaginary)
-Return a complex number constructed of the given @var{real} and
address@hidden parts.
address@hidden {Scheme Procedure} make-rectangular real_part imaginary_part
address@hidden {C Function} scm_make_rectangular (real_part, imaginary_part)
+Return a complex number constructed of the given @var{real-part} and
@var{imaginary-part} parts.
@end deffn
make-polar
@@ -4361,8 +4360,8 @@ with the associated setter @var{setter}.
@c snarfed from procs.c:308
@deffn {Scheme Procedure} procedure proc
@deffnx {C Function} scm_procedure (proc)
-Return the procedure of @var{proc}, which must be either a
-procedure with setter, or an operator struct.
+Return the procedure of @var{proc}, which must be an
+applicable struct.
@end deffn
primitive-make-property
@@ -4566,7 +4565,9 @@ Install the procedure @var{proc} for reading expressions
starting with the character sequence @code{#} and @var{chr}.
@var{proc} will be called with two arguments: the character
@var{chr} and the port to read further data from. The object
-returned will be the return value of @code{read}.
+returned will be the return value of @code{read}.
+Passing @code{#f} for @var{proc} will remove a previous setting.
+
@end deffn
call-with-dynamic-root
@@ -5438,30 +5439,23 @@ Return the number of elements in the uniform vector
@var{v}.
uniform-vector-read!
@c snarfed from srfi-4.c:845
address@hidden {Scheme Procedure} uniform-vector-read! uvec [port_or_fd [start
[end]]]
address@hidden {C Function} scm_uniform_vector_read_x (uvec, port_or_fd, start,
end)
-Fill the elements of @var{uvec} by reading
-raw bytes from @var{port-or-fdes}, using host byte order.
address@hidden {Scheme Procedure} uniform-array-read! ura [port_or_fd [start
[end]]]
address@hidden {Scheme Procedure} uniform-vector-read! uve [port-or-fdes]
[start] [end]
address@hidden {C Function} scm_uniform_array_read_x (ura, port_or_fd, start,
end)
+Attempt to read all elements of @var{ura}, in lexicographic order, as
+binary objects from @var{port-or-fdes}.
+If an end of file is encountered,
+the objects up to that point are put into @var{ura}
+(starting at the beginning) and the remainder of the array is
+unchanged.
-The optional arguments @var{start} (inclusive) and @var{end}
-(exclusive) allow a specified region to be read,
+The optional arguments @var{start} and @var{end} allow
+a specified region of a vector (or linearized array) to be read,
leaving the remainder of the vector unchanged.
-When @var{port-or-fdes} is a port, all specified elements
-of @var{uvec} are attempted to be read, potentially blocking
-while waiting formore input or end-of-file.
-When @var{port-or-fd} is an integer, a single call to
-read(2) is made.
-
-An error is signalled when the last element has only
-been partially filled before reaching end-of-file or in
-the single call to read(2).
-
address@hidden returns the number of elements
-read.
-
address@hidden may be omitted, in which case it defaults
-to the value returned by @code{(current-input-port)}.
address@hidden returns the number of objects read.
address@hidden may be omitted, in which case it defaults to the value
+returned by @code{(current-input-port)}.
@end deffn
uniform-vector-write
@@ -6671,8 +6665,9 @@ mismatch index, depending upon whether @var{s1} is less
than,
equal to, or greater than @var{s2}. The mismatch index is the
largest index @var{i} such that for every 0 <= @var{j} <
@var{i}, @address@hidden = @address@hidden -- that is,
address@hidden is the first position that does not match. The
-character comparison is done case-insensitively.
address@hidden is the first position where the lowercased letters
+do not match.
+
@end deffn
string=
@@ -7090,8 +7085,8 @@ operate on. The return value is unspecified.
string-append/shared
@c snarfed from srfi-13.c:2635
address@hidden {Scheme Procedure} string-append/shared . ls
address@hidden {C Function} scm_string_append_shared (ls)
address@hidden {Scheme Procedure} string-append/shared . rest
address@hidden {C Function} scm_string_append_shared (rest)
Like @code{string-append}, but the result may share memory
with the argument strings.
@end deffn
@@ -7749,7 +7744,8 @@ character sets.
string=?
@c snarfed from strorder.c:50
address@hidden {Scheme Procedure} string=? s1 s2
address@hidden {Scheme Procedure} string=? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_equal_p (s1, s2, rest)
Lexicographic equality predicate; return @code{#t} if the two
strings are the same length and contain the same characters in
the same positions, otherwise return @code{#f}.
@@ -7762,7 +7758,8 @@ characters.
string-ci=?
@c snarfed from strorder.c:62
address@hidden {Scheme Procedure} string-ci=? s1 s2
address@hidden {Scheme Procedure} string-ci=? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_ci_equal_p (s1, s2, rest)
Case-insensitive string equality predicate; return @code{#t} if
the two strings are the same length and their component
characters match (ignoring case) at each position; otherwise
@@ -7771,35 +7768,40 @@ return @code{#f}.
string<?
@c snarfed from strorder.c:72
address@hidden {Scheme Procedure} string<? s1 s2
address@hidden {Scheme Procedure} string<? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_less_p (s1, s2, rest)
Lexicographic ordering predicate; return @code{#t} if @var{s1}
is lexicographically less than @var{s2}.
@end deffn
string<=?
@c snarfed from strorder.c:82
address@hidden {Scheme Procedure} string<=? s1 s2
address@hidden {Scheme Procedure} string<=? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_leq_p (s1, s2, rest)
Lexicographic ordering predicate; return @code{#t} if @var{s1}
is lexicographically less than or equal to @var{s2}.
@end deffn
string>?
@c snarfed from strorder.c:92
address@hidden {Scheme Procedure} string>? s1 s2
address@hidden {Scheme Procedure} string>? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_gr_p (s1, s2, rest)
Lexicographic ordering predicate; return @code{#t} if @var{s1}
is lexicographically greater than @var{s2}.
@end deffn
string>=?
@c snarfed from strorder.c:102
address@hidden {Scheme Procedure} string>=? s1 s2
address@hidden {Scheme Procedure} string>=? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_geq_p (s1, s2, rest)
Lexicographic ordering predicate; return @code{#t} if @var{s1}
is lexicographically greater than or equal to @var{s2}.
@end deffn
string-ci<?
@c snarfed from strorder.c:113
address@hidden {Scheme Procedure} string-ci<? s1 s2
address@hidden {Scheme Procedure} string-ci<? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_ci_less_p (s1, s2, rest)
Case insensitive lexicographic ordering predicate; return
@code{#t} if @var{s1} is lexicographically less than @var{s2}
regardless of case.
@@ -7807,7 +7809,8 @@ regardless of case.
string-ci<=?
@c snarfed from strorder.c:124
address@hidden {Scheme Procedure} string-ci<=? s1 s2
address@hidden {Scheme Procedure} string-ci<=? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_ci_leq_p (s1, s2, rest)
Case insensitive lexicographic ordering predicate; return
@code{#t} if @var{s1} is lexicographically less than or equal
to @var{s2} regardless of case.
@@ -7815,7 +7818,8 @@ to @var{s2} regardless of case.
string-ci>?
@c snarfed from strorder.c:135
address@hidden {Scheme Procedure} string-ci>? s1 s2
address@hidden {Scheme Procedure} string-ci>? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_ci_gr_p (s1, s2, rest)
Case insensitive lexicographic ordering predicate; return
@code{#t} if @var{s1} is lexicographically greater than
@var{s2} regardless of case.
@@ -7823,7 +7827,8 @@ Case insensitive lexicographic ordering predicate; return
string-ci>=?
@c snarfed from strorder.c:146
address@hidden {Scheme Procedure} string-ci>=? s1 s2
address@hidden {Scheme Procedure} string-ci>=? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_ci_geq_p (s1, s2, rest)
Case insensitive lexicographic ordering predicate; return
@code{#t} if @var{s1} is lexicographically greater than or
equal to @var{s2} regardless of case.
diff --git a/doc/ref/api-compound.texi b/doc/ref/api-compound.texi
index 5c1bd88..33ccdfe 100644
--- a/doc/ref/api-compound.texi
+++ b/doc/ref/api-compound.texi
@@ -1411,30 +1411,23 @@ be more convenient for binary input/output since they
provide more
flexibility in the interpretation of raw byte sequences
(@pxref{Bytevectors}).
address@hidden {Scheme Procedure} uniform-vector-read! uvec [port_or_fd [start
[end]]]
address@hidden {C Function} scm_uniform_vector_read_x (uvec, port_or_fd, start,
end)
-Fill the elements of @var{uvec} by reading
-raw bytes from @var{port-or-fdes}, using host byte order.
address@hidden {Scheme Procedure} uniform-array-read! ura [port_or_fd [start
[end]]]
address@hidden {Scheme Procedure} uniform-vector-read! uve [port-or-fdes]
[start] [end]
address@hidden {C Function} scm_uniform_array_read_x (ura, port_or_fd, start,
end)
+Attempt to read all elements of @var{ura}, in lexicographic order, as
+binary objects from @var{port-or-fdes}.
+If an end of file is encountered,
+the objects up to that point are put into @var{ura}
+(starting at the beginning) and the remainder of the array is
+unchanged.
-The optional arguments @var{start} (inclusive) and @var{end}
-(exclusive) allow a specified region to be read,
+The optional arguments @var{start} and @var{end} allow
+a specified region of a vector (or linearized array) to be read,
leaving the remainder of the vector unchanged.
-When @var{port-or-fdes} is a port, all specified elements
-of @var{uvec} are attempted to be read, potentially blocking
-while waiting formore input or end-of-file.
-When @var{port-or-fd} is an integer, a single call to
-read(2) is made.
-
-An error is signalled when the last element has only
-been partially filled before reaching end-of-file or in
-the single call to read(2).
-
address@hidden returns the number of elements
-read.
-
address@hidden may be omitted, in which case it defaults
-to the value returned by @code{(current-input-port)}.
address@hidden returns the number of objects read.
address@hidden may be omitted, in which case it defaults to the value
+returned by @code{(current-input-port)}.
@end deffn
@deffn {Scheme Procedure} uniform-vector-write uvec [port_or_fd [start [end]]]
diff --git a/doc/ref/api-data.texi b/doc/ref/api-data.texi
index b959ab9..61f941a 100755
--- a/doc/ref/api-data.texi
+++ b/doc/ref/api-data.texi
@@ -1054,10 +1054,9 @@ locale-dependent parsing).
@rnindex magnitude
@rnindex angle
address@hidden {Scheme Procedure} make-rectangular real imaginary
address@hidden {C Function} scm_make_rectangular (real, imaginary)
-Return a complex number constructed of the given @var{real} and
address@hidden parts.
address@hidden {Scheme Procedure} make-rectangular real_part imaginary_part
address@hidden {C Function} scm_make_rectangular (real_part, imaginary_part)
+Return a complex number constructed of the given @var{real-part} and
@var{imaginary-part} parts.
@end deffn
@deffn {Scheme Procedure} make-polar x y
@@ -3072,7 +3071,8 @@ comparison. See @xref{Text Collation, the @code{(ice-9
i18n)} module}, for locale-dependent string comparison.
@rnindex string=?
address@hidden {Scheme Procedure} string=? s1 s2
address@hidden {Scheme Procedure} string=? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_equal_p (s1, s2, rest)
Lexicographic equality predicate; return @code{#t} if the two
strings are the same length and contain the same characters in
the same positions, otherwise return @code{#f}.
@@ -3084,31 +3084,36 @@ characters.
@end deffn
@rnindex string<?
address@hidden {Scheme Procedure} string<? s1 s2
address@hidden {Scheme Procedure} string<? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_less_p (s1, s2, rest)
Lexicographic ordering predicate; return @code{#t} if @var{s1}
is lexicographically less than @var{s2}.
@end deffn
@rnindex string<=?
address@hidden {Scheme Procedure} string<=? s1 s2
address@hidden {Scheme Procedure} string<=? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_leq_p (s1, s2, rest)
Lexicographic ordering predicate; return @code{#t} if @var{s1}
is lexicographically less than or equal to @var{s2}.
@end deffn
@rnindex string>?
address@hidden {Scheme Procedure} string>? s1 s2
address@hidden {Scheme Procedure} string>? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_gr_p (s1, s2, rest)
Lexicographic ordering predicate; return @code{#t} if @var{s1}
is lexicographically greater than @var{s2}.
@end deffn
@rnindex string>=?
address@hidden {Scheme Procedure} string>=? s1 s2
address@hidden {Scheme Procedure} string>=? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_geq_p (s1, s2, rest)
Lexicographic ordering predicate; return @code{#t} if @var{s1}
is lexicographically greater than or equal to @var{s2}.
@end deffn
@rnindex string-ci=?
address@hidden {Scheme Procedure} string-ci=? s1 s2
address@hidden {Scheme Procedure} string-ci=? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_ci_equal_p (s1, s2, rest)
Case-insensitive string equality predicate; return @code{#t} if
the two strings are the same length and their component
characters match (ignoring case) at each position; otherwise
@@ -3116,28 +3121,32 @@ return @code{#f}.
@end deffn
@rnindex string-ci<?
address@hidden {Scheme Procedure} string-ci<? s1 s2
address@hidden {Scheme Procedure} string-ci<? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_ci_less_p (s1, s2, rest)
Case insensitive lexicographic ordering predicate; return
@code{#t} if @var{s1} is lexicographically less than @var{s2}
regardless of case.
@end deffn
@rnindex string<=?
address@hidden {Scheme Procedure} string-ci<=? s1 s2
address@hidden {Scheme Procedure} string-ci<=? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_ci_leq_p (s1, s2, rest)
Case insensitive lexicographic ordering predicate; return
@code{#t} if @var{s1} is lexicographically less than or equal
to @var{s2} regardless of case.
@end deffn
@rnindex string-ci>?
address@hidden {Scheme Procedure} string-ci>? s1 s2
address@hidden {Scheme Procedure} string-ci>? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_ci_gr_p (s1, s2, rest)
Case insensitive lexicographic ordering predicate; return
@code{#t} if @var{s1} is lexicographically greater than
@var{s2} regardless of case.
@end deffn
@rnindex string-ci>=?
address@hidden {Scheme Procedure} string-ci>=? s1 s2
address@hidden {Scheme Procedure} string-ci>=? [s1 [s2 . rest]]
address@hidden {C Function} scm_i_string_ci_geq_p (s1, s2, rest)
Case insensitive lexicographic ordering predicate; return
@code{#t} if @var{s1} is lexicographically greater than or
equal to @var{s2} regardless of case.
@@ -3160,8 +3169,9 @@ mismatch index, depending upon whether @var{s1} is less
than,
equal to, or greater than @var{s2}. The mismatch index is the
largest index @var{i} such that for every 0 <= @var{j} <
@var{i}, @address@hidden = @address@hidden -- that is,
address@hidden is the first position that does not match. The
-character comparison is done case-insensitively.
address@hidden is the first position where the lowercased letters
+do not match.
+
@end deffn
@deffn {Scheme Procedure} string= s1 s2 [start1 [end1 [start2 [end2]]]]
@@ -3526,8 +3536,8 @@ concatenation of the given strings, @var{args}.
@end example
@end deffn
address@hidden {Scheme Procedure} string-append/shared . ls
address@hidden {C Function} scm_string_append_shared (ls)
address@hidden {Scheme Procedure} string-append/shared . rest
address@hidden {C Function} scm_string_append_shared (rest)
Like @code{string-append}, but the result may share memory
with the argument strings.
@end deffn
diff --git a/doc/ref/api-evaluation.texi b/doc/ref/api-evaluation.texi
index fda0291..f1aeace 100644
--- a/doc/ref/api-evaluation.texi
+++ b/doc/ref/api-evaluation.texi
@@ -292,7 +292,9 @@ Install the procedure @var{proc} for reading expressions
starting with the character sequence @code{#} and @var{chr}.
@var{proc} will be called with two arguments: the character
@var{chr} and the port to read further data from. The object
-returned will be the return value of @code{read}.
+returned will be the return value of @code{read}.
+Passing @code{#f} for @var{proc} will remove a previous setting.
+
@end deffn
diff --git a/doc/ref/api-procedures.texi b/doc/ref/api-procedures.texi
index 0f89612..4639881 100644
--- a/doc/ref/api-procedures.texi
+++ b/doc/ref/api-procedures.texi
@@ -768,8 +768,8 @@ associated setter procedure.
@deffn {Scheme Procedure} procedure proc
@deffnx {C Function} scm_procedure (proc)
-Return the procedure of @var{proc}, which must be either a
-procedure with setter, or an operator struct.
+Return the procedure of @var{proc}, which must be an
+applicable struct.
@end deffn
@deffn {Scheme Procedure} setter proc
@@ -1031,17 +1031,17 @@ as @dfn{syntax transformers}.
@deffn {Scheme Procedure} macro? obj
@deffnx {C Function} scm_macro_p (obj)
-Return @code{#t} if @var{obj} is a regular macro, a memoizing macro or a
-syntax transformer.
+Return @code{#t} if @var{obj} is a regular macro, a memoizing macro, a
+syntax transformer, or a syntax-case macro.
@end deffn
@deffn {Scheme Procedure} macro-type m
@deffnx {C Function} scm_macro_type (m)
-Return one of the symbols @code{syntax}, @code{macro} or
address@hidden, depending on whether @var{m} is a syntax
-transformer, a regular macro, or a memoizing macro,
-respectively. If @var{m} is not a macro, @code{#f} is
-returned.
+Return one of the symbols @code{syntax}, @code{macro},
address@hidden, or @code{syntax-case}, depending on whether
address@hidden is a syntax transformer, a regular macro, a memoizing
+macro, or a syntax-case macro, respectively. If @var{m} is
+not a macro, @code{#f} is returned.
@end deffn
@deffn {Scheme Procedure} macro-name m
diff --git a/doc/ref/api-undocumented.texi b/doc/ref/api-undocumented.texi
index ef1df19..cae96bc 100644
--- a/doc/ref/api-undocumented.texi
+++ b/doc/ref/api-undocumented.texi
@@ -155,7 +155,7 @@ has been passed to scm_register_module_xxx.
@deffn {Scheme Procedure} module-import-interface module sym
@deffnx {C Function} scm_module_import_interface (module, sym)
-
+Return the module or interface from which @var{sym} is imported in
@var{module}. If @var{sym} is not imported (i.e., it is not defined in
@var{module} or it is a module-local binding instead of an imported one), then
@code{#f} is returned.
@end deffn
@@ -623,7 +623,7 @@ on the C level which depends on the loaded GOOPS modules.
@deffn {Scheme Procedure} %method-more-specific? m1 m2 targs
@deffnx {C Function} scm_sys_method_more_specific_p (m1, m2, targs)
-
+Return true if method @var{m1} is more specific than @var{m2} given the
argument types (classes) listed in @var{targs}.
@end deffn
@deffn {Scheme Procedure} find-method . l
diff --git a/doc/ref/new-docstrings.texi b/doc/ref/new-docstrings.texi
index c8f16a3..65dda6e 100644
--- a/doc/ref/new-docstrings.texi
+++ b/doc/ref/new-docstrings.texi
@@ -1,3 +1,274 @@
@c module-for-docstring (guile)
+
address@hidden {Scheme Procedure} uniform-array->bytevector array
address@hidden {C Function} scm_uniform_array_to_bytevector (array)
+Return a newly allocated bytevector whose contents
+will be copied from the uniform array @var{array}.
address@hidden deffn
+
address@hidden {Scheme Procedure} %start-stack id thunk
address@hidden {C Function} scm_sys_start_stack (id, thunk)
+Call @var{thunk} on an evaluator stack tagged with @var{id}.
address@hidden deffn
+
address@hidden {Scheme Procedure} guardian-destroyed? guardian
address@hidden {C Function} scm_guardian_destroyed_p (guardian)
+Return @code{#t} if @var{guardian} has been destroyed, otherwise @code{#f}.
address@hidden deffn
+
address@hidden {Scheme Procedure} guardian-greedy? guardian
address@hidden {C Function} scm_guardian_greedy_p (guardian)
+Return @code{#t} if @var{guardian} is a greedy guardian, otherwise @code{#f}.
address@hidden deffn
+
address@hidden {Scheme Procedure} destroy-guardian! guardian
address@hidden {C Function} scm_destroy_guardian_x (guardian)
+Destroys @var{guardian}, by making it impossible to put any more
+objects in it or get any objects from it. It also unguards any
+objects guarded by @var{guardian}.
address@hidden deffn
+
address@hidden {Scheme Procedure} gc-dump
address@hidden {C Function} scm_gc_dump ()
+Dump information about the garbage collector's internal data structures and
memory usage to the standard output.
address@hidden deffn
+
address@hidden {Scheme Procedure} gc-disable
address@hidden {C Function} scm_gc_disable ()
+Disables the garbage collector. Nested calls are permitted. GC is re-enabled
once @code{gc-enable} has been called the same number of times
@code{gc-disable} was called.
address@hidden deffn
+
address@hidden {Scheme Procedure} gc-enable
address@hidden {C Function} scm_gc_enable ()
+Enables the garbage collector.
address@hidden deffn
+
address@hidden {Scheme Procedure} make-generalized-vector type len [fill]
address@hidden {C Function} scm_make_generalized_vector (type, len, fill)
+Make a generalized vector
address@hidden deffn
+
address@hidden {Scheme Procedure} set-primitive-generic! subr generic
address@hidden {C Function} scm_set_primitive_generic_x (subr, generic)
+
address@hidden deffn
+
address@hidden {Scheme Procedure} nl-langinfo item [locale]
address@hidden {C Function} scm_nl_langinfo (item, locale)
+Return a string denoting locale information for @var{item} in the current
locale or that specified by @var{locale}. The semantics and arguments are the
same as those of the X/Open @code{nl_langinfo} function (@pxref{The Elegant and
Fast Way, @code{nl_langinfo},, libc, The GNU C Library Reference Manual}).
address@hidden deffn
+
address@hidden {Scheme Procedure} %warn-autocompilation-enabled
address@hidden {C Function} scm_sys_warn_autocompilation_enabled ()
+
address@hidden deffn
+
address@hidden {Scheme Procedure} make-syncase-macro type binding
address@hidden {C Function} scm_make_syncase_macro (type, binding)
+Return a @dfn{macro} that requires expansion by syntax-case.
+While users should not call this function, it is useful to know
+that syntax-case macros are represented as Guile primitive macros.
address@hidden deffn
+
address@hidden {Scheme Procedure} make-extended-syncase-macro m type binding
address@hidden {C Function} scm_make_extended_syncase_macro (m, type, binding)
+Extend a core macro @var{m} with a syntax-case binding.
address@hidden deffn
+
address@hidden {Scheme Procedure} syncase-macro-type m
address@hidden {C Function} scm_syncase_macro_type (m)
+Return the type of the macro @var{m}.
address@hidden deffn
+
address@hidden {Scheme Procedure} syncase-macro-binding m
address@hidden {C Function} scm_syncase_macro_binding (m)
+Return the binding of the macro @var{m}.
address@hidden deffn
+
address@hidden {Scheme Procedure} memoize-expression exp
address@hidden {C Function} scm_memoize_expression (exp)
+Memoize the expression @var{exp}.
address@hidden deffn
+
address@hidden {Scheme Procedure} unmemoize-expression m
address@hidden {C Function} scm_unmemoize_expression (m)
+Unmemoize the memoized expression @var{m}.
address@hidden deffn
+
address@hidden {Scheme Procedure} memoized-expression-typecode m
address@hidden {C Function} scm_memoized_expression_typecode (m)
+Return the typecode from the memoized expression @var{m}.
address@hidden deffn
+
address@hidden {Scheme Procedure} memoized-expression-data m
address@hidden {C Function} scm_memoized_expression_data (m)
+Return the data from the memoized expression @var{m}.
address@hidden deffn
+
address@hidden {Scheme Procedure} memoized-typecode sym
address@hidden {C Function} scm_memoized_typecode (sym)
+Return the memoized typecode corresponding to the symbol @var{sym}.
address@hidden deffn
+
address@hidden {Scheme Procedure} memoize-variable-access! m mod
address@hidden {C Function} scm_memoize_variable_access_x (m, mod)
+Look up and cache the variable that @var{m} will access, returning the
variable.
address@hidden deffn
+
address@hidden {Scheme Procedure} module-local-variable module sym
address@hidden {C Function} scm_module_local_variable (module, sym)
+Return the variable bound to @var{sym} in @var{module}. Return @code{#f} is
@var{sym} is not bound locally in @var{module}.
address@hidden deffn
+
address@hidden {Scheme Procedure} module-variable module sym
address@hidden {C Function} scm_module_variable (module, sym)
+Return the variable bound to @var{sym} in @var{module}. This may be both a
local variable or an imported variable. Return @code{#f} is @var{sym} is not
bound in @var{module}.
address@hidden deffn
+
address@hidden {Scheme Procedure} eval-closure-module eval_closure
address@hidden {C Function} scm_eval_closure_module (eval_closure)
+Return the module associated with this eval closure.
address@hidden deffn
+
address@hidden {Scheme Procedure} module-transformer module
address@hidden {C Function} scm_module_transformer (module)
+Returns the syntax expander for the given module.
address@hidden deffn
+
address@hidden {Scheme Procedure} module-public-interface module
address@hidden {C Function} scm_module_public_interface (module)
+Return the public interface of @var{module}.
+
+If @var{module} has no public interface, @code{#f} is returned.
address@hidden deffn
+
address@hidden {Scheme Procedure} define! sym value
address@hidden {C Function} scm_define (sym, value)
+Define @var{sym} to be @var{value} in the current module.Returns the variable
itself. Note that this is a procedure, not a macro.
address@hidden deffn
+
address@hidden {Scheme Procedure} module-reverse-lookup module variable
address@hidden {C Function} scm_module_reverse_lookup (module, variable)
+Return the symbol under which @var{variable} is bound in @var{module} or
@var{#f} if @var{variable} is not visible from @var{module}. If @var{module}
is @code{#f}, then the pre-module obarray is used.
address@hidden deffn
+
address@hidden {Scheme Procedure} cddr x
address@hidden {C Function} scm_cddr (x)
+
address@hidden deffn
+
address@hidden {Scheme Procedure} make-promise thunk
address@hidden {C Function} scm_make_promise (thunk)
+Create a new promise object.
+
address@hidden is a procedural form of @code{delay}.
+These two expressions are equivalent:
address@hidden
+(delay @var{exp})
+(make-promise (lambda () @var{exp}))
address@hidden lisp
+
address@hidden deffn
+
address@hidden {Scheme Procedure} %get-stack-size
address@hidden {C Function} scm_sys_get_stack_size ()
+Return the current thread's C stack size (in Scheme objects).
address@hidden deffn
+
address@hidden {Scheme Procedure} %string-dump str
address@hidden {C Function} scm_sys_string_dump (str)
+Returns an association list containing debugging information
+for @var{str}. The association list has the following address@hidden @code
address@hidden string
+The string itself.
address@hidden start
+The start index of the string into its stringbuf
address@hidden length
+The length of the string
address@hidden shared
+If this string is a substring, it returns its parent string.
+Otherwise, it returns @code{#f}
address@hidden read-only
address@hidden if the string is read-only
address@hidden stringbuf-chars
+A new string containing this string's stringbuf's characters
address@hidden stringbuf-length
+The number of characters in this stringbuf
address@hidden stringbuf-shared
address@hidden if this stringbuf is shared
address@hidden stringbuf-wide
address@hidden if this stringbuf's characters are stored in a
+32-bit buffer, or @code{#f} if they are stored in an 8-bit
+buffer
address@hidden table
address@hidden deffn
+
address@hidden {Scheme Procedure} %symbol-dump sym
address@hidden {C Function} scm_sys_symbol_dump (sym)
+Returns an association list containing debugging information
+for @var{sym}. The association list has the following address@hidden @code
address@hidden symbol
+The symbol itself
address@hidden hash
+Its hash value
address@hidden interned
address@hidden if it is an interned symbol
address@hidden stringbuf-chars
+A new string containing this symbols's stringbuf's characters
address@hidden stringbuf-length
+The number of characters in this stringbuf
address@hidden stringbuf-shared
address@hidden if this stringbuf is shared
address@hidden stringbuf-wide
address@hidden if this stringbuf's characters are stored in a
+32-bit buffer, or @code{#f} if they are stored in an 8-bit
+buffer
address@hidden table
address@hidden deffn
+
address@hidden {Scheme Procedure} string-bytes-per-char string
address@hidden {C Function} scm_string_bytes_per_char (string)
+Return the bytes used to represent a character in @var{string}.This will
return 1 or 4.
address@hidden deffn
+
address@hidden {Scheme Procedure} uniform-vector-element-type v
address@hidden {C Function} scm_uniform_vector_element_type (v)
+Return the type of the elements in the uniform vector, @var{v}.
address@hidden deffn
+
address@hidden {Scheme Procedure} uniform-vector-element-size v
address@hidden {C Function} scm_uniform_vector_element_size (v)
+Return the number of bytes allocated to each element in the
+uniform vector, @var{v}.
address@hidden deffn
+
address@hidden {Scheme Procedure} canonicalize-path path
address@hidden {C Function} scm_canonicalize_path (path)
+Return the canonical path of @var{path}. A canonical path has
+no @code{.} or @code{..} components, nor any repeated path
+separators (@code{/}) nor symlinks.
+
+Raises an error if any component of @var{path} does not exist.
address@hidden deffn
+
address@hidden {Scheme Procedure} getrlimit resource
address@hidden {C Function} scm_getrlimit (resource)
+Get a resource limit for this process. @var{resource} identifies the resource,
+either as an integer or as a symbol. For example, @code{(getrlimit 'stack)}
+gets the limits associated with @code{RLIMIT_STACK}.
+
address@hidden returns two values, the soft and the hard limit. If no
+limit is set for the resource in question, the returned limit will be
@code{#f}.
address@hidden deffn
+
address@hidden {Scheme Procedure} setrlimit resource soft hard
address@hidden {C Function} scm_setrlimit (resource, soft, hard)
+Set a resource limit for this process. @var{resource} identifies the resource,
+either as an integer or as a symbol. @var{soft} and @var{hard} should be
integers,
+or @code{#f} to indicate no limit (i.e., @code{RLIM_INFINITY}).
+
+For example, @code{(setrlimit 'stack 150000 300000)} sets the
@code{RLIMIT_STACK}
+limit to 150 kilobytes, with a hard limit of 300 kB.
address@hidden deffn
hooks/post-receive
--
GNU Guile
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Guile-commits] GNU Guile branch, master, updated. release_1-9-6-42-g3323ec0,
Neil Jerram <=