* Change R4RS references to R5RS.
[bpt/guile.git] / doc / ChangeLog
index 315fa2f..e941a0b 100644 (file)
@@ -1,5 +1,359 @@
+2001-04-22  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * scheme-io.texi: Remove old docstring comments referring to
+       r4rs.scm.
+
+       * appendices.texi (The Basic Guile Package, Packages not shipped
+       with Guile), env.texi (Switching to Environments), format.texi
+       (Format Specification), gh.texi
+       (Executing Scheme code, Calling Scheme procedures from C),
+       guile-tut.texi (How to characterize Guile), scheme-data.texi
+       (Symbols, Keywords, Keyword Read Syntax, Append/Reverse),
+       scheme-evaluation.texi (Delayed Evaluation), scheme-modules.texi
+       (Scheme and modules), scheme-io.texi (Soft Ports): Change R4RS
+       references to R5RS.
+
+       * r4rs.texi: Removed.
+       
+       * Makefile.am (info_TEXINFOS): Remove r4rs.
+
+       * README: Note removal of r4rs, and provide a reference.
+
+       * scheme-control.texi (Exceptions): Extended documentation.
+       (Continuations): Correct "except" typo, and fix reference to
+       Exceptions node.  Plus minor review changes.
+
+2001-04-20  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * scheme-control.texi (Exceptions): Reorganized and extended
+       existing documentation; more to come.
+
+2001-04-20  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-evaluation.texi (Comments): Document normal comments and
+       comment conventions.
+       (Block Comments): Documented multiline comments.
+       (Case Sensitivity): Documented R5RS and Guile behaviour and how to
+       switch it off.
+
+       * scheme-control.texi (Continuations): Added some documentation
+       for call/cc.
+       (Exceptions): Added xref to `Continuations'.
+
+       * scheme-binding.texi (Binding Reflection): Typo fix.
+
+2001-04-20  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * gh.texi (Executing Scheme code): gh_eval_file returns
+       SCM_UNSPECIFIED.  Thanks to Dirk for the report!
+
+       * data-rep.texi (Non-immediate Datatypes, Immediates vs
+       Non-immediates): Emphasize current rather than pre-1.4 practice
+       when talking about not needing to call SCM_NIMP.
+
+       * recipe-guidelines.txt: New file: guidelines for contributions to
+       the Guile Recipes manual.
+
+2001-04-20  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * intro.texi (Using Guile Modules): Wrote intro to using modules.
+       (Writing New Modules): New intro for writing modules.
+       (Reporting Bugs): Added info about what is a bug and what to
+       include in a bug report (taken and adapted from the Emacs
+       Reference Manual).
+
+2001-04-19  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-control.texi (while do): Added documentation for named
+       let.
+
+       * scheme-binding.texi (Internal Definitions): New explanation of
+       `Internal Definitions'.
+       (Top Level): Documented behaviour of top level definitions.
+       (Binding Constructs): New introductory text.
+       (Local Bindings): Explain concept of local bindings.  Document
+       let, let* and letrec.
+
+2001-04-18  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-modules.texi (Modules): Added menu descriptions.
+       (Scheme and modules, The Guile module system): Some whitespace
+       cleanup
+       (The Guile module system): Layout fixes, docstring fix for
+       `define-module'.
+
+2001-04-17  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-control.texi (Multiple Values): Documented concept of
+       multiple values, added docs for `receive'.
+       (begin): Documented `begin'.
+       (if cond case): Documented `if', `cond' and `case'.
+       (and or): Documented `and' and `or'.
+       (while do): Documented `do' and `while'.
+
+       * scheme-procedures.texi (Optional Arguments): Split the node,
+       added introductory text, added menu for subsections.
+       (let-optional Reference, let-keywords Reference),
+       (lambda* Reference, define* Reference): Added syntax documentation
+       for all exported procedures from (ice-9 optargs).
+
+2001-04-17  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-utility.texi (General Conversion): New node, added
+       `object->string'.
+       (Equality): Added definition and explanation of `sameness'.
+
+       * posix.texi (System Identification): Added `gethostname' and
+       `sethostname'.
+       (Processes): Added `setpriority' and `getpriority'.
+       (User Information): Added `cuserid' and `getlogin'.
+       (Ports and File Descriptors): Added `flock'.
+       (Processes): Added `chroot'.
+       (File System): Added `mkstemp!'.
+       (Encryption): New node, added `crypt' and `getpass'.
+
+       * new-docstrings.texi: Moved several docstrings over to the
+       reference manual (see above which).
+
+       * scheme-data.texi (Data Types), (Numerical Tower): Add explicit
+       @bullet to @itemize to satisfy older `makeinfo'.
+
+2001-04-16  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * data-rep.texi (Signalling Type Errors):  Update SCM_ASSERT doc
+       for recent changes to disallow passing a string parameter as the
+       `pos'.  Thanks to Dirk Herrmann for the patch!
+
+2001-04-13  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * data-rep.texi (Unpacking the SCM type): New section, taken from
+       Dirk Herrmann's description of SCM and scm_bits_t in api.txt.
+       (Immediate Datatypes, Non-immediate Datatypes): Remove obsolete
+       notes about needing to call SCM_NIMP.
+
+2001-04-11  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * scheme-procedures.texi (Procedures with Setters):  Fix dvi
+       building syntax error.  Thanks to Dale P. Smith for the report and
+       patch.
+
+2001-04-11  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-scheduling.texi (Arbiters): New explanatory text.
+       (Asyncs): New explanations and documentation.
+       (Scheduling): Added menu entry descriptions.
+       (Fluids): New documentation.
+
+2001-04-11  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-procedures.texi (Lambda): Documented the lambda form.
+       (Procedure Properties): Concept and usage explanation added.
+       (Procedures with Setters): Explain by example, introduce
+       definitions.
+
+       * scheme-data.texi (Symbols and Variables): Split and reorganized
+       this section.
+       (Symbols): New introductory text.
+       (Characters): Added char-ci* procedures to rn index.
+
+2001-04-10  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * scm.texi (Handling Errors):  Improve Texinfo markup.  Thanks to
+       Dale P. Smith for the patch!
+
+       * api.txt (Accessing Cell Entries): Fix typo.
+
+2001-04-09  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * deprecated.texi (Shared And Read Only Strings): New section for
+       deprecated string stuff.  I've also updated the text a bit to
+       reflect current usage of "read only" strings.
+
+       * scheme-data.texi (Shared Substrings, Read Only Strings): Moved
+       to deprecated.texi.
+
+       * deprecated.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-modules.texi, scheme-options.texi, scheme-procedures.texi,
+       scheme-scheduling.texi, scheme-translation.texi,
+       scheme-utility.texi: Remove `@c docstring' comments, since they
+       aren't used any more by the docstring tracking utilities.
+
+2001-04-09  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-data.texi (Pairs): New data type and procedure
+       description.
+       (Lists): Added new subsections for grouping the list procedures.
+       (Hooks): Added new nodes for hook subsections.
+       (String Syntax): New node, factoring out read syntax.
+       (Strings): Some blurb about allowed characters, zero-termination
+       etc.
+       (Keywords): Added menu descriptions.
+
+2001-04-08  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-indices.texi (R5RS Index): Print index `rn', not `r5'.
+
+       * guile.texi: The index formerly known as `r5' is now called `rn'.
+
+       * scheme-utility.texi, scheme-procedures.texi, scheme-io.texi,
+       scheme-evaluation.texi, scheme-control.texi, scheme-data.texi:
+       Changed all @r5index entries to @rnindex.
+
+2001-04-06  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-data.texi (Hooks): Added hook description and
+       constraints.
+
+2001-04-06  Thien-Thi Nguyen  <ttn@revel.glug.org>
+
+       * scheme-scheduling.texi (Higher level thread
+       procedures): Replace some instances of `@var' with `@code'.
+
+       * scheme-scheduling.texi (Higher level thread
+       procedures): Rewrite.
+
+2001-04-04  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-data.texi (Alphabetic Case Mapping),
+       (String Comparison): Rearranged function order.
+       (Vectors): Reorganized, new introductory text, docs about read
+       syntax.
+
+2001-04-03  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-options.texi, scheme-procedures.texi,
+       scheme-modules.texi, scheme-memory.texi, scheme-control.texi,
+       scheme-utility.texi, scheme-io.texi, scheme-evaluation.texi,
+       scheme-data.texi: Removed a lot of ARGFIXME's after tweaking
+       docstrings and C source.
+
+       * new-docstrings.texi, scheme-io.texi, scheme-data.texi,
+       posix.texi, scheme-control.texi, scheme-evaluation.texi,
+       scheme-memory.texi, scheme-procedures.texi, scheme-modules.texi,
+       scheme-scheduling.texi: Automated docstring merging.
+
+2001-04-02  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * data-rep.texi (Immediates vs. Non-immediates): Update
+       out-of-date documentation.  (Thanks to Dirk Herrmann for the
+       report!)
+       (Immediates vs Non-immediates): Renamed without the dot, since the
+       dot causes `info' not to be able to display this node!
+
+       * Makefile.am (guile_TEXINFOS): Add in a few more source files
+       that had got left out.
+
+2001-03-30  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * scheme-reading.texi (Further Reading): Add bullets to further
+       reading list.
+
+       * gh.texi: Insert page break before chapter.  Remove page breaks
+       within the chapter.
+
+       * Makefile.am: Add script-getopt.texi.
+
+       * guile.texi (Top): Include and link to new script-getopt.texi
+       chapter.
+
+       * script-getopt.texi: New chapter on command line handling.
+       (Written and contributed by Martin Grabmueller, revised by me.)
+
+       * intro.texi (Modules and Extensions): Fix typo.
+
+2001-03-27  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-data.texi (Strings): Reorganized the whole `Strings'
+       section and wrote introductory material for each new subsection.
+
+2001-03-25  Marius Vollmer  <mvo@zagadka.ping.de>
+
+       * intro.texi (Modules and Extensions): Some short text about
+       dynamic libraries and modules.
+
+2001-03-23  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * intro.texi (Writing Extensions for Guile), scheme-data.texi
+       (Lists): Fix typos.
+
+       * guile-tut.texi, ChangeLog-guile-doc-tutorial: Added to CVS.  It
+       seems that I somehow missed these out when I moved everything from
+       guile-doc to guile-core.
+
+       * posix.texi, scheme-data.texi, scheme-evaluation.texi,
+       scheme-io.texi, scheme-memory.texi: Automatic docstring updates.
+
+       * new-docstrings.texi: New file.  Holds snarfed docstrings that
+       have not yet been incorporated into the reference manual.
+
+2001-03-20  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-options.texi (Evaluator options): Added evaluator
+       options, corrected docs for evaluator trap options.
+
+       * scheme-evaluation.texi (Scheme Read): New docs for read-options,
+       read-enable, read-disable and read-set! and cross references to
+       option nodes.
+       (Evaluator Options): New docs for eval-options, eval-enable,
+       eval-disable and eval-set!, traps, trap-enable, trap-disable and
+       trap-set! and cross references to option nodes.
+       (Evaluator Behaviour): Renamed node from `Evaluator options' to
+       avoid name clash.
+
+       * scheme-io.texi (String Ports): Added docs for SRFI-6 procedures.
+       (Void Ports): Corrected introductory comment.
+
+2001-03-16  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>
+
+       * scheme-data.texi (Arithmetic): Documented the arithmetic
+       procedures.
+       (Integer Operations): Added documentation.
+       (Comparison): Added documentation.
+       (Complex): Added documentation.
+       (Symbols and Variables): Comment out `builtin-bindings', which is
+       removed according to NEWS.
+       (Pairs): Added documentation.
+
+       * scheme-io.texi: Added R5RS index entries for all R5RS
+       procedures.
+       (File Ports): New docs for `call-with-input-file',
+       `call-with-output-file', `with-input-from-file',
+       `with-output-to-file', `with-error-to-file'.
+
+       * scheme-control.texi, scheme-utility.texi,
+       * scheme-procedures.texi: Added R5RS index entries for all R5RS
+       procedures.
+
+       * scheme-evaluation.texi (Fly Evaluation): Added documentation for
+       `apply'.  Added R5RS index entries for all R5RS procedures.
+
+       * scheme-data.texi: Added R5RS index entries for all R5RS
+       procedures.  Removed R5RS index entries for `ass{q,v,occ}-set!'.
+       Removed explicit entries into the function entries.  They are
+       automagic.
+       (Vectors): Added documentation for `make-vector', `vector-ref' and
+       `vector-set!'.
+
+2001-03-12  Marius Vollmer  <mvo@zagadka.ping.de>
+
+       * intro.texi: Changed to reflect current practice better.  Added
+       stuff about writing Guile Extensions (aka dynamically loaded
+       shared libraries).
+
+2001-03-09  Mikael Djurfeldt  <mdj@linnaeus.mit.edu>
+
+       * goops.texi (VERSION): Bumped to version 0.3.
+
+       * goops-tutorial.texi, goops.texi: Updated to reflect new
+       define-method syntax.
+
 2001-03-09  Neil Jerram  <neil@ossau.uklinux.net>
 
+       * Makefile.am: Change HTML to HTMLDOC, now that we're part of a
+       wider distribution.
+
        Moving documentation files from guile-doc and guile-doc into
        guile-core/doc:
 
        * .cvsignore, Makefile.am, README: Merged.
 
        * sources: New subdirectory.
-       
+
        Both the following files are about to be replaced by files from
        guile-doc/ref.
-       
+
        * texinfo.tex: Removed.
 
        * data-rep.texi: Removed.
 
        * data-rep.texi (Garbage Collection): Fix "accomodate" spelling
        mistake.
-       
+
 2000-06-30  Dirk Herrmann  <D.Herrmann@tu-bs.de>
 
        * data-rep.tex:  Removed documentation for SCM_OUTOFRANGE.
@@ -115,7 +469,7 @@ Fri Jun 25 22:21:43 1999  Greg Badros  <gjb@cs.washington.edu>
        * data-rep.texi: Updated SMOB docs to talk about
        scm_make_smob_type_mfpe, SCM_RETURN_NEWSMOB, SCM_NEWSMOB function
        and macros.
-       
+
 1999-04-17  Jim Blandy  <jimb@savonarola.red-bean.com>
 
        * Makefile.in: Regenerated.
@@ -145,7 +499,7 @@ Fri Jun 25 22:21:43 1999  Greg Badros  <gjb@cs.washington.edu>
        * Makefile.am (EXAMPLE_SMOB_FILES, dist-hook): New variable and
        target, to get the example-smob directory into the distribution.
        * Makefile.in: Regenerated.
-       
+
 1998-10-08  Jim Blandy  <jimb@zwingli.cygnus.com>
 
        * .cvsignore: New file, containing data-rep.info.  I'm not sure