Improve docs on symbols.

[bpt/guile.git] / doc / ref / ChangeLog

2002-04-01  Neil Jerram  <neil@ossau.uklinux.net>

	* scheme-data.texi (Symbols): Reorganized node substructure and
	added lots of explanatory text around the @deffn's.

2002-03-29  Neil Jerram  <neil@ossau.uklinux.net>

	* scheme-modules.texi (Variables): Mention obarrays.

	* scheme-data.texi (Symbol Tables, Symbol Props): Remove vgone
	markers for deprecated symbol items.
	(Symbol Props): Remove doc for obsolete 2 arg version of
	symbol-interned?.
	(String Miscellanea): Removed, since it only contained duplicate
	doc for string-ci->symbol.
	(Symbol Tables): Move doc for gensym to Symbol Primitives; rest of
	section removed.

	* posix.texi (Ports and File Descriptors), scheme-evaluation.texi
	(Fly Evaluation): Remove vgone markers for close-all-ports-except,
	eval2 and read-and-eval!.

	* data-rep.texi (Describing a New Type), scheme-compound.texi
	(Append/Reverse), scheme-procedures.texi (Internal Macros):
	Trivial updates to sync with stable branch.

2002-03-27  Neil Jerram  <neil@ossau.uklinux.net>

	* scheme-compound.texi (List Searching): Remove docs for
	`scm_sloppy_mem*', which no longer exist.

2002-03-24  Neil Jerram  <neil@ossau.uklinux.net>

	* guile.texi (Top), intro.texi (What is Guile?, The Basic Guile
	Package): Use @ifnottex instead of @ifinfo, so that HTML
	generation works correctly.

2002-03-24  Marius Vollmer  <mvo@zagadka.ping.de>

	* tools.texi: Updated to reflect changes to the guile-snarf tool.

2002-03-16  Neil Jerram  <neil@ossau.uklinux.net>

	* scheme-utility.texi (Hooks): Further updates.  New material on
	GC hooks.
	
	* scheme-evaluation.texi (Fly Evaluation): Note disappearance of
	eval2 and read-and-eval!.

	* deprecated.texi (Deprecated): Remove docs about previously
	deprecated items that have now been removed.

2002-03-15  Thien-Thi Nguyen  <ttn@giblet.glug.org>

	* tools.texi (guile-1.4 guile-snarf): Remove this node.
	(How guile-snarf works): Update usage and description to
	no longer mention "--compat=1.4" and instead "-d" and "-D".
	(Macros guile-snarf recognizes): Add list of deprecated macros
	and blurb.  Add cindex for deprecated macros.

2002-03-15  Neil Jerram  <neil@ossau.uklinux.net>

	* scheme-utility.texi (Hooks): Reviewed and updated.

	* scheme-options.texi (Feature Tracking): New section.

	* scheme-data.texi (Arithmetic, Primitive Numerics): Add
	description of corresponding C functions.

	* scheme-utility.texi (Object Properties): Revamp documentation on
	object properties.

	* scheme-memory.texi (Weak References): Update reference to Object
	Properties node.

	* guile.texi: Add macros for describing version information.

	* scheme-data.texi, scheme-debug.texi, scheme-io.texi,
	scheme-procedures.texi: Automatic updates from snarfed libguile
	docstrings.

2002-03-13  Thien-Thi Nguyen  <ttn@giblet.glug.org>

	* Makefile.am (guile_toc.html): Look for guile.texi in $(srcdir).

	* tools.texi (How guile-snarf works): Mention "--compat=1.4", and
	new processing steps.  Update usage example, makefile frag.

	(guile-1.4 guile-snarf): New subsubsection under
	"Init Snarfing with guile-snarf".

2002-03-12  Neil Jerram  <neil@ossau.uklinux.net>

	* scheme-compound.texi, scheme-data.texi, new-docstrings.texi:
	Automatic updates from snarfed libguile docstrings.

	* data-rep.texi, guile.texi, scheme-evaluation.texi,
	scheme-options.texi, scheme-translation.texi: Various minor
	enhancements ported from the stable CVS branch.

2002-03-08  Thien-Thi Nguyen  <ttn@giblet.glug.org>

	* tools.texi (Miscellaneous Tools): New node/chapter.
	(Snarfing, Init Snarfing with guile-snarf, How guile-snarf works,
	Macros guile-snarf recognizes, Doc Snarfing): New nodes/(sub)sections.
	(Executable Modules): Now a section under "Miscellaneous Tools".

	* guile.texi (Miscellaneous Tools): Add under "Part II".
	Implement by including tools.texi.

	* Makefile.am (guile_TEXINFOS): Add tools.texi.

2002-03-07  Thien-Thi Nguyen  <ttn@giblet.glug.org>

	* tools.texi: New file.

2002-03-03  Neil Jerram  <neil@ossau.uklinux.net>

	* autoconf.texi (Autoconf Background): Insert missing `of'.

2002-03-01  Dirk Herrmann  <D.Herrmann@tu-bs.de>

	* api.txt, data-rep.texi: Renamed the struct scm_cell to
	scm_t_cell.

	* data-rep.texi: Renamed scm_alloc_cell to scm_cell and
	scm_alloc_double_cell to scm_double_cell.

2002-03-01  Marius Vollmer  <mvo@zagadka.ping.de>

	* scheme-memory.texi (Upgrading from scm_must_malloc et al): New
	section.

2002-02-28  Marius Vollmer  <mvo@zagadka.ping.de>

	* data-rep.texi: Use scm_gc_malloc and scm_gc_free instead of
	scm_must_malloc and free in example code.  Updated text for the
	new memory management functions.

	* scheme-debug.texi (malloc-stats): Refer to scm_gc_malloc instead
	of to scm_must_malloc.

2002-02-27  Stefan Jahn  <stefan@lkcc.org>

	* gh.texi (scm transition summary): Documented some more
	gh equivalents and removed appropriate FIXME's.

2002-02-26  Thien-Thi Nguyen  <ttn@giblet.glug.org>

	* Makefile.am: Update path to pre-inst-guile automake frag.

2002-02-24  Rob Browning  <rlb@defaultvalue.org>

	* .cvsignore: add autoconf-macros.texi.

	* Makefile.am (CLEANFILES): add autoconf-macros.texi.

2002-02-19  Marius Vollmer  <mvo@zagadka.ping.de>

	* scheme-memory.texi (Memory Blocks): New section.

2002-02-05  Thien-Thi Nguyen  <ttn@giblet.glug.org>

	* Makefile.am: Include $(top_srcdir)/pre-inst-guile.am.

	(GUILE): Delete var.
	(autoconf-macros.texi): Use $(preinstguiletool).

2002-02-04  Thien-Thi Nguyen  <ttn@giblet.glug.org>

	* autoconf.texi (Autofrisk, Using Autofrisk): New sections.
	(Autoconf Support): Add new sections to menu.

2002-02-04  Marius Vollmer  <marius.vollmer@uni-dortmund.de>

	* scheme-data.texi (Symbol Uninterned): Added node.

2002-01-29  Stefan Jahn  <stefan@lkcc.org>

	* gh.texi (scm transition summary): Documented gh equivalents
	`scm_c_string2str', `scm_c_substring2str' and `scm_c_symbol2str'
	and removed the appropriate FIXME's.

2002-01-14  Marius Vollmer  <marius.vollmer@uni-dortmund.de>

	* Makefile.am (autoconf-macros.texi):  Also set GUILE_LOAD_PATH
	when invoking the uninstalled guile executable.

2002-01-09  Thien-Thi Nguyen  <ttn@giblet.glug.org>

	* Makefile.am (autoconf-macros.texi): Fix build bug:
	Write this file to srcdir.  Thanks to I. N. Golubev.

2002-01-08  Gary Houston  <ghouston@arglist.com>

	* Makefile.am: attempt to use guile from $(top_builddir)/libguile
	when building autoconf-macros.texi.  There are still problems with
	modules and running makeinfo when builddir != srcdir.

2002-01-08  Thien-Thi Nguyen  <ttn@giblet.glug.org>

	* data-rep.texi, gh.texi, guile.texi, intro.texi,
	misc-modules.texi, new-docstrings.texi, posix.texi, program.texi,
	repl-modules.texi, scheme-binding.texi, scheme-compound.texi,
	scheme-control.texi, scheme-data.texi, scheme-debug.texi,
	scheme-ideas.texi, scheme-io.texi, scheme-memory.texi,
	scheme-modules.texi, scheme-procedures.texi,
	scheme-translation.texi, scheme-utility.texi, scm.texi, slib.texi,
	srfi-modules.texi: Spell check.  Thanks to Fabrice Bauzac.

2002-01-07  Neil Jerram  <neil@ossau.uklinux.net>

	* intro.texi (Linking Programs With Guile): Fix typo (superfluous
	`do').  Thanks to Fabrice Bauzac.

2002-01-05  Thien-Thi Nguyen  <ttn@giblet.glug.org>

	* intro.texi: Spell check.  Thanks to Fabrice Bauzac.

2002-01-02  Thien-Thi Nguyen  <ttn@giblet.glug.org>

	* guile.texi (Part II): Add "Autoconf Support"; include
	autoconf.texi.

	* Makefile.am (guile_TEXINFOS): Add autoconf.texi and
	autoconf-macros.texi.
	(autoconf.texi, autoconf-macros.texi): New rules.

	* autoconf.texi: New file.

2001-12-22  Marius Vollmer  <mvo@zagadka.ping.de>

	* scheme-compound.texi (Alist Example): Changed "Bismarck" to
	"Pierre".  Thanks to Ron Peterson!

2001-12-22  Neil Jerram  <neil@ossau.uklinux.net>

	* program.texi (Programming Overview): Chapter renamed from
	`Programming Options'; some new material added.

2001-12-07  Neil Jerram  <neil@ossau.uklinux.net>

	* scm.texi (Guile API): Renamed from `Scheme Primitives' and
	broadened so that this chapter discusses the Guile API as a whole.

	* program.texi (Available Functionality): Revise so that text
	reads better.

	* guile.texi (Programming Intro): New introductory text.

	* scheme-ideas.texi (Definition): Reorder reference bullets in
	ascending page number order.

2001-12-04  Martin Grabmueller  <mg@glug.org>

	* scheme-procedures.texi (Optional Arguments): Typo fix: wither ->
	either.

2001-12-01  Neil Jerram  <neil@ossau.uklinux.net>

	* scheme-data.texi (Hooks): Moved into scheme-utility.texi.

	* Makefile.am (guile_TEXINFOS): Added scheme-compound.texi.

	* scheme-data.texi (Variables): Node moved to modules chapter.
	(Symbol Read Syntax): New node, with syntax-related material taken
	from old Symbols node.
	(Symbol Primitives): Renamed from `Symbols'.
	(Symbols and Variables): Renamed to `Symbols'.
	(Symbol Props): Renamed from `Symbol Tables'.
	(Symbols): General review, improvements and additional material
	throughout this section.
	(Other Data Types): New material: links to object types documented
	elsewhere.  Also renamed node to `Other Types'.
	(Data Types): Split into two: `Simple Data Types' and `Compound
	Data Types'.  Introductory blurbs rewritten accordingly.

	* guile.texi: Updated Notes comment.

	* scheme-data.texi (Rx Interface): Node moved to Guile Modules
	part, as the Rx interface is not core Guile.

2001-11-30  Neil Jerram  <neil@ossau.uklinux.net>

	* scheme-data.texi (String Miscellanea): Removed, moving doc for
	string-ci->symbol into the node on Symbols.

	* Makefile.am (ETAGS_ARGS): Added.

	* scheme-data.texi (Symbol Tables): Removed doc for gentemp,
	intern-symbol, string->obarray-symbol, symbol-binding,
	symbol-bound?, symbol-set!, unintern-symbol, symbol-interned?; all
	of which no longer exist.

2001-11-25  Thien-Thi Nguyen  <ttn@glug.org>

	* posix.texi: Fix spelling.  Thanks to Chris Cramer.
	Reword `getpass' intro blurb.

2001-11-23  Neil Jerram  <neil@ossau.uklinux.net>

	* program.texi (Program Control): Remove spurious placeholder
	text.

2001-11-20  Thien-Thi Nguyen  <ttn@glug.org>

	* scheme-options.texi (Install Config):
	Tweak `%load-path' verb to not imply it's a proc.
	Add documentation for `%guile-build-info'.

2001-11-19  Neil Jerram  <neil@ossau.uklinux.net>

	* scheme-data.texi (Symbol Tables), new-docstrings.texi: Removed
	doc for builtin-bindings (no longer exists).
	(Variables): Expanded existing description of variables.  Removed
	doc for builtin-variable (no longer exists).

	* scheme-binding.texi (Top Level): New docs for define, scm_define
	and scm_c_define.  Also clarified point about interchangeability
	of define and set!.

2001-11-18  Neil Jerram  <neil@ossau.uklinux.net>

	* scheme-data.texi (Vectors): Autoupdate docs for
	vector-move-left! and vector-move-right!.

2001-11-16  Neil Jerram  <neil@ossau.uklinux.net>

	* debugging.texi, deprecated.texi, intro.texi, misc-modules.texi,
	new-docstrings.texi, posix.texi, scheme-binding.texi,
	scheme-control.texi, scheme-data.texi, scheme-debug.texi,
	scheme-evaluation.texi, scheme-io.texi, scheme-memory.texi,
	scheme-modules.texi, scheme-options.texi, scheme-procedures.texi,
	scheme-scheduling.texi, scheme-translation.texi,
	scheme-utility.texi, script-getopt.texi, srfi-modules.texi: Change
	category for "primitive" and "procedure" @deffn's to {Scheme
	Procedure}; add @deffnx lines for {C Function}s; automatic updates
	from libguile docstring changes.

	* scheme-memory.texi (Garbage Collection): Removed doc for removed
	`unhash-name'.

2001-11-14  Thien-Thi Nguyen  <ttn@glug.org>

	* scheme-procedures.texi: Spell "library" correctly.

2001-11-13  Neil Jerram  <neil@ossau.uklinux.net>

	* new-docstrings.texi, scheme-data.texi: Merge recent doc
	improvements from stable branch.

	* scheme-options.texi: Automatic updates from docstring changes in
	libguile's C source code.

2001-11-12  Neil Jerram  <neil@ossau.uklinux.net>

	* scheme-data.texi (Vtables, Structure Basics): Automatic doc
	updates for struct? and struct-vtable?.
	(String Searching): Add missing "for".  Thanks to Scott Lenser.

2001-11-08  Neil Jerram  <neil@ossau.uklinux.net>

	* guile.texi (Top): Added new chapter `Programming Options'.

	* program.texi: New file.

	* Makefile.am (guile_TEXINFOS): Added program.texi.

2001-11-07  Neil Jerram  <neil@ossau.uklinux.net>

	* scheme-memory.texi, scheme-io.texi, scheme-debug.texi,
	scheme-data.texi, scheme-binding.texi, posix.texi,
	new-docstrings.texi: Automatic updates from improved libguile
	docstrings.

2001-11-04  Neil Jerram  <neil@ossau.uklinux.net>

	* preface.texi: Use MANUAL_EDITION variable.
	(Manual Layout): Updated to reflect reorg.

	* guile.texi (MANUAL_EDITION): New variable, with value
	incremented from 1.0 to 1.1 to reflect the reorg described here.
	(Top): Use MANUAL_EDITION variable.

	* scheme-indices.texi (R5RS Index, Guile Extensions Index): Use
	@unnumbered rather than @chapter for these indices.

	* guile.texi (Top): A little top-level reshuffling, with the aims
	that: (1) the `Guile Scheme' (reference) part of the manual
	becomes the `Guile API Reference', and covers both Scheme and C
	interfaces; (2) non-API-reference material such as the `Basic
	Ideas in Scheme' chapter is collected together to form a new part
	`Programming with Guile'.  This new part will contain general
	documentation on using and programming Guile in both Scheme and C,
	including - for example - awareness of GC when C programming, how
	to use the snarf macros, how to debug ...
	(Top): Move inclusion of scheme-indices.texi so that all indices
	appear together in the printed manual.

	* Makefile.am (guile_TEXINFOS): Removed appendices.texi, added
	debugging.texi.

	* appendices.texi: Removed.

	* debugging.texi (Debugger User Interface): New file, same as the
	material that used to be in appendices.texi, but now a chapter in
	Part II rather than an appendix.

	* appendices.texi (Obtaining and Installing Guile): Moved to
	become a chapter in ...
	* intro.texi: ... Part I: Introduction to Guile.

	* scm.texi (I/O Extensions): Moved to become a section of ...
	* scheme-io.texi (Input and Output): ... this chapter.

	* scm.texi (Handling Errors): Moved to become a section of ...
	* scheme-control.texi (Control Mechanisms): ... this chapter.

2001-11-06  Thien-Thi Nguyen  <ttn@glug.org>

	* srfi-modules.texi (SRFI-19, SRFI-19 Constants, SRFI-19 Current
	time and clock resolution, SRFI-19 Time object and accessors,
	SRFI-19 Time comparison procedures, SRFI-19 Time arithmetic
	procedures, SRFI-19 Date object and accessors, SRFI-19
	Time/Date/Julian Day/Modified Julian Day converters, SRFI-19 Date
	to string/string to date converters): New nodes.
	(SRFI Support): Add "SRFI-19" to menu.

2001-11-06  Marius Vollmer  <mvo@zagadka.ping.de>

	* scripts.texi: Document `--debug' and `--no-debug'.

2001-10-27  Gary Houston  <ghouston@arglist.com>

	* guile.texi, scsh.texi: removed obsolete guile-scsh material
	and updated links (I don't know if it should remain in the
	main menu.  It's like slib I think.)

	* minor updates to the slib installation notes.

2001-10-05  Neil Jerram  <neil@ossau.uklinux.net>

	* scheme-evaluation.texi (Fly Evaluation): Removed documentation
	for `read-and-eval!' and `eval2'.  (Thanks to Alex Schroeder for
	noticing that they'd disappeared!)

2001-10-05  Thien-Thi Nguyen  <ttn@glug.org>

	* scheme-io.texi (Writing): Add entry for `display'.
	Include in R5RS Index.  Thanks to Alex Schroeder for suggestion.

2001-09-26  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>

	* srfi-modules.texi (SRFI-13): Tyop fix.
	(SRFI-13): Changed paragraph about bindings both in the code and
	in SRFI-13.

	* misc-modules.texi (Formatted Output): Tyop fix.
	(Formatted Output): Document ~g properly.

	Thanks to Alex Schroeder for pointing out the typos and sending
	suggestions.

2001-09-25  Thien-Thi Nguyen  <ttn@glug.org>

	* scheme-procedures.texi (Syntax Rules): Add `cindex' directive.
	Thanks to suggestion by Alex Schroeder.

2001-08-30  Neil Jerram  <neil@ossau.uklinux.net>

	* guile.texi (Top): Group all index nodes together so that
	`Info-index' works more effectively in Info.  Thanks to Eric
	Hanchrow for the report and fix.

	* scheme-data.texi (Random, String Syntax, String Modification,
	Regular Expressions), scheme-ideas.texi (Definition),
	scheme-modules.texi (Dynamic Linking and Compiled Code Modules),
	scm.texi (Transforming Scheme name to C name, Port
	Implementation): Various typo fixes and clarifications merged from
	the stable CVS branch.

2001-08-27  Neil Jerram  <neil@ossau.uklinux.net>

	* intro.texi: Merged wording fixes from stable CVS branch.

	* Makefile.am (guile_TEXINFOS): Remove ../AUTHORS.

	* guile.texi: Incorporate text previously in separate AUTHORS
	file.

2001-08-27  Neil Jerram  <neil@ossau.uklinux.net>

	The change log for files in this directory continues backwards
	from 2001-08-27 in ../ChangeLog, as all the Guile documentation
	prior to this date was contained in a single directory.