From 814e2601040465eb2ceafc35be6a54ee914bb9b5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Grabm=C3=BCller?= Date: Wed, 25 Jul 2001 19:49:38 +0000 Subject: [PATCH] Doc file overhaul. See TODO for what is still missing. --- INSTALL | 11 +++++++ README | 98 ++++++++++++++++++++++++++++++++++----------------------- TODO | 10 +++--- 3 files changed, 75 insertions(+), 44 deletions(-) diff --git a/INSTALL b/INSTALL index fedf6dfb1..961cb2b10 100644 --- a/INSTALL +++ b/INSTALL @@ -210,6 +210,17 @@ or if you're using CSH or one of its variants: setenv GUILE_LOAD_PATH /home/jimb/guile-snap +You will additionally need to set your `LTDL_LIBRARY_PATH' environment +variable to the directory in which the compiled SRFI support modules +are created if you want to use the modules for SRFI-4, SRFI-13 or +SRFI-14 support. Similar to the example above, this will be, + + export LTDL_LIBRARY_PATH=/home/jimb/guile-snap/srfi/.libs + +or if you're using CSH or one of its variants: + + setenv LTDL_LIBRARY_PATH /home/jimb/guile-snap/srfi/.libs + Installing SLIB =========================================================== diff --git a/README b/README index 68313686f..69438e78c 100644 --- a/README +++ b/README @@ -1,40 +1,40 @@ -!!! This is not a Guile release; it is a source tree retrieved via -anonymous CVS or as a nightly snapshot at some random time after the -Guile 1.4 release. If this were a Guile release, you would not see -this message. !!! [fixme: zonk on release] +This is Guile, Project GNU's extension language library. Guile is an +interpreter for Scheme, packaged as a library that you can link into +your applications to give them their own scripting language. Guile +will eventually support other languages as well, giving users of +Guile-based applications a choice of languages. -This is a 1.5 development version of Guile, Project GNU's extension -language library. Guile is an interpreter for Scheme, packaged as a -library that you can link into your applications to give them their -own scripting language. Guile will eventually support other languages -as well, giving users of Guile-based applications a choice of -languages. +This release is version 1.6.0. Any bugs found will be addressed by +further bugfix releases numbered 1.6.1, 1.6.2, and so on. The next +stable Guile release with significant functional improvements will be +version 1.8.0. + +In between 1.6.x and 1.8.x, you can follow Guile development in CVS +and in the Guile mailing lists (see ANON-CVS and HACKING). Guile +builds from the development branch of CVS will have version number +1.7.0. Guile versions with an odd middle number, i.e. 1.5.* are unstable development versions. Even middle numbers indicate stable versions. This has been the case since the 1.3.* series. -The next stable release will be version 1.6.0. - Please send bug reports to bug-guile@gnu.org. Guile Documentation ================================================== -The doc directory contains a few articles on specific topics and some -examples, including data-rep.texi which describes the internal -representation of data types in Guile. The example-smob directory -contains example source code for the "Defining New Types (Smobs)" chapter. +The doc directory contains the Guile Reference Manual, the Guile +Tutorial, the GOOPS Manual and the Revised^5 Report on Scheme. The +example-smob directory contains example source code for the "Defining +New Types (Smobs)" chapter. -The incomplete Guile reference manual is available at +Additionally, help on specific procedures can be obtained directly +from the Guile prompt. Type `(help)' to see usage information for the +online documentation system. - ftp://ftp.red-bean.com/pub/guile/snapshots/guile-doc-snap.tar.gz +The examples directory contains some example scripts, programs and +modules which demonstrate various ways in which Guile can be used. -Neil Jerram is working on the new reference manual, which will be -distributed with guile-core. The new manual will be synchronized with -the docstrings in the sources. Until then, please be aware that the -docstrings are likely to be more up-to-date than the old reference -manual (use `(help)' or see libguile/guile-procedures.txt which is -generated by the build process). +See the file NEWS to see what is new in this release of Guile. The Guile WWW page is at @@ -151,7 +151,8 @@ Executables, in ${prefix}/bin: guile --- a stand-alone interpreter for Guile. With no arguments, this is a simple interactive Scheme interpreter. It can also be used - as an interpreter for script files; see the NEWS file for details. + as an interpreter for script files; see the Guile Reference + Manual for details. guile-config --- a Guile script which provides the information necessary to link your programs against the Guile library. guile-snarf --- a script to parse declarations in your C code for @@ -181,13 +182,15 @@ Header files, in ${prefix}/include: Support files, in ${prefix}/share/guile/: - ice-9/* --- run-time support for Guile: the module system, - read-eval-print loop, some R4RS code and other infrastructure. - oop/* --- the Guile Object-Oriented Programming System (GOOPS) - scripts/* --- executable modules, i.e., scheme programs that can be both - called as an executable from the shell, and loaded and used as a - module from scheme code. See scripts/README for more info. - srfi/* --- SRFI support modules. See srfi/README for more info. + ice-9/* --- run-time support for Guile: the module system, + read-eval-print loop, some R5RS code and other + infrastructure. + oop/* --- the Guile Object-Oriented Programming System (GOOPS) + scripts/* --- executable modules, i.e., scheme programs that can be + both called as an executable from the shell, and loaded + and used as a module from scheme code. See + scripts/README for more info. + srfi/* --- SRFI support modules. See srfi/README for more info. Automake macros, in ${prefix}/share/aclocal: @@ -195,8 +198,12 @@ Automake macros, in ${prefix}/share/aclocal: Documentation in Info format, in ${prefix}/info: - data-rep.info --- an essay on how to write C code that works with - Guile Scheme values. + guile.info --- The Guile Reference Manual + guile-tut.info --- The Guile Tutorial + goops.info --- Reference Manual and Tutorial for GOOPS, Guile's + Object-Oriented Programming System + r5rs.info --- The Revised^5 Report on Scheme, the official Scheme + language definition. The Guile source tree is laid out as follows: @@ -206,16 +213,29 @@ libguile: ice-9: Guile's module system, initialization code, and other infrastructure. guile-config: Source for the guile-config script. -qt: A cooperative threads package from the University of Washington, - which Guile can use. If you configure Guile with the - --with-threads flag, you will need to link against the -lqt - library, found in this directory. Qt is under a separate - copyright; see `qt/README' for more details. guile-readline: The glue code for using GNU readline with Guile. This will be build when configure can find a recent enough readline library on your system. doc: Documentation (see above). +examples: + A collection of ready-to-build example scripts, programs and + modules, which are meant to demonstrate how Guile can be + used for different needs. See examples/README for more info. +libltdl: + A library for generic access to shared libraries from libtool. +oop: GOOPS source code. +qt: A cooperative threads package from the University of Washington, + which Guile can use. If you configure Guile with the + --with-threads flag, you will need to link against the -lqt + library, found in this directory. Qt is under a separate + copyright; see `qt/README' for more details. +scripts: + Some useful scripts, packages as `executable scripts'. See + scripts/README for details. +srfi: A lot of SRFI support modules. See srfi/README for more info. +test-suite: + Guile's regression test suite. Anonymous CVS Access and FTP snapshots =============================== diff --git a/TODO b/TODO index 1e71eacaf..ff9d0770f 100644 --- a/TODO +++ b/TODO @@ -65,7 +65,7 @@ See also file HACKING. + write "make check" tests for subdir `examples' -- Make sure that the deprecation mechanism explained in INSTALL and ++ Make sure that the deprecation mechanism explained in INSTALL and README is completed and works. - Decide if setitimer and getitimer should accept bignum arguments @@ -81,7 +81,7 @@ See also file HACKING. and looking for files you know you've worked on a lot. [martin: done] -- Make sure NEWS, INSTALL, AUTHORS and THANKS and the docs are up to date ++ Make sure NEWS, INSTALL, AUTHORS and THANKS and the docs are up to date + Scan the ChangeLogs for user-visible changes, marked with an asterisk at the left margin. [martin: there were none] @@ -94,12 +94,12 @@ See also file HACKING. + Check for any [[incomplete]] sections of NEWS. -- Fact-check INSTALL. (rlb: INSTALL looks pretty good to me, but can ++ Fact-check INSTALL. (rlb: INSTALL looks pretty good to me, but can someone make sure that in the "Using Guile without installing it" section, we don't need to mention setting LTDL_LIBRARY_PATH or LD_LIBRARY_PATH.) -- Make sure the downloading addresses and filenames in README are ++ Make sure the downloading addresses and filenames in README are current. (But don't bump the version number yet. We do that below.) - Make sure we have appropriate interface numbers for shared @@ -108,7 +108,7 @@ See also file HACKING. - Update the version numbers in GUILE-VERSION and README. [rlb] -- Reformat the names in THANKS. ++ Reformat the names in THANKS. - update this TODO file, removing all "+" relevant to 1.6.0 after making sure that user-visible changes are reflected in NEWS (and