0.7.9.47:
[sbcl.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index ddc79bd..fe184fb 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -33,7 +33,7 @@ So: the standard installation procedure is
   2. Copy sbcl to /usr/bin or /usr/local/bin.
   3. Optionally copy sbcl.1 to /usr/man/man1 or /usr/local/man/man1.
 The script install.sh does these for you (choosing the /usr/local
-subdirectory) in each case.
+subdirectory in each case).
 
 
 IF YOU HAVE A SOURCE DISTRIBUTION:
@@ -48,11 +48,29 @@ This software has been built successfully on these systems:
                os = FreeBSD 3.4 or 4.0
                        host lisp = CMU CL
                        host lisp = SBCL itself
-               os = OpenBSD 2.6
+               os = OpenBSD 2.6, 2.7, 2.8, 2.9, and 3.0
                        host lisp = SBCL itself
-It is known not to build under CLISP, because CLISP doesn't support
-MAKE-LOAD-FORM. Reports of other systems that it works on, or help in
-making it run on more systems, would be appreciated.
+       cpu = alpha
+               os = Debian GNU/Linux 2.2 with libc >= 2.1
+                       host lisp = SBCL itself
+               os = Tru64 5.1
+                       host lisp = SBCL itself
+       cpu = sparc
+               os = Debian GNU/Linux 2.2 with libc >= 2.2
+                       host lisp = SBCL itself
+               os = Solaris 8
+                       host lisp = SBCL itself
+       cpu = powerpc
+               os = Debian GNU/Linux 2.2 with libc >= 2.1
+                       host lisp = OpenMCL 0.12
+                       host lisp = SBCL itself
+
+It is known not to build under CLISP (as of early June 2002) because
+of bugs in the CLISP garbage collector.
+
+Reports of other systems that it works on (or doesn't work on, for
+that matter), or help in making it run on more systems, would be
+appreciated.
 
                CAUTION CAUTION CAUTION CAUTION CAUTION
            SBCL, like CMU CL, overcommits memory. That is, it
@@ -83,20 +101,32 @@ making it run on more systems, would be appreciated.
        problem with quotas, I don't know.)
 
 To build the system binaries:
+  0. If you want to be on the bleeding edge, you can update your
+     sources to the latest development snapshot (or any previous
+     development snapshot, for that matter) by using anonymous CVS
+     to SourceForge. (This is not recommended if you're just using SBCL
+     as a tool for other work, but if you're interested in working on 
+     SBCL itself, it's a good idea.) Follow the "CVS Repository" link on
+     <http://sourceforge.net/projects/sbcl> for instructions.
   1. Make sure that you have enough RAM+swap to build SBCL, as
      per the CAUTION note above. (As of version 0.6.0, the most
      memory-intensive operation in make.sh is the second call to
      GENESIS, which makes the Lisp image grow to nearly 128 Mb RAM+swap.
-     This will probably be reduced somewhat in some later version
-     by allowing cold load of byte-compiled files, so that the cold
-     image can be smaller.)
   2. If the GNU make command is not available under the name "gmake",
      then define the environment variable GNUMAKE to a name where it can
      be found.
-  3. If you like, you can edit the base-features.lisp-expr file
-     to customize the resulting Lisp system. By enabling or disabling
-     features in this file, you can create a smaller system, or one
-     with extra code for debugging output or error-checking or other things.
+  3. If you like, you can tweak the *FEATURES* set for the resulting
+     Lisp system, enabling or disabling features like documentation
+     strings or extra debugging code. The preferred way to do this is
+     by creating a file "customize-target-features.lisp", containing
+     a lambda expression which is applied to the default *FEATURES*
+     set and which returns the new *FEATURES* set, e.g.
+       (LAMBDA (LIST)
+         (ADJOIN :SB-SHOW
+                 (REMOVE :SB-DOC
+                         LIST)))
+     (This is the preferred way because it lets local changes interact
+     cleanly with CVS changes to the main, global source tree.)
   4. Run "sh make.sh" in the same directory where you unpacked the 
      tarball. If you don't already have a SBCL binary installed
      as "sbcl" in your path, you'll need to tell make.sh what Lisp
@@ -110,9 +140,7 @@ To build the system binaries:
        13 hours on a 133MHz Pentium (P54C) with 48Mb RAM, running OpenBSD 2.6.
      Around the 48Mb mark, the build process is starved for RAM:
      on my 48Mb OpenBSD machine with nothing else running, it
-     spent about 2/3 of its wall clock time swapping. Anything which 
-     substantially increases memory use, like running X11, Emacs, or, 
-     God forbid, Netscape, can increase the build time substantially.
+     spent about 2/3 of its wall clock time swapping. 
 
 Now you should have the same src/runtime/sbcl and output/sbcl.core
 files that come with the binary distribution, and you can install