* configure.in: Use AC_PROG_LIBTOOL instead of AM_PROG_LIBTOOL.
[bpt/guile.git] / doc / ref / ChangeLog
index 6083669..e0d5538 100644 (file)
@@ -1,3 +1,521 @@
+2004-02-15  Mikael Djurfeldt  <mdj@chunk.mit.edu>
+
+       * scheme-compound.texi (Hash Table Reference): Renamed hash-map
+       --> hash-map->list.
+
+2004-02-15  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-compound.texi (Hash Table Reference): In scm_hash_ref etc,
+       remove note that dflt must be given, it can be SCM_UNSPECIFIED.
+
+       * scheme-control.texi (while do): Expand and clarify `do', in
+       particular note iteration binds fresh locations, rather than values
+       "stored".
+       * srfi-modules.texi (SRFI-4): Revise for clarity, give each function
+       explicitly rather than showing TAG so Emacs info-look can find them,
+       merge "SRFI-4 - Read Syntax" and "SRFI-4 - Procedures" into just one
+       node.
+
+2004-02-12  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-compound.texi (Conventional Arrays): Revise for clarity.
+       In array-equal?, show multiple arguments allowed.
+       (Uniform Arrays): Remove duplicate array?.
+       * guile.texi (cross): New macro.
+
+       * scheme-compound.texi (Uniform Arrays): Note 1/3 prototype for
+       doubles is now an exact fraction.
+
+       * slib.texi (SLIB): Index entry for replacement `system'.
+
+2004-01-28  Mikael Djurfeldt  <mdj@chunk.mit.edu>
+
+       * scheme-compound.texi (Uniform Arrays): Added a FIXME warning
+       that the 1/3 prototype no longer works.
+
+2004-01-23  Marius Vollmer  <mvo@zagadka.de>
+
+       * Makefile.am (guile_TEXINFOS): Added fdl.texi.
+
+2004-01-21  Marius Vollmer  <mvo@zagadka.de>
+
+       Added copyright notices to all TeXinfo files.
+       
+       * fdl.texi: New.
+       * guile.texi: Include it as an appendix.
+       * preface.texi: State that the manual is FDL.
+
+2004-01-20  Kevin Ryde  <user42@zip.com.au>
+
+       * preface.texi (Guile License): Note readline is GPL and manual has
+       its own copying terms.  Describe briefly what the licenses mean in
+       practice.
+
+       * scheme-scheduling.texi (Higher level thread procedures): In monitor,
+       don't let "newly created" suggest a mutex created on every evaluation.
+       Note what "monitor" means.
+
+       * slib.texi (SLIB): Note `system' redefined by (ice-9 slib).  Tweak
+       `require' example.
+
+2004-01-11  Kevin Ryde  <user42@zip.com.au>
+
+       * misc-modules.texi (Queues): New chapter.
+       * guile.texi (Top): Add it.
+       
+2004-01-09  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-compound.texi (Bit Vectors): Revise for clarity, following
+       report by Rouben Rostamian.  Remove #b() example, that syntax is not
+       accepted.
+
+2004-01-07  Marius Vollmer  <marius.vollmer@uni-dortmund.de>
+
+       * scheme-control.texi, scheme-io.tex, scheme-scheduling.texi:
+       Adapt to new 'frame' names.  Document scm_c_with_fluid,
+       scm_c_with_fluids, and scm_frame_fluid.
+
+2004-01-06  Marius Vollmer  <marius.vollmer@uni-dortmund.de>
+
+       * scheme-control.texi: Document scm_on_unwind_with_scm and
+       scm_on_rewind_with_scm.
+
+2004-01-05  Marius Vollmer  <mvo@zagadka.de>
+
+       * scheme-scheduling.texi: Document scm_with_[un]blocked_asyncs.
+
+       * scheme-io.texi: Document scm_with_current_<foo>_port.
+
+2004-01-03  Marius Vollmer  <mvo@zagadka.de>
+
+       * scheme-control.texi: Document the frames stuff and other random
+       changes.
+
+2004-01-04  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-scheduling.texi (Threads): Note Guile uses POSIX threads, for
+       concurrency and preemption.
+       (C level thread interface): Note periodic libguile call required for C
+       code in threads, add commented out reminders for SCM_TICK and
+       guile-mode, for when those features are ready.
+
+       * srfi-modules.texi (SRFI-1 Filtering and Partitioning): For partition
+       and partition!, emphasise the multi-value return, note partition may
+       share a tail with the given list.
+
+       * srfi-modules.texi (SRFI-1 Searching, SRFI-1 Deleting, SRFI-1
+       Association Lists): Note how member, delete, delete! and assoc extend
+       the corresponding core functions.
+
+2003-11-25  Kevin Ryde  <user42@zip.com.au>
+
+       * tools.texi (Macros guile-snarf recognizes): Correction to GOOPS
+       cross reference.
+
+2003-11-19  Marius Vollmer  <mvo@zagadka.de>
+
+       * scheme-data.texi: Include exact rationals.
+
+       From Stephen Compall.  Thanks!
+       
+        * intro.texi (What is Guile?): Add @acronym for POSIX, R5RS, GUI,
+       and HTTP.  Conclude linking libguile.  Say what one can find *for*.
+
+        * preface.texi (Manual Conventions): Double-quote some statements
+       formerly single-quoted.  Remove some redundant quotes around code.
+       Clarify meaning of `iff' further for those that didn't get it the
+       first time 'round (like me).  Make graphical indicators samples,
+       not code.  Put results of evaluation on the same line as @result
+       symbols.  Use @print example as example of total usage, and remind
+       readers not to forget the difference.
+
+2003-11-17  Marius Vollmer  <mvo@zagadka.de>
+
+       * scheme-modules.texi: Document '@' and '@@'.
+
+       * scripts.texi: Mention that "-e (@ ...)" also works.
+
+2003-11-15  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-data.texi (Random): Add *random-state* variable, put note at
+       the top of the node about it being the default, rather than just in
+       the description of random.
+
+2003-11-13  Marius Vollmer  <mvo@zagadka.de>
+
+       * preface.texi (Manual Layout): Wrap POSIX, API, and SLIB in
+       @acronym.  Change from paragraph format (somewhat clumsy-looking
+       on paper, at least) to @table format, with headers @strong.  Made
+       example modules complete sentences.  From Stephen Compall, thanks!
+
+2003-11-09  Kevin Ryde  <user42@zip.com.au>
+
+       * misc-modules.texi (Pretty Printing): Add new keyword options, break
+       example to avoid long line.
+
+       * scheme-data.texi (Random): In random, use @code for *random-state*.
+       Reported by Stephen Compall.
+
+       * srfi-modules.texi (SRFI-1 Filtering and Partitioning): Move filter
+       and filter! ...
+       * scheme-compound.texi (List Modification): ... to here, now that
+       they're implemented in the core.
+
+2003-11-03  Kevin Ryde  <user42@zip.com.au>
+
+       * misc-modules.texi (File Tree Walk): New chapter.
+       * guile.texi: Add it.
+
+2003-10-18  Kevin Ryde  <user42@zip.com.au>
+
+       * gh.texi (Calling Scheme procedures from C, scm transition summary):
+       Refer to scm_list_n, not the old name scm_listify.
+       (scm transition summary): For gh_apply, recommend scm_apply_0, which
+       is now documented.
+
+       * gh.texi (Defining new Scheme procedures in C): Don't use
+       @strong{Note:}, latest makeinfo will complain it looks like a cross
+       reference.
+
+       * posix.texi (Time): Correction to strftime glibc cross reference
+       node, now "Formatting Calendar Time".
+
+       * srfi-modules.texi (SRFI-1 Searching): In break, note conflict with
+       binding established by `while'.
+
+2003-10-09  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-compound.texi (Hash Table Reference): Decribe rehashing, note
+       no hashx-remove!, describe make-hash-table size parameter.
+
+2003-10-06  Marius Vollmer  <mvo@zagadka.de>
+
+       * scheme-memory.texi: Added a short explanation of the GC and the
+       conservative stack scanning.
+       (scm_gc_protect_object, scm_gc_unprotect_object,
+       scm_permanent_object): New.
+
+       * data-rep.texi, scheme-memory.texi (scm_remember_upto_here_1,
+       scm_remember_upto_here_2): Moved from data-rep.texi to
+       scheme-memory.texi.
+       
+2003-10-02  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-io.texi (String Ports): In call-with-output-string, note proc
+       should not close the port.  In get-output-string, note string must be
+       gotten before closing the port.
+
+2003-09-21  Kevin Ryde  <user42@zip.com.au>
+
+       * posix.texi (File System): In access?, reword a bit, clarify real
+       versus effective ID handling, cross reference glibc on that, and
+       recommend against access tests in library functions.
+
+2003-09-13  Kevin Ryde  <user42@zip.com.au>
+
+       * posix.texi (File System): In stat:dev and stat:mode, clarify that
+       both are numbers.
+
+       * posix.texi (Network Address Conversion): Under IPv4, describe
+       numeric representation in Guile, add INADDR_LOOPBACK and
+       INADDR_BROADCAST, add commented-out INADDR_NONE.
+
+       * scheme-compound.texi (Append/Reverse): Merge reverse and reverse!,
+       describe newtail parameter for reverse!, remove confusing caveat about
+       head becoming tail for reverse!.
+
+       * scheme-io.texi (Reading): In port-column, port-line,
+       set-port-column! and set-port-line!, port parameter must be given,
+       there's no default to current input.
+
+       * scheme-io.texi (Reading): Add scm_c_read.
+       (Writing): Add scm_c_write.
+
+       * srfi-modules.texi (SRFI-1 Constructors): Add list-copy.
+
+       * srfi-modules.texi (SRFI-19): Rewrite, adding descriptions of all
+       functions, and a bit of an introduction.
+
+2003-09-03  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-data.texi (Keyword Primitives): Add examples to
+       make-keyword-from-dash-symbol and keyword-dash-symbol.  Add
+       scm_c_make_keyword.
+
+       * scheme-data.texi (Symbol Primitives): In gensym, cross reference
+       uninterned symbols, use @w{} on " g" prefix to avoid any chance of a
+       line break obscuring it.
+
+2003-08-30  Kevin Ryde  <user42@zip.com.au>
+
+       * data-rep.texi (Remembering During Operations): Note
+       scm_remember_upto_here_1 applies only to C automatic variables.
+
+       * guile.texi: Move @contents to usual place after title page, and
+       after first menu since that looks nice in html.
+
+       * posix.texi (Ports and File Descriptors): In pipe PIPE_BUF, use
+       @defvar, reword a bit for clarity, cross reference glibc.
+
+       * posix.texi (Network Sockets and Communication): In socket, use
+       @defvar for protocol variables, cross reference for getprotobyname,
+       note it's usually connect and accept that establishes communication.
+
+       * posix.texi (Network Sockets and Communication): In socketpair,
+       clarify the return is a pair with ports in car and cdr, note
+       connection is full duplex, refer to socket for parameters, refer to
+       PF_UNIX rather than AF_UNIX.
+
+       * scheme-compound.texi (Append/Reverse): Merge append and append!,
+       shown parameters as lst1 ... lstN, describe list argument for
+       scm_append and scm_append_x and note that it's unmodified.
+
+       * scheme-compound.texi (Hash Table Reference): Add hashx- case
+       insensitive string example, add cross references to symbol-hash,
+       string-hash, string-hash-ci, and char-set-hash.
+
+       * scheme-control.texi (Multiple Values): In values, show args as "arg1
+       ... argN".  In scm_values, note args is a list and returned object
+       shares structure with it.
+
+       * scheme-control.texi (Catch): Add scm_internal_catch.
+       (Lazy Catch): Add scm_internal_lazy_catch.
+
+       * scheme-data.texi (Arithmetic): Use a table for scheme to C libm
+       equivalences, add C99 trunc.
+
+       * scheme-procedures.texi (Lambda): Note ". rest" list argument is
+       always newly created.
+
+       * srfi-modules.texi (SRFI-1 Association Lists): In alist-delete and
+       alist-delete!, note argument order for the equality calls per SRFI-1
+       spec.
+
+2003-08-26  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-data.texi (Scientific): Add two-argument atan.
+
+       * tools.texi (How guile-snarf works): Need @@ for texinfo in example.
+
+2003-08-17  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-compound.texi (Hash Table Reference): Collect up groups of
+       functions to avoid duplication.  Revise notes on hashx functions and
+       on vector implementation.  In make-hash-table, size is now optional.
+       Add hash-map and hash-for-each.
+
+2003-08-14  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-control.texi (while do): Update `while' for code rewrite, in
+       particular describe break and continue.
+
+2003-08-09  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-memory.texi (Memory Blocks): Add index entries for deprecated
+       scm_must_malloc and friends.
+
+2003-07-29  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-compound.texi (List Constructors): Remove scm_cons_star,
+       since it's not very helpful.
+
+       * scheme-utility.texi (Property Primitives): In primitive-property-ref,
+       note parameters to not-found-proc, use hyphens rather than underscores
+       for that parameter name.
+       In primitive-property-set!, VAL is the value parameter not CODE.
+
+2003-07-24  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-control.texi (Dynamic Wind): Untabify.
+       (Multiple Values): Use @result.
+       Reported by Stephen Compall <s11@member.fsf.org>.
+
+       * scheme-control.texi (Continuations): Rewrite with more detail.
+
+       * scheme-scheduling.texi (System asyncs): Add index entries for C
+       functions.
+
+       * scheme-scheduling.texi (Parallel Forms): New section.
+
+2003-07-18  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-compound.texi (List Constructors): In list, use "elem1
+       ... elemN".  Add scm_list_1, scm_list_2, scm_list_3, scm_list_4,
+       scm_list_5, scm_list_n.  Remove scm_list, since it's a no-op.
+       * guile.texi (nicode): New macro.
+
+        * scheme-evaluation.texi (Fly Evaluation): In apply, reword for
+        clarity, drop the "append" example.  Add scm_apply, scm_apply_0,
+        scm_apply_1, scm_apply_2, scm_apply_3.
+        Add scm_call_0, scm_call_1, scm_call_2, scm_call_3.
+        In apply:nconc2last, move down after "apply", reword for clarity, note
+        correspondence to apply params.
+
+       * srfi-modules.texi (SRFI-0): Add cond-expand index entry.
+       (SRFI-9): Add define-record-type index entry.
+
+2003-07-12  Kevin Ryde  <user42@zip.com.au>
+
+       * srfi-modules.texi (SRFI-1 Constructors): In iota, reword a bit for
+       clarity and add a couple of examples.
+
+2003-07-10  Kevin Ryde  <user42@zip.com.au>
+
+       * deprecated.texi (Deprecated): Add scm_remember.
+
+2003-06-22  Kevin Ryde  <user42@zip.com.au>
+
+       * data-rep.texi (Remembering During Operations): Refer to all "Guile
+       library functions" as provoking gc.
+
+2003-06-19  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-io.texi (File Ports): Describe call-with-input-file and
+       call-with-output-file together.  Describe with-input-from-file,
+       with-output-to-file and with-error-to-file together, and add that they
+       use dynamic-wind on the current port setting and keep the port open in
+       support of captured continuations.
+       (Closing): Describe close-input-port and close-output-port together,
+       tweak the wording slightly.
+
+2003-06-14  Kevin Ryde  <user42@zip.com.au>
+
+       * data-rep.texi (Vector Data): For SCM_VECTOR_BASE, SCM_STRING_CHARS
+       and SCM_SYMBOL_CHARS, cross reference "Remembering During Operations".
+
+       * scheme-data.texi (Arithmetic): round is to nearest even.
+
+2003-06-12  Kevin Ryde  <user42@zip.com.au>
+
+       * data-rep.texi (Remembering During Operations): New section.
+
+       * scheme-data.texi (Primitive Numerics): Add atan2, pow, asinh, acosh
+       and atanh to scheme<->C table.  Note asinh, acosh and atanh are C99,
+       and scm_asinh, scm_acosh and scm_atanh are equivalents.  Cross ref
+       glibc "Mathematics".  Reword this end part for clarity.
+
+       * scheme-memory.texi (Memory Blocks): Use {} around types for
+       @deftypefn, for correct name in indexes.
+       * scheme-utility.texi (C Hooks): Ditto.
+       * gh.texi (Scheme to C): Ditto.
+
+       * gh.texi (Scheme to C): In gh_scm2newstr, lenp is size_t* not int*.
+       This changed in guile 1.6, the docs weren't updated.
+
+2003-06-09  Marius Vollmer  <mvo@zagadka.de>
+
+       From Mike Gran <spikegran@earthlink.net>.  Thanks!
+
+        * preface.texi: Minor punctuation mistakes.  Hyphens should link
+       compound adjectives.  Commas should be placed after a "therefore"
+       that begins a sentence.  Commas should not be used to separate a
+       list of only 2 dependent clauses.
+
+2003-06-07  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-data.texi (Arithmetic): Cross reference glibc floor and ceil.
+
+2003-06-05  Kevin Ryde  <user42@zip.com.au>
+
+       * posix.texi (File System): stat:rdev and stat:blocks can return #f,
+       stat:blksize returns a sensible size if the field is not available.
+
+       * scheme-compound.texi (Array Mapping): Reword for clarity, and in
+       particular have the same parameter names in the text and prototypes.
+
+       * scheme-evaluation.texi (Delayed Evaluation): Add delay, reword
+       promise? and force a bit, describe recursive forcing of a promise by
+       its own code.
+
+       * scheme-io.texi (Ports): Add notes on garbage collection, and on
+       explicitly closing file ports.
+       (File Ports): Cross reference Ports node on explicit closing.
+
+       * posix.texi (Network Sockets and Communication): Cross reference
+       Ports node on explicit closing.
+
+       * scheme-scheduling.texi (Futures): New section.
+
+       * srfi-modules.texi (SRFI-13 Miscellaneous): In string-replace, note
+       that start1 and end1 optional is a Guile extension.
+
+2003-05-30  Kevin Ryde  <user42@zip.com.au>
+
+       * deprecated.texi: Add substring-move-left! and substring-move-right!.
+
+       * scheme-io.texi (Default Ports): Remove duplicate descriptions of
+       set-current-output-port and set-current-error-port.
+
+2003-05-27  Dirk Herrmann  <D.Herrmann@tu-bs.de>
+
+       * scheme-compound.texi: Clarified that vectors need to be quoted.
+
+2003-05-26  Kevin Ryde  <user42@zip.com.au>
+
+       * posix.texi (Locales): Clarify setlocale a bit, list all categories,
+       cross reference to libc.
+
+2003-05-24  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-procedures.texi: Add index entries lambda, optargs, syncase.
+
+       * scsh.texi (The Scheme shell (scsh)): Add index entries.
+
+2003-05-22  Kevin Ryde  <user42@zip.com.au>
+
+       * srfi-modules.texi (SRFI-2): Rewrite and-let*, describing plain
+       expression clauses and improving the examples.
+
+2003-05-17  Marius Vollmer  <mvo@zagadka.de>
+
+       * posix.texi (socket): Use PF_ instead of AF_ prefix.
+
+2003-05-16  Kevin Ryde  <user42@zip.com.au>
+
+       * guile.texi: Use @copying, show copyright and permissions at start of
+       info and html.
+
+       * srfi-modules.texi (SRFI-1 Deleting): Rewrite delete and
+       delete-duplicates, adding behaviour details specified by srfi-1.
+
+2003-05-12  Kevin Ryde  <user42@zip.com.au>
+
+       * preface.texi (Guile License): Refer to COPYING.LIB.
+
+       * repl-modules.texi (Loading Readline Support, Readline Options):
+       Index entries for readline functions.
+
+       * scheme-control.texi (Handling Errors): Fix regexp error key, should
+       be `regular-expression-syntax'.
+
+       * scheme-data.texi (Complex): Show z argument in prototypes.
+
+2003-05-10  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-data.texi (Reals and Rationals): Fix typo @result{#f}, and
+       put @result outside @code.
+
+       * scheme-data.texi (Bitwise Operations): Note negatives are treated as
+       infinite precision twos complement.  Revise `ash' to emphasise this
+       for right shifts of negatives.  Describe integer-length behaviour on
+       negatives.  Add `...' to logand, logior, logxor since they take
+       multiple parameters.
+       * guile.texi (m): New macro.
+
+       * scheme-control.texi (Handling Errors): Revise C support section to
+       get index entries, and clarify parameters.  Remove scm_regex_error, no
+       longer exists and wasn't available to applications.
+
+       * scheme-control.texi (Handling Errors): Index entries for error keys.
+
+2003-05-08  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-data.texi (Bitwise Operations): Fix lognot to ones-complement.
+
+       * slib.texi (JACAL): Fix @ref title.
+       Add index entries, use @file and @code variously.
+
 2003-05-06  Kevin Ryde  <user42@zip.com.au>
 
        * scheme-scheduling.texi (C level thread interface): Use @deftypefn