Fix typos in docstrings and function names.

[sbcl.git] / src / compiler / policy.lisp

diff --git a/src/compiler/policy.lisp b/src/compiler/policy.lisp
index d0beebe..cadc959 100644 (file)
--- a/src/compiler/policy.lisp
+++ b/src/compiler/policy.lisp
@@ -19,7 +19,7 @@
 
 (defun restrict-compiler-policy (&optional quality (min 0))
   #!+sb-doc
-  "Assing a minimum value to an optimization quality. QUALITY is the name of
+  "Assign a minimum value to an optimization quality. QUALITY is the name of
 the optimization quality to restrict, and MIN (defaulting to zero) is the
 minimum allowed value.
 
@@ -36,8 +36,10 @@ was MIN instead.
 This is intended to be used interactively, to facilitate recompiling large
 bodies of code with eg. a known minimum safety.
 
+See also :POLICY option in WITH-COMPILATION-UNIT.
+
 EXPERIMENTAL INTERFACE: Subject to change."
-  (declare (policy-quality min))
+  (declare (type policy-quality min))
   (when quality
     (aver (policy-quality-name-p quality))
     (if (zerop min)
@@ -72,6 +74,19 @@ EXPERIMENTAL INTERFACE: Subject to change."
   (or (memq x *policy-qualities*)
       (assq x *policy-dependent-qualities*)))
 
+;;; Is it deprecated?
+(defun policy-quality-deprecation-warning (quality)
+  (case quality
+    ((stack-allocate-dynamic-extent stack-allocate-vector stack-allocate-value-cells)
+     (deprecation-warning :late "1.0.19.7" quality '*stack-allocate-dynamic-extent*
+                          :runtime-error nil)
+     t)
+    ((merge-tail-calls)
+     (deprecation-warning :early "1.0.53.74" quality nil :runtime-error nil)
+     t)
+    (otherwise
+     nil)))
+
 ;;; *POLICY* holds the current global compiler policy information, as
 ;;; an alist mapping from optimization quality name to quality value.
 ;;; Inside the scope of declarations, new entries are added at the
@@ -79,6 +94,11 @@ EXPERIMENTAL INTERFACE: Subject to change."
 (declaim (type policy *policy*))
 (defvar *policy*)          ; initialized in cold init
 
+(defun sort-policy (policy)
+  ;; We occasionally want to compare policies using EQL, hence we
+  ;; canonize the order.
+  (sort policy #'string< :key #'car))
+
 ;;; This is to be called early in cold init to set things up, and may
 ;;; also be called again later in cold init in order to reset default
 ;;; optimization policy back to default values after toplevel PROCLAIM
@@ -101,12 +121,12 @@ EXPERIMENTAL INTERFACE: Subject to change."
           ;; Perhaps INHIBIT-NOTES?
           inhibit-warnings))
   (setf *policy*
-        (mapcar (lambda (name)
-                  ;; CMU CL didn't use 1 as the default for
-                  ;; everything, but since ANSI says 1 is the ordinary
-                  ;; value, we do.
-                  (cons name 1))
-                *policy-qualities*))
+        (sort-policy (mapcar (lambda (name)
+                               ;; CMU CL didn't use 1 as the default for
+                               ;; everything, but since ANSI says 1 is the ordinary
+                               ;; value, we do.
+                               (cons name 1))
+                             *policy-qualities*)))
   (setf *policy-restrictions* nil)
   ;; not actually POLICY, but very similar
   (setf *handled-conditions* nil
@@ -154,16 +174,19 @@ EXPERIMENTAL INTERFACE: Subject to change."
 
 ;;; Dependent qualities
 (defmacro define-optimization-quality
-    (name expression &optional documentation)
+    (name expression &optional values-documentation documentation)
+  (declare (ignorable documentation))
   `(eval-when (:compile-toplevel :load-toplevel :execute)
      (let ((acons (assoc ',name *policy-dependent-qualities*))
            (item (make-policy-dependent-quality
                   :name ',name
                   :expression ',expression
                   :getter (lambda (policy) (policy policy ,expression))
-                  :values-documentation ',documentation)))
+                  :values-documentation ',values-documentation)))
        (if acons
            (setf (cdr acons) item)
            (setf *policy-dependent-qualities*
                  (nconc *policy-dependent-qualities* (list `(,',name . ,item))))))
+     #-sb-xc-host
+     ,@(when documentation `((setf (fdocumentation ',name 'optimize) ,documentation)))
      ',name))