0.7.4.37:
[sbcl.git] / base-target-features.lisp-expr
index da348e5..db5dfbc 100644 (file)
@@ -1,3 +1,5 @@
+;;;; -*- Lisp -*-
+
 ;;;; tags which are set during the build process and which end up in
 ;;;; CL:*FEATURES* in the target SBCL, plus some comments about other
 ;;;; CL:*FEATURES* tags which have special meaning to SBCL or which
@@ -5,8 +7,10 @@
 ;;;;
 ;;;; Note that the recommended way to customize the features of a
 ;;;; local build of SBCL is not to edit this file, but instead to
-;;;; tweak customize-target-features.lisp. E.g. you can use code like
-;;;; this:
+;;;; tweak customize-target-features.lisp. If you define a function
+;;;; in customize-target-features.lisp, it will be used to transform
+;;;; the target features list after it's read and before it's used.
+;;;; E.g. you can use code like this:
 ;;;;    (lambda (list)
 ;;;;      (flet ((enable (x) (pushnew x list))
 ;;;;            (disable (x) (setf list (remove x list))))
 ;;;;        (enable :sb-after-xc-core)
 ;;;;        #+nil (disable :sb-doc)
 ;;;;        list))
-;;;; That way, because customize-target-features.lisp is in
-;;;; .cvsignore, your local changes will remain local even if you use
-;;;; "cvs diff" to submit patches to SBCL.
+;;;; By thus editing a local file (one which is not in the source
+;;;; distribution, and which is in .cvsignore) your customizations
+;;;; will remain local even if you do things like "cvs update",
+;;;; will not show up if you try to submit a patch with "cvs diff",
+;;;; and might even stay out of the way if you use other non-CVS-based
+;;;; methods to upgrade the files or store your configuration.
 
 ;;;; This software is part of the SBCL system. See the README file for
 ;;;; more information.
  ;; our standard
  :ansi-cl :common-lisp
  ;; FIXME: Isn't there a :x3jsomething feature which we should set too?
+ ;; No. CLHS says ":x3j13 [...] A conforming implementation might or
+ ;; might not contain such a feature." -- CSR, 2002-02-21
 
  ;; our dialect
  :sbcl
 
  ;; Douglas Thomas Crosher's conservative generational GC (the only one
- ;; we currently support for X86)
- :gencgc
+ ;; we currently support for X86).
+ ;; :gencgc used to be here; CSR moved it into
+ ;; local-target-features.lisp-expr via make-config.sh, as alpha,
+ ;; sparc and ppc ports don't currently support it. -- CSR, 2002-02-21
 
  ;; We're running under a UNIX. This is sort of redundant, and it was also
  ;; sort of redundant under CMU CL, which we inherited it from: neither SBCL
  ;; the executable I'm running.
  :sb-doc
 
- ;; Do regression and other tests when building the system. You
- ;; might or might not want this if you're not a developer,
- ;; depending on how paranoid you are. You probably do want it if
- ;; you are a developer.
+ ;; Do regression and other tests when building the system. You might
+ ;; or might not want this if you're not a developer, depending on how
+ ;; paranoid you are. You probably do want it if you are a developer.
+ ;; This test does not affect the target system (in much the same way
+ ;; as :sb-after-xc-core, below).
  :sb-test
 
  ;; Make more debugging information available (for debugging SBCL
 
  ;; Build SBCL with the old CMU CL low level debugger, "ldb". If 
  ;; are aren't messing with CMU CL at a very low level (e.g. 
- ;; trying to diagnose GC problems) you shouldn't need this.
+ ;; trying to diagnose GC problems, or trying to debug assembly
+ ;; code for a port to a new CPU) you shouldn't need this.
  ; :sb-ldb
 
  ;; This isn't really a target Lisp feature at all, but controls
  ;; whether the build process produces an after-xc.core file. This
- ;; can be useful for shortening the edit/compile/debug cycle if
- ;; you're messing around with low-level internals of the system,
- ;; as in slam.sh. Otherwise you don't need it.
+ ;; can be useful for shortening the edit/compile/debug cycle when
+ ;; you modify SBCL's own source code, as in slam.sh. Otherwise
+ ;; you don't need it.
  ; :sb-after-xc-core
 
  ;; Enable extra debugging output in the assem.lisp assembler/scheduler
  ;; anyone who wants to collect such statistics in the future.
  ; :sb-dyncount
 
- ;; Peter Van Eynde's increase-bulletproofness code
+ ;; Peter Van Eynde's increase-bulletproofness code for CMU CL
  ;;
- ;; This is not maintained or tested in current SBCL, but I haven't
- ;; gone out of my way to remove or break it, either.
+ ;; Some of the code which was #+high-security before the fork has now
+ ;; been either made unconditional, deleted, or rewritten into
+ ;; unrecognizability, but some remains. What remains is not maintained
+ ;; or tested in current SBCL, but I haven't gone out of my way to
+ ;; break it, either. 
  ;;
  ; :high-security
  ; :high-security-support
  ;; affects a lot of floating point code.
  ; :negative-zero-is-not-zero
 
- ;; It's unclear to me what this does (but it was enabled in the code
- ;; that I picked up from Peter Van Eynde, called CONSTRAIN-FLOAT-TYPE
- ;; instead of SB-CONSTRAIN-FLOAT-TYPE). -- WHN 19990224
- :sb-constrain-float-type
-
  ;; This is set in classic CMU CL, and presumably there it means
  ;; that the floating point arithmetic implementation
  ;; conforms to IEEE's standard. Here it definitely means that the
  ;; the underlying x86 hardware tries).
  :ieee-floating-point
 
- ;; This seems to be the pre-GENCGC garbage collector for CMU CL, which was
- ;; AFAIK never supported for the X86.
- ; :gengc
-
  ;; CMU CL had, and we inherited, code to support 80-bit LONG-FLOAT on the x86
  ;; architecture. Nothing has been done to actively destroy the long float
  ;; support, but it hasn't been thoroughly maintained, and needs at least
  ;;      any Intel 386 or better, or compatibles like the AMD K6 or K7
  ;;   :alpha
  ;;      DEC/Compaq Alpha CPU
- ;; (No other CPUs are supported by SBCL as of 0.6.12.15, but SPARC or
- ;; PowerPC support could be ported from CMU CL if anyone is
- ;; sufficiently motivated to do so, or if you're *really* motivated,
- ;; you could write a port from scratch for a new CPU architecture.)
+ ;;   :sparc
+ ;;      any Sun UltraSPARC (possibly also non-Ultras -- currently untested)
+ ;;   :ppc
+ ;;      any PowerPC CPU
+ ;;
+ ;; (No other CPUs are supported by SBCL as of 0.7.5, but MIPS or HPPA
+ ;; support could be ported from CMU CL if anyone is sufficiently
+ ;; motivated to do so, or if you're *really* motivated, you could
+ ;; write a port from scratch for a new CPU architecture.)
+ ;;
  ;; (CMU CL also had a :pentium feature, which affected the definition
- ;; of some floating point vops. It was present but not enabled or 
- ;; documented in the CMU CL code that SBCL is derived from, and is
- ;; present but stale in SBCL as of 0.6.12.)
+ ;; of some floating point vops. It was present but not enabled or
+ ;; documented in the CMU CL code that SBCL is derived from, and has
+ ;; now been moved to the backend-subfeatures mechanism.)
+ ;;
+ ;; properties derived from the machine architecture
+ ;;   :control-stack-grows-downward-not-upward
+ ;;     On the X86, the Lisp control stack grows downward. On the
+ ;;     other supported CPU architectures as of sbcl-0.7.1.40, the
+ ;;     system stack grows upward. 
+ ;;   Note that there are other stack-related differences between the
+ ;;   X86 port and the other ports. E.g. on the X86, the Lisp control
+ ;;   stack coincides with the C stack, meaning that on the X86 there's
+ ;;   stuff on the control stack that the Lisp-level debugger doesn't
+ ;;   understand very well. As of sbcl-0.7.1.40 things like that are
+ ;;   just parameterized by #!+X86, but it'd probably be better to
+ ;;   use new flags like :CONTROL-STACK-CONTAINS-C-STACK.
  ;;
  ;; operating system features:
  ;;   :linux   = We're intended to run under some version of Linux.
  ;;              is not exclusive with the features which indicate which
  ;;              particular version of BSD we're intended to run under.)
  ;;   :freebsd = We're intended to run under FreeBSD.
- ;;   :openbsd = We're intended to run under FreeBSD.
- ;; (No others are supported by SBCL as of 0.6.7, but :hpux or
- ;; :solaris support could be ported from CMU CL if anyone is
+ ;;   :openbsd = We're intended to run under OpenBSD.
+ ;;   :sunos   = We're intended to run under Solaris user environment
+ ;;              with the SunOS kernel.
+ ;;   :osf1    = We're intended to run under Tru64 (aka Digital Unix
+ ;;              aka OSF/1).
+ ;; (No others are supported by SBCL as of 0.7.5, but :hpux or
+ ;; :irix support could be ported from CMU CL if anyone is
  ;; sufficiently motivated to do so, and it'd even be possible,
  ;; though harder, to port the system to Microsoft Windows.)
  )