*** empty log message ***
[bpt/guile.git] / doc / ref / ChangeLog
index 46204f0..25e9647 100644 (file)
@@ -1,5 +1,558 @@
+2003-11-09  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-data.texi (Random): In random, use @code for *random-state*.
+       Reported by Stephen Compall.
+
+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
+       not @deftypefun, to get function names (not types) indexed.
+
+       * scheme-options.texi (Build Config): Add index entries for
+       %guile-build-info keys.
+
+2003-05-04  Kevin Ryde  <user42@zip.com.au>
+
+       * scheme-data.texi (Integer Operations): Describe how quotient,
+       remainder and modulo round their results.
+
+       * scheme-io.texi (Reading): In read-char and peek-char, fix typos "?"
+       in @rnindex.  In port-column, use @: after i.e.  
+       (Writing): In get-print-state, two spaces after full stop.  Add write,
+       revise display.
+
+       * srfi-modules.texi (SRFI-1 Length Append etc): Add count.
+       (SRFI-1 Fold and Map): In reduce, fix typo "... variant of fold", add
+       "f" to fold call shown.  In reduce-right, use @code on "reduce".
+
+       * data-rep.texi, gh.texi: Add spaces after some @defun names.
+       * posix.texi (Processes): Fix typo "hhhh".
+
+2003-05-01  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * posix.texi: Add index entries for many variables and functions,
+       either using @defvar/@deffn or @vindex/@pindex.  (Patch supplied
+       by Kevin Ryde.)
+
+2003-04-30  Marius Vollmer  <marius.vollmer@uni-dortmund.de>
+
+       * posix.texi (scm_c_port_for_each): Added. 
+
+2003-04-26  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * scheme-data.texi (Symbol Primitives): Document scm_str2symbol
+       and scm_mem2symbol.
+
+       * data-rep.texi (Describing a New Type): Clarify that
+       scm_make_smob_type_mfpe is deprecated.  (Thanks to
+       tomas@fabula.de.)
+
+       * scheme-control.texi (Handling Errors): Remove scm_sysmissing,
+       long since gone from libguile.  (Thanks to Kevin Ryde.)
+
+2003-04-05  Marius Vollmer  <mvo@zagadka.de>
+
+       * preface.texi: Reflect change to LGPL.
+
+2003-03-27  Rob Browning  <rlb@defaultvalue.org>
+
+       * scheme-io.texi (Reading): clarify character ordering in port for
+       unread-string.
+
+2003-03-07  Rob Browning  <rlb@defaultvalue.org>
+
+       * guile.texi: change MANUAL_EDITION to MANUAL-EDITION so we don't
+       choke TeX (thanks to Dale P. Smith).
+
+       * preface.texi: change MANUAL_EDITION to MANUAL-EDITION so we
+       don't choke TeX (thanks to Dale P. Smith).
+
+2003-01-02  Mikael Djurfeldt  <djurfeldt@nada.kth.se>
+
+       * scheme-scheduling.texi (Low level thread primitives): Fixed typo
+       in broadcast-condition-variable.
+
+2002-12-08  Rob Browning  <rlb@defaultvalue.org>
+
+       * scheme-options.texi (Build Config): add effective-version docs.
+
+2002-11-17  Neil Jerram  <neil@ossau.uklinux.net>
+
+       Applied patches from Stephen Compall as follows.  (Thanks!)
+
+       2002-11-06  Stephen Compall  <rushing@sigecom.net>
+
+       * posix.texi: Changed quotes to match Texinfo expectations.
+
+        Added references to the glibc manual.
+
+        Used proper Texinfo text marking for many keywords, such as @code,
+       @samp, @env, @var.
+
+        Fixed argument metasyntactic variable references in
+       file-manipulation section so the usage in the descriptions matches
+       the usage in the declarations.
+
+       2002-10-26  Stephen Compall  <rushing@sigecom.net>
+
+       * scheme-data.texi: Addition and change of many Texinfo tags,
+       particularly usage of @var and @samp, as well as reformatting of
+       some lists into tables and usage of @result.
+
+       Notes about some things I didn't understand, as well as a
+       missing section on non-control characters.
+
+2002-10-27  Gary Houston  <ghouston@arglist.com>
+
+       * scheme-modules.texi (Environments): only available when
+       (ice-9 r5rs) is used.
+       * scsh.texi (The Scheme shell (scsh)): current url is www.scsh.net.
+
+2002-10-27  Marius Vollmer  <mvo@zagadka.ping.de>
+
+       * scheme-scheduling.texi: Updated mutex and condition varable
+       functions.
+
+2002-10-27  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * debugging.texi (Debugging Features): Rewritten.
+
+2002-10-19  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * new-docstrings.texi, scheme-binding.texi, scheme-io.texi,
+       scheme-scheduling.texi, posix.texi: Automatic docstring updates.
+
+2002-10-14  Marius Vollmer  <mvo@zagadka.ping.de>
+
+       * intro.texi (Whirlwind Tour): Added pointer to examples
+       directory.
+
+2002-10-10  Marius Vollmer  <mvo@zagadka.ping.de>
+
+       * scheme-scheduling.texi (System Asyncs): Updated.
+
+2002-10-07  Marius Vollmer  <mvo@zagadka.ping.de>
+
+       * scheme-scheduling.texi (Asyncs): Updated.
+       * posix.texi (sigaction): Updated.
+
+2002-10-03  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * posix.texi (Processes), scheme-options.texi (Common Feature
+       Symbols): Refer to provided?  rather than deprecated feature?.
+
+2002-10-03  Marius Vollmer  <mvo@zagadka.ping.de>
+
+       * tools.texi (How guile-snarf works): Updated.
+       (Writing your own snarfing macros): New.
+
+2002-09-25  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * scheme-debug.texi (Debugging): Make sections into nodes.
+       (Debugging Options): Node removed.
+
+       * scheme-options.texi (Feature Tracking): Brought forward before
+       sections on options.
+       (Runtime Options): New section, to group options-related nodes.
+
+2002-09-24  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * scheme-options.texi (Options and Config): Chapter name changed,
+       and intro text improved.
+       (Install Config): Brought forward, and renamed Build
+       Configuration.
+
+       The following doc updates are from Ian Sheldon - thanks!
+       
+       * scheme-data.texi (Appending Strings, Regexp Functions, Match
+       Structures): Add examples.
+       (Regular Expressions): Add instruction to use (ice-9 regex)
+       module.
+
+       * slib.texi (SLIB): Remove duplicate `the'.
+
+2002-09-22  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * scheme-options.texi (General option interface): Mention
+       eval-options-interface and debug-options-interface.
+
+       * scheme-debug.texi (Debugging): New node describing source
+       properties.
+
+2002-09-19  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * scheme-utility.texi (Hook Reference): Improvements to hook docs.
+       Thanks to Thien-Thi Nguyen for the patches.
+
+2002-09-16  Marius Vollmer  <mvo@zagadka.ping.de>
+
+       * scheme-data.texi (Symbol Props): It's "set-symbol-property!",
+       not "set-symbol-property".  Thanks to Pieter Pareit!
+
+2002-09-15  Marius Vollmer  <mvo@zagadka.ping.de>
+
+       * scheme-data.texi: Tell them to use 'provided?' instead of
+       '*feaures*'.
+
 2002-09-09  Marius Vollmer  <mvo@zagadka.ping.de>
 
+       * scheme-ideas.texi (Creating a Procedure): Fixed typo.  Thanks to
+       Pieter Pareit!
+
        * intro.texi: Updated GNu ftp server name.  Use "-lguile" instead
        of "libguile.a".  Some small fixes/improvements.