X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=INSTALL;h=ed2e32a7daeb75599c285dc0ca07e6d5ca70ae42;hb=4ac05a17609e15172710fc6690f7968157b93490;hp=b6acdbc1cceae3ad3568fbb79c041b469442abc2;hpb=c05927ab82e234da99f8409038e7e338e36ddf8e;p=sbcl.git diff --git a/INSTALL b/INSTALL index b6acdbc..ed2e32a 100644 --- a/INSTALL +++ b/INSTALL @@ -4,7 +4,7 @@ INSTALLING SBCL 1. BINARY DISTRIBUTION 1.1. Quick start - 1.2. Finding ancilliary files + 1.2. Finding ancillary files 1.3. Anatomy of SBCL 2. SOURCE DISTRIBUTION @@ -32,14 +32,14 @@ INSTALLING SBCL by the environment variable "INSTALL_ROOT". If you install SBCL from binary distribution in other location then - "/usr/local", see section 1.2, "Finding ancilliary files". + "/usr/local", see section 1.2, "Finding ancillary files". -1.2. Finding ancilliary files +1.2. Finding ancillary files The SBCL runtime needs to be able to find the ancillary files associated with it: the "sbcl.core" file, and the contrib modules. - This can happen in three ways: + Finding core can happen in three ways: 1. By default, in a location configured when the system was built. For binary distributions this is in "/usr/local/lib/sbcl". @@ -57,15 +57,17 @@ INSTALLING SBCL $ sbcl --core /foo/bar/sbcl.core - When using this option contrib modules are looked for in the - directory where the designated core resides, and in "SBCL_HOME". - The usual, recommended approach is method #1. Method #2 is useful if you're installing SBCL on a system in a non-standard location (e.g. in your user account), instead of installing SBCL on an entire system. Method #3 is mostly useful for testing or other special cases. + Contributed modules are primarily looked for in "SBCL_HOME", or the + directory the core resides in if "SBCL_HOME" is not set. + ASDF:*CENTRAL-REGISTRY* serves as an additional fallback for + ASDF-based modules. + 1.3. Anatomy of SBCL The two files that SBCL needs to run, at minimum, are: @@ -92,7 +94,7 @@ INSTALLING SBCL passed their tests. If you need to install by hand, see "install.sh" for details. - Documentation concists of a man-page, the SBCL Manual (in info, pdf + Documentation consists of a man-page, the SBCL Manual (in info, pdf and html formats), and a few additional text files. 2. SOURCE DISTRIBUTION @@ -109,7 +111,7 @@ INSTALLING SBCL 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 - cross-compilation host. For example, to use CMU CL (assuming has + cross-compilation host. For example, to use CMUCL (assuming has been installed under its default name "lisp") as the cross-compilation host: @@ -143,9 +145,9 @@ INSTALLING SBCL or extra debugging code. The preferred way to do this is by creating a file - "customize-target-features.lisp-expr", containing a lambda - expression which is applied to the default *FEATURES* set and which - returns the new *FEATURES* set, e.g. + "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 (features) (flet ((enable (x) @@ -183,8 +185,12 @@ INSTALLING SBCL Other - * Check that the host lisp you're building with is known to work - as an SBCL build host, and the your OS is supported. + * Check that the host lisp you're building with is known to work as + an SBCL build host, and that your operating system is supported. + + * Try to do a build without loading any initialization files + for the cross-compilation host (for example + "sh make.sh 'sbcl --userinit /dev/null --sysinit /dev/null'"). * Some GCC versions are known to have bugs that affect SBCL compilation: if the error you're encountering seems related to @@ -209,7 +215,7 @@ INSTALLING SBCL All of the following platforms are supported in the sense of "should work", but some things like loading foreign object files may lag - behind on less-used OS's. + behind on less-used operating systems. Supported toolchains: @@ -222,6 +228,7 @@ INSTALLING SBCL CMUCL OpenMCL CLISP (recent versions only) + ABCL (recent versions only) Note that every release isn't tested with every possible host compiler. You're most likely to get a clean build with SBCL itself @@ -232,14 +239,15 @@ INSTALLING SBCL x86 PPC Alpha Sparc HPPA MIPS MIPSel Linux 2.2, 2.4, 2.6 X X X X X X X FreeBSD X - OpenBSD 3.4, 3.5 X + OpenBSD 3.4, 3.5 X NetBSD X Solaris X Tru64 X Darwin (Mac OS X) X - Some OS's are more equal then others: most of the development and - testing is done on x86 Linux and *BSD, PPC Linux and Mac OS X. + Some operating systems are more equal then others: most of the + development and testing is done on x86 Linux and *BSD, PPC Linux + and Mac OS X. If an underprivileged platform is important to you, you can help by eg. testing during the monthly freeze periods, and most