Move doc files into guile-core distribution (6)

7 files changed, 163 insertions, 16 deletions

diff --git a/doc/AUTHORS b/doc/AUTHORS
new file mode 100644
index 000000000..b5fb6a66d
--- /dev/null
+++ b/doc/AUTHORS
@@ -0,0 +1,12 @@
+The Guile reference and tutorial manuals were written and edited
+largely by Mark Galassi and Jim Blandy.  Significant portions were
+contributed by Gary Houston and Tim Pierce.
+
+Tom Lord contributed a great deal of material with early Guile
+snapshots; although most of this text has been rewritten, all of it
+was important, and much of the structure remains.
+
+Aubrey Jaffer wrote the SCM Scheme implementation and manual upon
+which the Guile program and manual are based.  Some portions of the
+SCM and SLIB manuals have been included here verbatim.
+
diff --git a/doc/BUGS b/doc/BUGS
new file mode 100644
index 000000000..736edaace
--- /dev/null
+++ b/doc/BUGS
@@ -0,0 +1,13 @@
+
+Known Guile documentation bugs                -*- outline -*-
+
+* The building of HTML docs is dependent on GNU Make
+
+This is because the Makefile.am's for the Guile reference manual and
+tutorial use a $(shell ...) command to list the set of HTML files to
+install.
+
+Probably this will not be fixed until Automake gains proper HTML doc
+support.  On the other hand, if we've overlooked a more
+version-independent way of achieving the same thing, please let us
+know.
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 23155dbea..315fa2f36 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,7 +1,7 @@
 2001-03-09  Neil Jerram  <neil@ossau.uklinux.net>
 
-	Moving texinfo files from guile-doc/ref and guile-doc/tutorial
-	into guile-core/doc:
+	Moving documentation files from guile-doc and guile-doc into
+	guile-core/doc:
 
 	* env.texi, indices.texi, mbapi.texi, mltext.texi, scripts.texi,
 	scsh.texi, tcltk.texi, hierarchy.txt, scheme-indices.texi,
@@ -16,10 +16,13 @@
 	scheme-scheduling.texi, scheme-translation.texi, guile.texi,
 	scheme-data.texi, scheme-ideas.texi, expect.texi,
 	ChangeLog-guile-doc-ref, guile-tut.texi,
-	ChangeLog-guile-doc-tutorial: New files.
+	ChangeLog-guile-doc-tutorial, AUTHORS, BUGS, NEWS, THANKS: New
+	files.
 
-	* .cvsignore, Makefile.am: Merged.
+	* .cvsignore, Makefile.am, README: Merged.
 
+	* sources: New subdirectory.
+	
 	Both the following files are about to be replaced by files from
 	guile-doc/ref.
 	
diff --git a/doc/ChangeLog-guile-doc b/doc/ChangeLog-guile-doc
new file mode 100644
index 000000000..74ce49b55
--- /dev/null
+++ b/doc/ChangeLog-guile-doc
@@ -0,0 +1,48 @@
+2001-02-15  Neil Jerram  <neil@ossau.uklinux.net>
+
+	* sources/data-rep.texi: Removed.  (ref/data-rep.texi is now the
+	current version of this essay.)
+
+2001-01-26  Neil Jerram  <neil@ossau.uklinux.net>
+
+	* configure.in: Only check for `texi2html' program if HTML is
+	enabled, and explain where to get `texi2html' from if the check
+	fails.
+	
+	* configure.in, Makefile.am, ref/Makefile.am,
+	tutorial/Makefile.am: Clean up Makefile.am's and support
+	(configurable) building of HTML documentation in addition to
+	Info.  Thanks to Steve Tell for the patch on which these changes
+	were based.
+
+2000-10-14  Neil Jerram  <neil@ossau.uklinux.net>
+
+	* sources/data-rep.texi: Merged a lot of changes from
+	guile-core/doc/data-rep.texi.
+
+2000-08-07  Neil Jerram  <neil@ossau.uklinux.net>
+
+	* configure.in, configure: Advance version number to 1.4.
+
+2000-07-28  Neil Jerram  <neil@ossau.uklinux.net>
+
+	* sources/data-rep.texi (Garbage Collection): Fix "accomodate"
+	spelling mistake.
+
+1998-07-27  Mark Galassi  <rosalia@cygnus.com>
+
+	* simple test
+
+1998-04-13  Marius Vollmer  <mvo@zagadka.ping.de>
+
+	Have "make dist" include the sources directory:
+	* Makefile.am: Added "sources" directory to SUBDIRS.
+	* sources/Makefile.am: New file.
+	* configure.in: Added "sources/Makefile" to AC_OUTPUT.
+
+Sun Jun 22 18:38:28 1997  Tim Pierce  <twp@twp.tezcat.com>
+
+	New documentation module.
+
+
+
diff --git a/doc/NEWS b/doc/NEWS
new file mode 100644
index 000000000..2624f28d3
--- /dev/null
+++ b/doc/NEWS
@@ -0,0 +1,44 @@
+Guile-doc NEWS --- history of user-visible changes.  -*- text -*-
+Copyright (C) 1997, 2001 Free Software Foundation, Inc.
+See the end for copying conditions.
+
+
+Changes since Guile 1.3.4:
+
+* It's now possible to build HTML documentation as well as Info
+
+The guile-doc distribution now supports building HTML versions of the
+Guile tutorial and reference manual, in addition to the standard Info
+documentation.  To enable this, include the `--enable-html' option
+when you run `./configure':
+
+     ./configure --enable-html
+
+HTML documentation is installed in $(prefix)/html/guile-$(VERSION).
+
+
+Changes since Guile 1.0 (Sun 5 Jan 1997):
+
+* The current documentation approach, recommended by Jim Blandy, is to
+have: (*) a tutorial with the pedagogical style of guile-user, and a
+non-dry reference manual in the style of the most excellent GNU libc
+reference manual: the reference manual should be complete, but at the
+same time it should have an introductory screen for each major topic,
+which can be referenced if the user goes "up" a level in the info
+documentation.
+
+
+Copyright information:
+
+Copyright (C) 1996,1997 Free Software Foundation, Inc.
+
+   Permission is granted to anyone to make or distribute verbatim copies
+   of this document as received, in any medium, provided that the
+   copyright notice and this permission notice are preserved,
+   thus giving the recipient permission to redistribute in turn.
+
+   Permission is granted to distribute modified versions
+   of this document, or of portions of it,
+   under the above conditions, provided also that they
+   carry prominent notices stating who last changed them.
+
diff --git a/doc/README b/doc/README
index 47f120c4e..2f4ec3432 100644
--- a/doc/README
+++ b/doc/README
@@ -1,18 +1,29 @@
-This directory contains documentation on the Guile core.
+This directory contains documentation on the Guile core.         -*-text-*-
 
-At the moment, we don't have a full manual on Guile; that's at the
-head of our task list.  You can see a snapshot of the new Guile
-reference manual by checking out the `guile-doc' CVS module.
+The documentation consists of the following manuals.
+
+- The Guile Tutorial (guile-tut.texi) contains a tutorial introduction
+  to using Guile.
+
+- The Guile Reference Manual (guile.texi) contains (or is intended to
+  contain) reference documentation on all aspects of Guile.
+
+- The GOOPS Manual (goops.texi) contains both tutorial-style and
+  reference documentation for using GOOPS, Guile's Object Oriented
+  Programming System.
+
+- The Revised^4 and Revised^5 Reports on the Algorithmic Language
+  Scheme (r4rs.texi and r5rs.texi).
+
+Please be aware that this is all very much work in progress (apart
+from the Revised Reports).  Bug reports and contributions are
+welcome!
 
 The file `oldfmt.c' contains a function which can be used by
 application writers to support both old-style and new-style error
 format strings.
 
-The file `data-rep.texi', which used to be in this directory, is now
-integrated into the Guile reference manual: the integrated version of
-this essay is the `Data Representation' chapter.  (This chapter is an
-essay on how to write C code that uses Guile values.  If you're
-interested in writing a application which is extensible via Guile,
-this is a good place to start.)  To update the Texinfo source for this
-essay - for example, when the smob interface changes - please update
-the file `guile-doc/ref/data-rep.texi' in the guile-doc module.
+The `sources' directory includes some stuff relevant to the Guile
+reference manual, and which may eventually be folded in to it.  It's
+not immediately relevant, however, which is why it's not in this
+directory.
diff --git a/doc/THANKS b/doc/THANKS
new file mode 100644
index 000000000..8c55c8284
--- /dev/null
+++ b/doc/THANKS
@@ -0,0 +1,16 @@
+The Guile reference manual:
+- Mark Galassi, for general stewardship
+- Tim Pierce, for writing sections on script interpreter triggers, alists,
+  function tracing, and splitting the manual into its own module.
+Proofreading and bug fixes from:
+Marcus Daniels
+   Lee Thomas
+  Joel Weber
+ Keith Wright
+ Chris Bitmead
+
+New entries from:
+   Per Bothner
+
+Build patches from:
+ Steve Tell