Fix make-array transforms.
[sbcl.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index b1413ab..378515b 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -129,11 +129,13 @@ INSTALLING SBCL
   To configure SBCL with a non-standard default dynamic-space size,
   use the --dynamic-space-size option:
 
-    $ sh make.sh --dynamic-space-size=1Gb
-    $ sh make.sh --dynamic-space-size=500Mb
+    $ sh make.sh --dynamic-space-size=4Gb
+    $ sh make.sh --dynamic-space-size=800Mb
 
   If mega- or gigabytes are not specified, the number is taken to be
-  in megabytes. The standard default is platform specific.
+  in megabytes. The standard default is 512Mb for 32-bit systems, and
+  1Gb for 64-bit systems (with the exception of OpenBSD where 444Mb
+  are used to fit under default ulimits.)
 
   If you don't already have an SBCL binary installed as "sbcl" on your
   system, you'll need to tell make.sh what Lisp to use as the
@@ -170,40 +172,44 @@ INSTALLING SBCL
   enabling or disabling features like documentation strings, threads,
   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.
+  The preferred way to do this is using commandline arguments to make.sh:
 
-    (lambda (features)
-      (flet ((enable (x)
-               (pushnew x features))
-             (disable (x)
-               (setf features (remove x features))))
-        ;; Threading support.
-        (enable :sb-thread)))
-
-  This is the preferred way because it lets local changes interact
-  cleanly with CVS changes to the main, global source tree.
+    --fancy                    Enables all supported feature enhancements.
+    --with-<feature>           Enables a specific feature.
+    --without-<feature>        Disables a specific feature.
 
   Some features of interest:
 
-    :SB-THREAD
+    :SB-THREAD (--with-sb-thread, --without-sb-thread)
+
       Native threads. Enabled by default on x86[-64] Linux only, also
       available on x86[-64] Max OS X, x86[-64] FreeBSD, x86 Solaris,
       and PPC Linux.
 
-    :SB-UNICODE
-      Unicode support. Enabled by default. Disabling this feature
-      limits characters to the 8-bit ISO-8859-1 set.
+      NOTE: --fancy enables threads on all platforms where they can be
+      built, even if they aren't 100% stable on that platform.
+
+    :SB-CORE-COMPRESSION (--with-sb-core-compression)
+
+      Adds zlib as a build-dependency, and makes SBCL able to save
+      compressed cores. Not enabled by default.
+
+    :SB-XREF-FOR-INTERNALS (--with-sb-xref-for-internals)
 
-    :SB-XREF-FOR-INTERNALS
       XREF data for SBCL internals. Not enabled by default, increases
       core size by 5-6mb.
 
+    :SB-UNICODE (--without-sb-unicode)
+
+      Unicode support. Enabled by default. Disabling this feature
+      limits characters to the 8-bit ISO-8859-1 set.
+
   A catalog of available features and their meaning can be found in
   "base-target-features.lisp-expr".
 
+  Please do NOT edit base-target-features.lisp-expr in order to enable
+  or disable build features.
+
 2.3. Troubleshooting
 
   "GNU Make not found"