diff --git a/src/contrib/asdf/asdf.lisp b/src/contrib/asdf/asdf.lisp index 19067bec00a8def6e3dbf105756f871c4ffc7c62..f5f73eb7fa6a979c57f7fe21fe67af54ce6a9cd8 100644 --- a/src/contrib/asdf/asdf.lisp +++ b/src/contrib/asdf/asdf.lisp @@ -1,5 +1,5 @@ ;;; -*- mode: Lisp; Base: 10 ; Syntax: ANSI-Common-Lisp ; buffer-read-only: t; -*- -;;; This is ASDF 3.3.2: Another System Definition Facility. +;;; This is ASDF 3.3.3: Another System Definition Facility. ;;; ;;; Feedback, bug reports, and patches are all welcome: ;;; please mail to <asdf-devel@common-lisp.net>. @@ -19,7 +19,7 @@ ;;; http://www.opensource.org/licenses/mit-license.html on or about ;;; Monday; July 13, 2009) ;;; -;;; Copyright (c) 2001-2016 Daniel Barlow and contributors +;;; Copyright (c) 2001-2019 Daniel Barlow and contributors ;;; ;;; Permission is hereby granted, free of charge, to any person obtaining ;;; a copy of this software and associated documentation files (the @@ -45,6 +45,17 @@ ;;; The problem with writing a defsystem replacement is bootstrapping: ;;; we can't use defsystem to compile it. Hence, all in one file. +#+genera +(eval-when (:compile-toplevel :load-toplevel :execute) + (multiple-value-bind (system-major system-minor) + (sct:get-system-version) + (multiple-value-bind (is-major is-minor) + (sct:get-system-version "Intel-Support") + (unless (or (> system-major 452) + (and is-major + (or (> is-major 3) + (and (= is-major 3) (> is-minor 86))))) + (error "ASDF requires either System 453 or later or Intel Support 3.87 or later"))))) ;;;; --------------------------------------------------------------------------- ;;;; Handle ASDF package upgrade, including implementation-dependent magic. ;; @@ -818,10 +829,10 @@ UNINTERN -- Remove symbols here from PACKAGE." ;;;; Early meta-level tweaks -#+(or allegro clasp clisp clozure cmucl ecl mezzano mkcl sbcl) +#+(or allegro clasp clisp clozure cmucl ecl lispworks mezzano mkcl sbcl) (eval-when (:load-toplevel :compile-toplevel :execute) (when (and #+allegro (member :ics *features*) - #+(or clasp clisp cmucl ecl mkcl) (member :unicode *features*) + #+(or clasp clisp cmucl ecl lispworks mkcl) (member :unicode *features*) #+clozure (member :openmcl-unicode-strings *features*) #+sbcl (member :sb-unicode *features*)) ;; Check for unicode at runtime, so that a hypothetical FASL compiled with unicode @@ -1043,7 +1054,9 @@ Return a string made of the parts not omitted or emitted by FROB." #:simple-style-warning #:style-warn ;; simple style warnings #:match-condition-p #:match-any-condition-p ;; conditions #:call-with-muffled-conditions #:with-muffled-conditions - #:not-implemented-error #:parameter-error)) + #:not-implemented-error #:parameter-error + #:symbol-test-to-feature-expression + #:boolean-to-feature-expression)) (in-package :uiop/utility) ;;;; Defining functions in a way compatible with hot-upgrade: @@ -1089,17 +1102,17 @@ to supersede any previous definition." ;;; Magic debugging help. See contrib/debug.lisp (with-upgradability () (defvar *uiop-debug-utility* - '(or (ignore-errors - (probe-file (symbol-call :asdf :system-relative-pathname :uiop "contrib/debug.lisp"))) - (probe-file (symbol-call :uiop/pathname :subpathname - (user-homedir-pathname) "common-lisp/asdf/uiop/contrib/debug.lisp"))) + '(symbol-call :uiop :subpathname (symbol-call :uiop :uiop-directory) "contrib/debug.lisp") "form that evaluates to the pathname to your favorite debugging utilities") (defmacro uiop-debug (&rest keys) + "Load the UIOP debug utility at compile-time as well as runtime" `(eval-when (:compile-toplevel :load-toplevel :execute) (load-uiop-debug-utility ,@keys))) (defun load-uiop-debug-utility (&key package utility-file) + "Load the UIOP debug utility in given PACKAGE (default *PACKAGE*). +Beware: The utility is located by EVAL'uating the UTILITY-FILE form (default *UIOP-DEBUG-UTILITY*)." (let* ((*package* (if package (find-package package) *package*)) (keyword (read-from-string (format nil ":DBG-~:@(~A~)" (package-name *package*))))) @@ -1658,6 +1671,18 @@ message, that takes the functionality as its first argument (that can be skipped :format-control format-control :format-arguments format-arguments))) +(with-upgradability () + (defun boolean-to-feature-expression (value) + "Converts a boolean VALUE to a form suitable for testing with #+." + (if value + '(:and) + '(:or))) + + (defun symbol-test-to-feature-expression (name package) + "Check if a symbol with a given NAME exists in PACKAGE and returns a +form suitable for testing with #+." + (boolean-to-feature-expression + (find-symbol* name package nil)))) (uiop/package:define-package :uiop/version (:recycle :uiop/version :uiop/utility :asdf) (:use :uiop/common-lisp :uiop/package :uiop/utility) @@ -1672,7 +1697,7 @@ message, that takes the functionality as its first argument (that can be skipped (in-package :uiop/version) (with-upgradability () - (defparameter *uiop-version* "3.3.2") + (defparameter *uiop-version* "3.3.3") (defun unparse-version (version-list) "From a parsed version (a list of natural numbers), compute the version string" @@ -2335,8 +2360,8 @@ by the underlying implementation's MAKE-PATHNAME and other primitives" ;; See CLHS make-pathname and 19.2.2.2.3. ;; This will be :unspecific if supported, or NIL if not. (defparameter *unspecific-pathname-type* - #+(or abcl allegro clozure cmucl genera lispworks sbcl scl) :unspecific - #+(or clasp clisp ecl mkcl gcl xcl #|These haven't been tested:|# cormanlisp mcl mezzano) nil + #+(or abcl allegro clozure cmucl lispworks sbcl scl) :unspecific + #+(or genera clasp clisp ecl mkcl gcl xcl #|These haven't been tested:|# cormanlisp mcl mezzano) nil "Unspecific type component to use with the underlying implementation's MAKE-PATHNAME") (defun make-pathname* (&rest keys &key directory host device name type version defaults @@ -2574,7 +2599,14 @@ actually-existing directory." (make-pathname :directory (append (or (normalize-pathname-directory-component (pathname-directory pathspec)) (list :relative)) - (list (file-namestring pathspec))) + (list #-genera (file-namestring pathspec) + ;; On Genera's native filesystem (LMFS), + ;; directories have a type and version + ;; which must be ignored when converting + ;; to a directory pathname + #+genera (if (typep pathspec 'fs:lmfs-pathname) + (pathname-name pathspec) + (file-namestring pathspec)))) :name nil :type nil :version nil :defaults pathspec) (error (c) (call-function on-error (compatfmt "~@<error while trying to create a directory pathname for ~S: ~A~@:>") pathspec c))))))) @@ -3056,7 +3088,13 @@ a CL pathname satisfying all the specified constraints as per ENSURE-PATHNAME" (or (ignore-errors (truename p)) ;; this is here because trying to find the truename of a directory pathname WITHOUT supplying ;; a trailing directory separator, causes an error on some lisps. - #+(or clisp gcl) (if-let (d (ensure-directory-pathname p nil)) (ignore-errors (truename d))))))) + #+(or clisp gcl) (if-let (d (ensure-directory-pathname p nil)) (ignore-errors (truename d))) + ;; On Genera, truename of a directory pathname will probably fail as Genera + ;; will merge in a filename/type/version from *default-pathname-defaults* and + ;; will try to get the truename of a file that probably doesn't exist. + #+genera (when (directory-pathname-p p) + (let ((d (scl:send p :directory-pathname-as-file))) + (ensure-directory-pathname (ignore-errors (truename d)) nil))))))) (defun safe-file-write-date (pathname) "Safe variant of FILE-WRITE-DATE that may return NIL rather than raise an error." @@ -4832,7 +4870,6 @@ or COMPRESSION on SBCL, and APPLICATION-TYPE on SBCL/Windows." (shell-boolean-exit (restore-image)))))))) (when forms `(progn ,@forms)))))) - #+(or clasp ecl mkcl) (check-type kind (member :dll :shared-library :lib :static-library :fasl :fasb :program)) (apply #+clasp 'cmp:builder #+clasp kind @@ -5209,12 +5246,28 @@ Simple means made of symbols, numbers, characters, simple-strings, pathnames, co (sb-c::undefined-warning-kind warning) (sb-c::undefined-warning-name warning) (sb-c::undefined-warning-count warning) + ;; the COMPILER-ERROR-CONTEXT struct has changed in SBCL, which means how we + ;; handle deferred warnings must change... TODO: when enough time has + ;; gone by, just assume all versions of SBCL are adequately + ;; up-to-date, and cut this material.[2018/05/30:rpg] (mapcar #'(lambda (frob) ;; the lexenv slot can be ignored for reporting purposes - `(:enclosing-source ,(sb-c::compiler-error-context-enclosing-source frob) - :source ,(sb-c::compiler-error-context-source frob) - :original-source ,(sb-c::compiler-error-context-original-source frob) + `( + #- #.(uiop/utility:symbol-test-to-feature-expression '#:compiler-error-context-%source '#:sb-c) + ,@`(:enclosing-source + ,(sb-c::compiler-error-context-enclosing-source frob) + :source + ,(sb-c::compiler-error-context-source frob) + :original-source + ,(sb-c::compiler-error-context-original-source frob)) + #+ #.(uiop/utility:symbol-test-to-feature-expression '#:compiler-error-context-%source '#:sb-c) + ,@ `(:%enclosing-source + ,(sb-c::compiler-error-context-enclosing-source frob) + :%source + ,(sb-c::compiler-error-context-source frob) + :original-form + ,(sb-c::compiler-error-context-original-form frob)) :context ,(sb-c::compiler-error-context-context frob) :file-name ,(sb-c::compiler-error-context-file-name frob) ; a pathname :file-position ,(sb-c::compiler-error-context-file-position frob) ; an integer @@ -5565,9 +5618,10 @@ it will filter them appropriately." (with-saved-deferred-warnings (warnings-file :source-namestring (namestring input-file)) (with-muffled-compiler-conditions () (or #-(or clasp ecl mkcl) - (apply 'compile-file input-file :output-file tmp-file - #+sbcl (if emit-cfasl (list* :emit-cfasl tmp-cfasl keywords) keywords) - #-sbcl keywords) + (let (#+genera (si:*common-lisp-syntax-is-ansi-common-lisp* t)) + (apply 'compile-file input-file :output-file tmp-file + #+sbcl (if emit-cfasl (list* :emit-cfasl tmp-cfasl keywords) keywords) + #-sbcl keywords)) #+ecl (apply 'compile-file input-file :output-file (if object-file (list* object-file :system-p t keywords) @@ -5619,19 +5673,20 @@ it will filter them appropriately." (defun load* (x &rest keys &key &allow-other-keys) "Portable wrapper around LOAD that properly handles loading from a stream." (with-muffled-loader-conditions () - (etypecase x - ((or pathname string #-(or allegro clozure genera) stream #+clozure file-stream) - (apply 'load x keys)) - ;; Genera can't load from a string-input-stream - ;; ClozureCL 1.6 can only load from file input stream - ;; Allegro 5, I don't remember but it must have been broken when I tested. - #+(or allegro clozure genera) - (stream ;; make do this way - (let ((*package* *package*) - (*readtable* *readtable*) - (*load-pathname* nil) - (*load-truename* nil)) - (eval-input x)))))) + (let (#+genera (si:*common-lisp-syntax-is-ansi-common-lisp* t)) + (etypecase x + ((or pathname string #-(or allegro clozure genera) stream #+clozure file-stream) + (apply 'load x keys)) + ;; Genera can't load from a string-input-stream + ;; ClozureCL 1.6 can only load from file input stream + ;; Allegro 5, I don't remember but it must have been broken when I tested. + #+(or allegro clozure genera) + (stream ;; make do this way + (let ((*package* *package*) + (*readtable* *readtable*) + (*load-pathname* nil) + (*load-truename* nil)) + (eval-input x))))))) (defun load-from-string (string) "Portably read and evaluate forms from a STRING." @@ -6930,7 +6985,7 @@ or an indication of failure via the EXIT-CODE of the process" (uiop/package:define-package :uiop/configuration (:recycle :uiop/configuration :asdf/configuration) ;; necessary to upgrade from 2.27. - (:use :uiop/common-lisp :uiop/utility + (:use :uiop/package :uiop/common-lisp :uiop/utility :uiop/os :uiop/pathname :uiop/filesystem :uiop/stream :uiop/image :uiop/lisp-build) (:export #:user-configuration-directories #:system-configuration-directories ;; implemented in backward-driver @@ -6945,7 +7000,8 @@ or an indication of failure via the EXIT-CODE of the process" #:report-invalid-form #:invalid-configuration #:*ignored-configuration-form* #:*user-cache* #:*clear-configuration-hook* #:clear-configuration #:register-clear-configuration-hook #:resolve-location #:location-designator-p #:location-function-p #:*here-directory* - #:resolve-relative-location #:resolve-absolute-location #:upgrade-configuration)) + #:resolve-relative-location #:resolve-absolute-location #:upgrade-configuration + #:uiop-directory)) (in-package :uiop/configuration) (with-upgradability () @@ -7337,7 +7393,28 @@ or just the first one (for direction :output or :io). "Compute (and return) the location of the default user-cache for translate-output objects. Side-effects for cached file location computation." (setf *user-cache* (xdg-cache-home "common-lisp" :implementation))) - (register-image-restore-hook 'compute-user-cache)) + (register-image-restore-hook 'compute-user-cache) + + (defun uiop-directory () + "Try to locate the UIOP source directory at runtime" + (labels ((pf (x) (ignore-errors (probe-file* x))) + (sub (x y) (pf (subpathname x y))) + (ssd (x) (ignore-errors (symbol-call :asdf :system-source-directory x)))) + ;; NB: conspicuously *not* including searches based on #.(current-lisp-pathname) + (or + ;; Look under uiop if available as source override, under asdf if avaiable as source + (ssd "uiop") + (sub (ssd "asdf") "uiop/") + ;; Look in recommended path for user-visible source installation + (sub (user-homedir-pathname) "common-lisp/asdf/uiop/") + ;; Look in XDG paths under known package names for user-invisible source installation + (xdg-data-pathname "common-lisp/source/asdf/uiop/") + (xdg-data-pathname "common-lisp/source/cl-asdf/uiop/") ; traditional Debian location + ;; The last one below is useful for Fare, primary (sole?) known user + (sub (user-homedir-pathname) "cl/asdf/uiop/") + (cerror "Configure source registry to include UIOP source directory and retry." + "Unable to find UIOP directory") + (uiop-directory))))) ;;; ------------------------------------------------------------------------- ;;; Hacks for backward-compatibility with older versions of UIOP @@ -7372,7 +7449,8 @@ DEPRECATED. Use UIOP:XDG-CONFIG-PATHNAMES instead." (xdg-config-pathnames "common-lisp")) (defun system-configuration-directories () "Return the list of system configuration directories for common-lisp. -DEPRECATED. Use UIOP:CONFIG-SYSTEM-PATHNAMES instead." +DEPRECATED. Use UIOP:SYSTEM-CONFIG-PATHNAMES (with argument \"common-lisp\"), +instead." (system-config-pathnames "common-lisp")) (defun in-first-directory (dirs x &key (direction :input)) "Finds the first appropriate file named X in the list of DIRS for I/O @@ -7521,7 +7599,7 @@ previously-loaded version of ASDF." ;; "3.4.5.67" would be a development version in the official branch, on top of 3.4.5. ;; "3.4.5.0.8" would be your eighth local modification of official release 3.4.5 ;; "3.4.5.67.8" would be your eighth local modification of development version 3.4.5.67 - (asdf-version "3.3.2") + (asdf-version "3.3.3") (existing-version (asdf-version))) (setf *asdf-version* asdf-version) (when (and existing-version (not (equal asdf-version existing-version))) @@ -7534,7 +7612,7 @@ previously-loaded version of ASDF." ;;; Upon upgrade, specially frob some functions and classes that are being incompatibly redefined (when-upgrading () (let* ((previous-version (first *previous-asdf-versions*)) - (redefined-functions ;; List of functions that changes incompatibly since 2.27: + (redefined-functions ;; List of functions that changed incompatibly since 2.27: ;; gf signature changed (should NOT happen), defun that became a generic function, ;; method removed that will mess up with new ones (especially :around :before :after, ;; more specific or call-next-method'ed method) and/or semantics otherwise modified. Oops. @@ -7545,8 +7623,8 @@ previously-loaded version of ASDF." ;; Also note that we don't include the defgeneric=>defun, because they are ;; done directly with defun* and need not trigger a punt on data. ;; See discussion at https://gitlab.common-lisp.net/asdf/asdf/merge_requests/36 - `(,@(when (version<= previous-version "3.1.2") '(#:component-depends-on #:input-files)) ;; crucial methods *removed* before 3.1.2 - ,@(when (version<= previous-version "3.1.7.20") '(#:find-component)))) + `(,@(when (version< previous-version "3.1.2") '(#:component-depends-on #:input-files)) ;; crucial methods *removed* before 3.1.2 + ,@(when (version< previous-version "3.1.7.20") '(#:find-component)))) (redefined-classes ;; redefining the classes causes interim circularities ;; with the old ASDF during upgrade, and many implementations bork @@ -7883,9 +7961,9 @@ or NIL for top-level components (a.k.a. systems)")) (defmethod component-parent ((component null)) nil) ;; Deprecated: Backward compatible way of computing the FILE-TYPE of a component. - ;; TODO: find users, have them stop using that, remove it for ASDF4. - (defgeneric source-file-type (component system) - (:documentation "DEPRECATED. Use the FILE-TYPE of a COMPONENT instead.")) + (with-asdf-deprecation (:style-warning "3.4") + (defgeneric source-file-type (component system) + (:documentation "DEPRECATED. Use the FILE-TYPE of a COMPONENT instead."))) (define-condition duplicate-names (system-definition-error) ((name :initarg :name :reader duplicate-names-name)) @@ -8222,6 +8300,7 @@ Use of INITARGS is not supported at this time." #:system-source-file #:system-source-directory #:system-relative-pathname #:system-description #:system-long-description #:system-author #:system-maintainer #:system-licence #:system-license + #:system-version #:definition-dependency-list #:definition-dependency-set #:system-defsystem-depends-on #:system-depends-on #:system-weakly-depends-on #:component-build-pathname #:build-pathname @@ -8243,8 +8322,10 @@ Use of INITARGS is not supported at this time." If no system is found, then signal an error if ERROR-P is true (the default), or else return NIL. A system designator is usually a string (conventionally all lowercase) or a symbol, designating the same system as its downcased name; it can also be a system object (designating itself).")) + (defgeneric system-source-file (system) (:documentation "Return the source file in which system is defined.")) + ;; This is bad design, but was the easiest kluge I found to let the user specify that ;; some special actions create outputs at locations controled by the user that are not affected ;; by the usual output-translations. @@ -8263,6 +8344,7 @@ NB: This interface is subject to change. Please contact ASDF maintainers if you (with no argument) when running an image dumped from the COMPONENT. NB: This interface is subject to change. Please contact ASDF maintainers if you use it.")) + (defmethod component-entry-point ((c component)) nil)) @@ -8287,19 +8369,21 @@ a SYSTEM is redefined and its class is modified.")) (defclass system (module proto-system) ;; Backward-compatibility: inherit from module. ASDF4: only inherit from parent-component. (;; {,long-}description is now inherited from component, but we add the legacy accessors - (description :accessor system-description) - (long-description :accessor system-long-description) - (author :accessor system-author :initarg :author :initform nil) - (maintainer :accessor system-maintainer :initarg :maintainer :initform nil) - (licence :accessor system-licence :initarg :licence - :accessor system-license :initarg :license :initform nil) - (homepage :accessor system-homepage :initarg :homepage :initform nil) - (bug-tracker :accessor system-bug-tracker :initarg :bug-tracker :initform nil) - (mailto :accessor system-mailto :initarg :mailto :initform nil) - (long-name :accessor system-long-name :initarg :long-name :initform nil) + (description :writer (setf system-description)) + (long-description :writer (setf system-long-description)) + (author :writer (setf system-author) :initarg :author :initform nil) + (maintainer :writer (setf system-maintainer) :initarg :maintainer :initform nil) + (licence :writer (setf system-licence) :initarg :licence + :writer (setf system-license) :initarg :license + :initform nil) + (homepage :writer (setf system-homepage) :initarg :homepage :initform nil) + (bug-tracker :writer (setf system-bug-tracker) :initarg :bug-tracker :initform nil) + (mailto :writer (setf system-mailto) :initarg :mailto :initform nil) + (long-name :writer (setf system-long-name) :initarg :long-name :initform nil) ;; Conventions for this slot aren't clear yet as of ASDF 2.27, but whenever they are, they will be enforced. ;; I'm introducing the slot before the conventions are set for maximum compatibility. - (source-control :accessor system-source-control :initarg :source-control :initform nil) + (source-control :writer (setf system-source-control) :initarg :source-control :initform nil) + (builtin-system-p :accessor builtin-system-p :initform nil :initarg :builtin-system-p) (build-pathname :initform nil :initarg :build-pathname :accessor component-build-pathname) @@ -8375,6 +8459,35 @@ NB: The onus is unhappily on the user to avoid clashes." (frob-substrings (coerce-name name) '("/" ":" "\\") "--"))) +;;; System virtual slot readers, recursing to the primary system if needed. +(with-upgradability () + (defvar *system-virtual-slots* '(long-name description long-description + author maintainer mailto + homepage source-control + licence version bug-tracker) + "The list of system virtual slot names.") + (defun system-virtual-slot-value (system slot-name) + "Return SYSTEM's virtual SLOT-NAME value. +If SYSTEM's SLOT-NAME value is NIL and SYSTEM is a secondary system, look in +the primary one." + (or (slot-value system slot-name) + (unless (primary-system-p system) + (slot-value (find-system (primary-system-name system)) + slot-name)))) + (defmacro define-system-virtual-slot-reader (slot-name) + `(defun* ,(intern (concatenate 'string (string :system-) + (string slot-name))) + (system) + (system-virtual-slot-value system ',slot-name))) + (defmacro define-system-virtual-slot-readers () + `(progn ,@(mapcar (lambda (slot-name) + `(define-system-virtual-slot-reader ,slot-name)) + *system-virtual-slots*))) + (define-system-virtual-slot-readers) + (defun system-license (system) + (system-virtual-slot-value system 'licence))) + + ;;;; Pathnames (with-upgradability () @@ -10786,8 +10899,9 @@ Do NOT try to load a .asd file directly with CL:LOAD. Always use ASDF:LOAD-ASD." (defvar *old-asdf-systems* (make-hash-table :test 'equal)) ;; (Private) function to check that a system that was found isn't an asdf downgrade. - ;; Returns T if everything went right, NIL if the system was an ASDF of the same or older version, - ;; that shall not be loaded. Also issue a warning if it was a strictly older version of ASDF. + ;; Returns T if everything went right, NIL if the system was an ASDF at an older version, + ;; or UIOP of the same or older version, that shall not be loaded. + ;; Also issue a warning if it was a strictly older version of ASDF. (defun check-not-old-asdf-system (name pathname) (or (not (member name '("asdf" "uiop") :test 'equal)) (null pathname) @@ -10798,9 +10912,12 @@ Do NOT try to load a .asd file directly with CL:LOAD. Always use ASDF:LOAD-ASD." (read-file-form version-pathname :at (if asdfp '(0) '(2 2 2))))) (old-version (asdf-version))) (cond - ;; Don't load UIOP of the exact same version: we already loaded it as part of ASDF. - ((and (equal old-version version) (equal name "uiop")) nil) - ((version<= old-version version) t) ;; newer or same version: Good! + ;; Same version is OK for ASDF, to allow loading from modified source. + ;; However, do *not* load UIOP of the exact same version: + ;; it was already loaded it as part of ASDF and would only be double-loading. + ;; Be quiet about it, though, since it's a normal situation. + ((equal old-version version) asdfp) + ((version< old-version version) t) ;; newer version: Good! (t ;; old version: bad (ensure-gethash (list (namestring pathname) version) *old-asdf-systems* @@ -10962,6 +11079,8 @@ PREVIOUS-PRIMARY when not null is the primary system for the PREVIOUS system." #:class-for-type #:*default-component-class* #:determine-system-directory #:parse-component-form #:non-toplevel-system #:non-system-system #:bad-system-name + #:*known-systems-with-bad-secondary-system-names* + #:known-system-with-bad-secondary-system-names-p #:sysdef-error-component #:check-component-input #:explain)) (in-package :asdf/parse-defsystem) @@ -11114,7 +11233,7 @@ Please only define ~S and secondary systems with a name starting with ~S (e.g. ~ ;;; "inline methods" (with-upgradability () (defparameter* +asdf-methods+ - '(perform-with-restarts perform explain output-files operation-done-p)) + '(perform-with-restarts perform explain output-files operation-done-p)) (defun %remove-component-inline-methods (component) (dolist (name +asdf-methods+) @@ -11127,19 +11246,55 @@ Please only define ~S and secondary systems with a name starting with ~S (e.g. ~ (component-inline-methods component))) (component-inline-methods component) nil) + (defparameter *standard-method-combination-qualifiers* + '(:around :before :after)) + +;;; Find inline method definitions of the form +;;; +;;; :perform (test-op :before (operation component) ...) +;;; +;;; in REST (which is the plist of all DEFSYSTEM initargs) and define the specified methods. (defun %define-component-inline-methods (ret rest) + ;; find key-value pairs that look like inline method definitions in REST. For each identified + ;; definition, parse it and, if it is well-formed, define the method. (loop* :for (key value) :on rest :by #'cddr :for name = (and (keywordp key) (find key +asdf-methods+ :test 'string=)) :when name :do - (destructuring-bind (op &rest body) value - (loop :for arg = (pop body) - :while (atom arg) - :collect arg :into qualifiers - :finally - (destructuring-bind (o c) arg - (pushnew - (eval `(defmethod ,name ,@qualifiers ((,o ,op) (,c (eql ,ret))) ,@body)) - (component-inline-methods ret))))))) + ;; parse VALUE as an inline method definition of the form + ;; + ;; (OPERATION-NAME [QUALIFIER] (OPERATION-PARAMETER COMPONENT-PARAMETER) &rest BODY) + (destructuring-bind (operation-name &rest rest) value + (let ((qualifiers '())) + ;; ensure that OPERATION-NAME is a symbol. + (unless (and (symbolp operation-name) (not (null operation-name))) + (sysdef-error "Ill-formed inline method: ~S. The first element is not a symbol ~ + designating an operation but ~S." + value operation-name)) + ;; ensure that REST starts with either a cons (potential lambda list, further checked + ;; below) or a qualifier accepted by the standard method combination. Everything else + ;; is ill-formed. In case of a valid qualifier, pop it from REST so REST now definitely + ;; has to start with the lambda list. + (cond + ((consp (car rest))) + ((not (member (car rest) + *standard-method-combination-qualifiers*)) + (sysdef-error "Ill-formed inline method: ~S. Only a single of the standard ~ + qualifiers ~{~S~^ ~} is allowed, not ~S." + value *standard-method-combination-qualifiers* (car rest))) + (t + (setf qualifiers (list (pop rest))))) + ;; REST must start with a two-element lambda list. + (unless (and (listp (car rest)) + (length=n-p (car rest) 2) + (null (cddar rest))) + (sysdef-error "Ill-formed inline method: ~S. The operation name ~S is not followed by ~ + a lambda-list of the form (OPERATION COMPONENT) and a method body." + value operation-name)) + ;; define the method. + (destructuring-bind ((o c) &rest body) rest + (pushnew + (eval `(defmethod ,name ,@qualifiers ((,o ,operation-name) (,c (eql ,ret))) ,@body)) + (component-inline-methods ret))))))) (defun %refresh-component-inline-methods (component rest) ;; clear methods, then add the new ones @@ -11253,6 +11408,13 @@ system names contained using COERCE-NAME. Return the result." (coerce-name (component-system component)))) component))) + (defparameter* *known-systems-with-bad-secondary-system-names* + (list-to-hash-set '("cl-ppcre"))) + (defun known-system-with-bad-secondary-system-names-p (asd-name) + ;; Does .asd file with name ASD-NAME contain known exceptions + ;; that should be screened out of checking for BAD-SYSTEM-NAME? + (gethash asd-name *known-systems-with-bad-secondary-system-names*)) + (defun register-system-definition (name &rest options &key pathname (class 'system) (source-file () sfp) defsystem-depends-on &allow-other-keys) @@ -11270,8 +11432,11 @@ system names contained using COERCE-NAME. Return the result." (let* ((asd-name (and source-file (equal "asd" (fix-case (pathname-type source-file))) (fix-case (pathname-name source-file)))) + ;; note that PRIMARY-NAME is a *syntactically* primary name (primary-name (primary-system-name name))) - (when (and asd-name (not (equal asd-name primary-name))) + (when (and asd-name + (not (equal asd-name primary-name)) + (not (known-system-with-bad-secondary-system-names-p asd-name))) (warn (make-condition 'bad-system-name :source-file source-file :name name)))) (let* (;; NB: handle defsystem-depends-on BEFORE to create the system object, ;; so that in case it fails, there is no incomplete object polluting the build. @@ -11833,8 +11998,17 @@ which is probably not what you want; you probably need to tweak your output tran :static-library (resolve-symlinks* pathname)))) (defun linkable-system (x) - (or (if-let (s (find-system x)) + (or ;; If the system is available as source, use it. + (if-let (s (find-system x)) + (and (output-files 'lib-op s) s)) + ;; If an ASDF upgrade is available from source, but not a UIOP upgrade to that, + ;; then use the asdf/driver system instead of + ;; the UIOP that was disabled by check-not-old-asdf-system. + (if-let (s (and (equal (coerce-name x) "uiop") + (output-files 'lib-op "asdf") + (find-system "asdf/driver"))) (and (output-files 'lib-op s) s)) + ;; If there was no source upgrade, look for modules provided by the implementation. (if-let (p (system-module-pathname (coerce-name x))) (make-prebuilt-system x p)))) @@ -12567,7 +12741,7 @@ after having found a .asd file? True by default.") (recurse-beyond-asds *recurse-beyond-asds*) ignore-cache) (let ((visited (make-hash-table :test 'equalp))) (flet ((collectp (dir) - (unless (and (not ignore-cache) (process-source-registry-cache directory collect)) + (unless (and (not ignore-cache) (process-source-registry-cache dir collect)) (let ((asds (collect-asds-in-directory dir collect))) (or recurse-beyond-asds (not asds))))) (recursep (x) ; x will be a directory pathname @@ -13225,6 +13399,7 @@ system or its dependencies if it has already been loaded." #:system-maintainer #:system-license #:system-licence + #:system-version #:system-source-file #:system-source-directory #:system-relative-pathname diff --git a/src/contrib/asdf/doc/asdf.html b/src/contrib/asdf/doc/asdf.html index ca1117fb13b86d6c89d0d53e4e7c57135ae3b8c2..6dac4e2f5d9b4397ee904aafda9e5e849e77d3da 100644 --- a/src/contrib/asdf/doc/asdf.html +++ b/src/contrib/asdf/doc/asdf.html @@ -6,11 +6,11 @@ for Common Lisp programs and libraries. You can find the latest version of this manual at https://common-lisp.net/project/asdf/asdf.html. -ASDF Copyright (C) 2001-2016 Daniel Barlow and contributors. +ASDF Copyright (C) 2001-2019 Daniel Barlow and contributors. -This manual Copyright (C) 2001-2016 Daniel Barlow and contributors. +This manual Copyright (C) 2001-2019 Daniel Barlow and contributors. -This manual revised (C) 2009-2016 Robert P. Goldman and Francois-Rene Rideau. +This manual revised (C) 2009-2019 Robert P. Goldman and Francois-Rene Rideau. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -31,8 +31,9 @@ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. --> -<!-- Created by GNU Texinfo 6.1, http://www.gnu.org/software/texinfo/ --> +<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ --> <head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>ASDF Manual</title> <meta name="description" content="ASDF Manual"> @@ -40,7 +41,6 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <link href="#Top" rel="start" title="Top"> <link href="#Concept-Index" rel="index" title="Concept Index"> <link href="#SEC_Contents" rel="contents" title="Table of Contents"> @@ -118,21 +118,24 @@ ul.no-bullet {list-style: none} <li><a name="toc-A-more-involved-example-1" href="#A-more-involved-example">6.2 A more involved example</a></li> <li><a name="toc-The-defsystem-grammar-1" href="#The-defsystem-grammar">6.3 The defsystem grammar</a> <ul class="no-bullet"> - <li><a name="toc-Component-names" href="#Component-names">6.3.1 Component names</a></li> - <li><a name="toc-Component-types" href="#Component-types">6.3.2 Component types</a></li> - <li><a name="toc-System-class-names" href="#System-class-names">6.3.3 System class names</a></li> - <li><a name="toc-Defsystem-depends-on" href="#Defsystem-depends-on">6.3.4 Defsystem depends on</a></li> - <li><a name="toc-Build_002doperation" href="#Build_002doperation">6.3.5 Build-operation</a></li> - <li><a name="toc-Weakly-depends-on" href="#Weakly-depends-on">6.3.6 Weakly depends on</a></li> - <li><a name="toc-Pathname-specifiers" href="#Pathname-specifiers">6.3.7 Pathname specifiers</a></li> - <li><a name="toc-Version-specifiers" href="#Version-specifiers">6.3.8 Version specifiers</a></li> - <li><a name="toc-Require" href="#Require">6.3.9 Require</a></li> - <li><a name="toc-Feature-dependencies" href="#Feature-dependencies">6.3.10 Feature dependencies</a></li> - <li><a name="toc-Using-logical-pathnames" href="#Using-logical-pathnames">6.3.11 Using logical pathnames</a></li> - <li><a name="toc-Serial-dependencies" href="#Serial-dependencies">6.3.12 Serial dependencies</a></li> - <li><a name="toc-Source-location-_0028_003apathname_0029" href="#Source-location-_0028_003apathname_0029">6.3.13 Source location (<code>:pathname</code>)</a></li> - <li><a name="toc-if_002dfeature-option" href="#if_002dfeature-option">6.3.14 if-feature option</a></li> - <li><a name="toc-feature-requirement" href="#feature-requirement">6.3.15 feature requirement</a></li> + <li><a name="toc-System-designators" href="#System-designators">6.3.1 System designators</a></li> + <li><a name="toc-Simple-component-names-_0028simple_002dcomponent_002dname_0029" href="#Simple-component-names-_0028simple_002dcomponent_002dname_0029">6.3.2 Simple component names (<code>simple-component-name</code>)</a></li> + <li><a name="toc-Complex-component-names" href="#Complex-component-names">6.3.3 Complex component names</a></li> + <li><a name="toc-Component-types-1" href="#Component-types-1">6.3.4 Component types</a></li> + <li><a name="toc-System-class-names-1" href="#System-class-names-1">6.3.5 System class names</a></li> + <li><a name="toc-Defsystem-depends-on" href="#Defsystem-depends-on">6.3.6 Defsystem depends on</a></li> + <li><a name="toc-Build_002doperation-1" href="#Build_002doperation-1">6.3.7 Build-operation</a></li> + <li><a name="toc-Weakly-depends-on" href="#Weakly-depends-on">6.3.8 Weakly depends on</a></li> + <li><a name="toc-Pathname-specifiers-1" href="#Pathname-specifiers-1">6.3.9 Pathname specifiers</a></li> + <li><a name="toc-Version-specifiers-1" href="#Version-specifiers-1">6.3.10 Version specifiers</a></li> + <li><a name="toc-Require" href="#Require">6.3.11 Require</a></li> + <li><a name="toc-Feature-dependencies-1" href="#Feature-dependencies-1">6.3.12 Feature dependencies</a></li> + <li><a name="toc-Using-logical-pathnames-1" href="#Using-logical-pathnames-1">6.3.13 Using logical pathnames</a></li> + <li><a name="toc-Serial-dependencies" href="#Serial-dependencies">6.3.14 Serial dependencies</a></li> + <li><a name="toc-Source-location-_0028_003apathname_0029" href="#Source-location-_0028_003apathname_0029">6.3.15 Source location (<code>:pathname</code>)</a></li> + <li><a name="toc-if_002dfeature-option-1" href="#if_002dfeature-option-1">6.3.16 if-feature option</a></li> + <li><a name="toc-Entry-point-1" href="#Entry-point-1">6.3.17 Entry point</a></li> + <li><a name="toc-feature-requirement-1" href="#feature-requirement-1">6.3.18 feature requirement</a></li> </ul></li> <li><a name="toc-Other-code-in-_002easd-files-1" href="#Other-code-in-_002easd-files">6.4 Other code in .asd files</a></li> <li><a name="toc-The-package_002dinferred_002dsystem-extension-1" href="#The-package_002dinferred_002dsystem-extension">6.5 The package-inferred-system extension</a></li> @@ -266,8 +269,9 @@ ul.no-bullet {list-style: none} <li><a name="toc-Ongoing-Work-1" href="#Ongoing-Work">Ongoing Work</a></li> <li><a name="toc-Bibliography-1" href="#Bibliography">Bibliography</a></li> <li><a name="toc-Concept-Index-1" href="#Concept-Index">Concept Index</a></li> - <li><a name="toc-Function-and-Class-Index-1" href="#Function-and-Class-Index">Function and Class Index</a></li> + <li><a name="toc-Function-and-Macro-Index-1" href="#Function-and-Macro-Index">Function and Macro Index</a></li> <li><a name="toc-Variable-Index-1" href="#Variable-Index">Variable Index</a></li> + <li><a name="toc-Class-and-Type-Index-1" href="#Class-and-Type-Index">Class and Type Index</a></li> </ul> </div> @@ -277,7 +281,7 @@ ul.no-bullet {list-style: none} <a name="Top"></a> <a name="ASDF_003a-Another-System-Definition-Facility"></a> <h1 class="top">ASDF: Another System Definition Facility</h1> -<p>Manual for Version 3.3.2 +<p>Manual for Version 3.3.3 </p> <p>This manual describes ASDF, a system definition facility @@ -286,11 +290,11 @@ for Common Lisp programs and libraries. <p>You can find the latest version of this manual at <a href="https://common-lisp.net/project/asdf/asdf.html">https://common-lisp.net/project/asdf/asdf.html</a>. </p> -<p>ASDF Copyright © 2001-2016 Daniel Barlow and contributors. +<p>ASDF Copyright © 2001-2019 Daniel Barlow and contributors. </p> -<p>This manual Copyright © 2001-2016 Daniel Barlow and contributors. +<p>This manual Copyright © 2001-2019 Daniel Barlow and contributors. </p> -<p>This manual revised © 2009-2016 Robert P. Goldman and Francois-Rene Rideau. +<p>This manual revised © 2009-2019 Robert P. Goldman and Francois-Rene Rideau. </p> <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -328,7 +332,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. <a name="index-_003aasdf2"></a> <a name="index-_003aasdf3"></a> -<p>ASDF is Another System Definition Facility: +<p>ASDF, or Another System Definition Facility, is a <em>build system</em>: a tool for specifying how systems of Common Lisp software are made up of components (sub-systems and files), and how to operate on these components in the right order @@ -355,8 +359,8 @@ it plays a role like <code>make</code> or <code>ant</code>, not like a package m In particular, ASDF should not to be confused with Quicklisp or ASDF-Install, that attempt to find and download ASDF systems for you. Despite what the name might suggest, -ASDF-Install was never a part of ASDF, it was a separate piece of software. -ASDF-Install is also unmaintained and obsolete. +ASDF-Install was never a part of ASDF; it was always a separate piece of software. +ASDF-Install has also been unmaintained and obsolete for a very long time. We recommend you use Quicklisp (<a href="http://www.quicklisp.org/">http://www.quicklisp.org/</a>) instead, a Common Lisp package manager which works well and is being actively maintained. @@ -862,15 +866,17 @@ ASDF hooks into the <code>cl:require</code> facility and you can just use: <pre class="example">(require :<var>foo</var>) </pre></div> -<p>Note that the canonical name of a system is a string, conventionally lowercase. -A system name can also be specified as a symbol (including a keyword), -in which case its <code>symbol-name</code> is taken and lowercased. +<p>Note that the canonical name of a system is a string, in <em>lowercase</em>. +System names can also be specified as symbols (including keyword +symbols). +If a symbol is given as argument, its package is ignored, +its <code>symbol-name</code> is taken, and converted to lowercase. The name must be a suitable value for the <code>:name</code> initarg to <code>make-pathname</code> in whatever filesystem the system is to be found. </p> -<p>The lower-casing-symbols behaviour is unconventional, +<p>Using lowercase as canonical is unconventional, but was selected after some consideration. -The type of systems we want to support +The type of file systems we support either have lowercase as customary case (Unix, Mac, Windows) or silently convert lowercase to uppercase (lpns). </p> @@ -912,19 +918,14 @@ compiling, loading and testing. </p> -<a name="index-_002aload_002dsystem_002doperation_002a"></a> <a name="index-already_002dloaded_002dsystems"></a> <dl> <dt><a name="index-load_002dsystem"></a>Function: <strong>load-system</strong> <em>system &rest keys &key force force-not verbose version &allow-other-keys</em></dt> -<dd><p>Apply <code>operate</code> with the operation from -<code>*load-system-operation*</code> -the <var>system</var>, and any provided keyword arguments. -<code>*load-system-operation*</code> by default is <code>load-op</code>; -it would be <code>load-bundle-op</code> by default on ECL, -if only an implementation bug were fixed. -Calling <code>load-system</code> is the regular, recommended way -to load a system into the current image. +<dd><p>Apply <code>operate</code> with the operation <code>load-op</code>, the +<var>system</var>, and any provided keyword arguments. Calling +<code>load-system</code> is the regular, recommended way to load a system +into the current image. </p></dd></dl> <dl> @@ -954,7 +955,7 @@ The default behaviour is to load the system as if by <code>load-system</code>; but system authors can override this default in their system definition they may specify an alternate operation as the intended use of their system, with a <code>:build-operation</code> option in the <code>defsystem</code> form -(see <a href="#The-defsystem-grammar">build-operation</a>), +(see <a href="#Build_002doperation">Build-operation</a>), and an intended output pathname for that operation with <code>:build-pathname</code>. This function is experimental and largely untested. Use at your own risk. @@ -1078,7 +1079,7 @@ especially if you intend your software to be eventually included in Quicklisp. </li><li> Make sure you know how the <code>:version</code> numbers will be parsed! Only period-separated non-negative integers are accepted at present. -See below Version specifiers in <a href="#The-defsystem-grammar">The defsystem grammar</a>. +See <a href="#Version-specifiers">Version specifiers</a>. </li><li> This file contains a single form, the <code>defsystem</code> declaration. No <code>in-package</code> form, no <code>asdf:</code> package prefix, no nothing. @@ -1152,7 +1153,7 @@ in the same directory, or in a different subdirectory; see the discussion of the <code>:pathname</code> option in <a href="#The-defsystem-grammar">The defsystem grammar</a>). </li><li> The <code>:serial t</code> says that each sub-component of <code>mod</code> depends on the previous components, -so that <samp>cooker.lisp</samp> depends-on <samp>utils.lisp</samp>, which depends-on <samp>reader.lisp</samp>. +so that <samp>cooker.lisp</samp> depends-on <samp>reader.lisp</samp>, which depends-on <samp>utils.lisp</samp>. Also <samp>data.raw</samp> depends on all of them, but that doesn’t matter since it’s a static file; on the other hand, if it appeared first, then all the Lisp files would be recompiled when the data is modified, which is probably not what is desired in this case. @@ -1270,11 +1271,19 @@ Presumably, the 4th form looks like <code>(defparameter *foo-version* "5.6. <div class="example"> -<pre class="example">system-definition := ( defsystem system-designator <var>system-option</var>* ) +<pre class="example">system-definition := ( defsystem system-designator <var>system-option</var>*) + +system-designator := simple-component-name | complex-component-name + +simple-component-name := lower-case string | symbol + NOTE: Underscores are not permitted. See below. + +complex-component-name := string | symbol + See below. system-option := :defsystem-depends-on system-list | :weakly-depends-on <var>system-list</var> - | :class class-name (see discussion below) + | :class class-name # see <a href="#System-class-names">System class names</a> | :build-operation <var>operation-name</var> | system-option | module-option @@ -1287,6 +1296,7 @@ system-option := :homepage string | :long-name string | :source-control source-control | :version version-specifier + | :entry-point object # see <a href="#Entry-point">Entry point</a> source-control := (keyword string) @@ -1314,13 +1324,13 @@ component-def := ( component-type simple-component-name <var>option</var>* ) component-type := :module | :file | :static-file | other-component-type other-component-type := symbol-by-name - (see <a href="#The-defsystem-grammar">Component types</a>) + # see <a href="#Component-types">Component types</a> # This is used in :depends-on, as opposed to ``dependency,'' # which is used in :in-order-to dependency-def := simple-component-name | ( :feature <var>feature-expression</var> dependency-def ) - # (see <a href="#The-defsystem-grammar">Feature dependencies</a>) + # see <a href="#Feature-dependencies">Feature dependencies</a> | ( :version simple-component-name version-specifier ) | ( :require module-name ) @@ -1335,6 +1345,10 @@ simple-component-name := string | symbol pathname-specifier := pathname | string | symbol + NOTE: pathnames should be all lower case, and have no + underscores, although hyphens are permitted. + + version-specifier := string | (:read-file-form <pathname-specifier> <form-specifier>?) @@ -1343,7 +1357,8 @@ line-specifier := :at integer # base zero form-specifier := :at [ integer | ( integer+ )] method-form := (operation-name qual lambda-list &rest body) -qual := method qualifier? +qual := method-qualifier? +method-qualifier = :before | :after | :around feature-expression := keyword | (:and <var>feature-expression</var>*) @@ -1351,16 +1366,57 @@ feature-expression := keyword | (:not <var>feature-expression</var>) </pre></div> +<a name="System-designators"></a> +<h4 class="subsection">6.3.1 System designators</h4> -<a name="Component-names"></a> -<h4 class="subsection">6.3.1 Component names</h4> +<p>System designators are either simple component names, or +complex (“slashy”) component names. +</p> +<a name="Simple-component-names-_0028simple_002dcomponent_002dname_0029"></a> +<h4 class="subsection">6.3.2 Simple component names (<code>simple-component-name</code>)</h4> -<p>Component names (<code>simple-component-name</code>) -may be either strings or symbols. +<p>Simple component names may be written as either strings or symbols. </p> -<a name="Component-types"></a> -<h4 class="subsection">6.3.2 Component types</h4> +<p>When using strings, use lower case exclusively. +</p> +<p>Symbols will be interpreted as convenient shorthand for the string +that is their <code>symbol-name</code>, converted to lower case. Put +differently, a symbol may be a simple component name <em>designator</em>, +but the simple component name itself is the string. +</p> +<p><strong>Never</strong> use underscores in component names, whether written as +strings or symbols. +</p> +<p><strong>Never</strong> use slashes (“/”) in simple component names. A slash +indicates a <em>complex</em> component name; see below. Using a slash +improperly will cause ASDF to issue a warning. +</p> +<p>Violating these constraints by mixing case, or including underscores in +component names, may lead to systems or components being impossible to +find, because component names are interpreted as file names. These +problems will <em>definitely</em> occur for users who have configured ASDF +using logical pathnames. +</p> +<a name="Complex-component-names"></a> +<h4 class="subsection">6.3.3 Complex component names</h4> +<p>A complex component name is a master name followed by a slash, followed +by a subsidiary name. This allows programmers to put multiple system +definitions in a single <code>.asd</code> file, while still allowing ASDF to +find these systems. +</p> +<p>The master name of a complex system <strong>must</strong> be the same as the +name of the <code>.asd</code> file. +</p> +<p>The file <code>foo.asd</code> will contain the definition of the system +<code>"foo"</code>. However, it may <em>also</em> contain definitions of +subsidiary systems, such as <code>"foo/test"</code>, <code>"foo/docs"</code>, and so +forth. ASDF will “know” that if you ask it to load system +<code>"foo/test"</code> it should look for that system’s definition in <code>foo.asd</code>. +</p> +<a name="Component-types-1"></a> +<h4 class="subsection">6.3.4 Component types</h4> +<a name="Component-types"></a> <p>Component type names, even if expressed as keywords, will be looked up by name in the current package and in the asdf package, if not found in the current package. So a component type <code>my-component-type</code>, in @@ -1370,9 +1426,9 @@ the current package <code>my-system-asd</code> can be specified as <p><code>system</code> and its subclasses are <em>not</em> allowed as component types for such children components. </p> +<a name="System-class-names-1"></a> +<h4 class="subsection">6.3.5 System class names</h4> <a name="System-class-names"></a> -<h4 class="subsection">6.3.3 System class names</h4> - <p>A system class name will be looked up in the same way as a Component type (see above), except that only <code>system</code> and its subclasses are allowed. @@ -1393,7 +1449,7 @@ extension loaded by <code>:defsystem-depends-on</code>, causing a name conflict in the current package. </p> <a name="Defsystem-depends-on"></a> -<h4 class="subsection">6.3.4 Defsystem depends on</h4> +<h4 class="subsection">6.3.6 Defsystem depends on</h4> <a name="index-_003adefsystem_002ddepends_002don"></a> <p>The <code>:defsystem-depends-on</code> option to <code>defsystem</code> allows the @@ -1402,10 +1458,10 @@ must be loaded <em>before</em> the system definition is processed. Typically this is used to load an ASDF extension that is used in the system definition. </p> -<a name="Build_002doperation"></a> -<h4 class="subsection">6.3.5 Build-operation</h4> +<a name="Build_002doperation-1"></a> +<h4 class="subsection">6.3.7 Build-operation</h4> <a name="index-_003abuild_002doperation"></a> - +<a name="Build_002doperation"></a> <p>The <code>:build-operation</code> option to <code>defsystem</code> allows the programmer to specify an operation that will be applied, in place of <code>load-op</code> when <code>make</code> (see <a href="#Convenience-Functions">make</a>) @@ -1416,7 +1472,7 @@ value should be the name of an operation. E.g., <code>:build-operation doc-op</ experimental and largely untested. Use at your own risk. </p> <a name="Weakly-depends-on"></a> -<h4 class="subsection">6.3.6 Weakly depends on</h4> +<h4 class="subsection">6.3.8 Weakly depends on</h4> <a name="index-_003aweakly_002ddepends_002don"></a> <p>We do <em>NOT</em> recommend you use this feature. @@ -1445,10 +1501,10 @@ this anomalous behaviour may be removed without warning. </p> -<a name="Pathname-specifiers"></a> -<h4 class="subsection">6.3.7 Pathname specifiers</h4> +<a name="Pathname-specifiers-1"></a> +<h4 class="subsection">6.3.9 Pathname specifiers</h4> <a name="index-pathname-specifiers"></a> - +<a name="Pathname-specifiers"></a> <p>A pathname specifier (<code>pathname-specifier</code>) may be a pathname, a string or a symbol. When no pathname specifier is given for a component, @@ -1488,13 +1544,17 @@ which when merged, goes back one level in the directory hierarchy. and downcased in the process. The downcasing of symbols is unconventional, but was selected after some consideration. -Observations suggest that the type of systems we want to support -either have lowercase as customary case (Unix, Mac, windows) +The file systems we support +either have lowercase as customary case (Unix, Mac, Windows) or silently convert lowercase to uppercase (lpns), so this makes more sense than attempting to use <code>:case :common</code> as argument to <code>make-pathname</code>, which is reported not to work on some implementations. </p> +<p>Please avoid using underscores in system names, or component (module or +file) names, since underscores are not +compatible with logical pathnames (see <a href="#Using-logical-pathnames">Using logical pathnames</a>). +</p> <p>Pathname objects may be given to override the path for a component. Such objects are typically specified using reader macros such as <code>#p</code> or <code>#.(make-pathname ...)</code>. @@ -1503,7 +1563,7 @@ a shorthand for <code>#.(parse-namestring ...)</code> and that the behaviour of <code>parse-namestring</code> is completely non-portable, unless you are using Common Lisp <code>logical-pathname</code>s, which themselves involve other non-portable behaviour -(see <a href="#The-defsystem-grammar">Using logical pathnames</a>, below). +(see <a href="#Using-logical-pathnames">Using logical pathnames</a>). Pathnames made with <code>#.(make-pathname ...)</code> can usually be done more easily with the string syntax above. The only case that you really need a pathname object is to override @@ -1525,11 +1585,11 @@ fulfills whatever constraints are required from that component type on the other hand, you can circumvent the file type that would otherwise be forced upon you if you were specifying a string. </p> -<a name="Version-specifiers"></a> -<h4 class="subsection">6.3.8 Version specifiers</h4> +<a name="Version-specifiers-1"></a> +<h4 class="subsection">6.3.10 Version specifiers</h4> <a name="index-version-specifiers"></a> <a name="index-_003aversion-1"></a> - +<a name="Version-specifiers"></a> <p>Version specifiers are strings to be parsed as period-separated lists of integers. I.e., in the example, <code>"0.2.1"</code> is to be interpreted, roughly speaking, as <code>(0 2 1)</code>. @@ -1543,9 +1603,8 @@ had the version strings been interpreted as decimal fractions. the <code>:version</code> argument can be an expression that is resolved to such a string using the following trivial domain-specific language: in addition to being a literal string, it can be an expression of the form -<code>(:read-file-form <pathname-or-string> [:at <access-at-specifier]>)</code>, -or <code>(:read-file-line <pathname-or-string> [:at -<access-at-specifier]?>)</code>. +<code>(:read-file-form <pathname-or-string> [:at <access-at-specifier>])</code>, +or <code>(:read-file-line <pathname-or-string> [:at <access-at-specifier>])</code>. As the name suggests, the former will be resolved by reading a form in the specified pathname (read as a subpathname of the current system if relative or a unix-namestring), and the latter by reading a line. @@ -1566,20 +1625,20 @@ where significant API incompatibilities are signaled by an increased major numbe <p>See <a href="#Common-attributes-of-components">Common attributes of components</a>. </p> <a name="Require"></a> -<h4 class="subsection">6.3.9 Require</h4> +<h4 class="subsection">6.3.11 Require</h4> <a name="index-_003arequire-dependencies"></a> <p>Use the implementation’s own <code>require</code> to load the <var>module-name</var>. </p> -<p>It is good taste to use <code>:if-feature <em>:implementation-name</em></code> -rather than <code>#+<em>implementation-name</em></code> +<p>It is good taste to use <code>(:feature <em>:implementation-name</em> (:require <var>module-name</var>))</code> +rather than <code>#+<em>implementation-name</em> (:require <var>module-name</var>)</code> to only depend on the specified module on the specific implementation that provides it. -See <a href="#if_002dfeature_002doption">if-feature-option</a>. +See <a href="#Feature-dependencies">Feature dependencies</a>. </p> -<a name="Feature-dependencies"></a> -<h4 class="subsection">6.3.10 Feature dependencies</h4> +<a name="Feature-dependencies-1"></a> +<h4 class="subsection">6.3.12 Feature dependencies</h4> <a name="index-_003afeature-dependencies"></a> - +<a name="Feature-dependencies"></a> <p>A feature dependency is of the form <code>(:feature <var>feature-expression</var> <var>dependency</var>)</code> If the <var>feature-expression</var> is satisfied by the running lisp at the @@ -1594,13 +1653,13 @@ definition to be loaded. E.g., one cannot use <code>(:feature :sbcl)</code> to require that a system only be used on SBCL. </p> <p>Feature dependencies are not to be confused with the obsolete -feature requirement (see <a href="#The-defsystem-grammar">feature requirement</a>), or +feature requirement (see <a href="#feature-requirement">feature requirement</a>), or with <code>if-feature</code>. </p> -<a name="Using-logical-pathnames"></a> -<h4 class="subsection">6.3.11 Using logical pathnames</h4> +<a name="Using-logical-pathnames-1"></a> +<h4 class="subsection">6.3.13 Using logical pathnames</h4> <a name="index-logical-pathnames"></a> - +<a name="Using-logical-pathnames"></a> <p>We do not generally recommend the use of logical pathnames, especially not so to newcomers to Common Lisp. However, we do support the use of logical pathnames by old timers, @@ -1654,7 +1713,7 @@ underscores, dots or CamelCase in pathnames. </p> <a name="Serial-dependencies"></a> -<h4 class="subsection">6.3.12 Serial dependencies</h4> +<h4 class="subsection">6.3.14 Serial dependencies</h4> <a name="index-serial-dependencies"></a> <p>If the <code>:serial t</code> option is specified for a module, @@ -1677,7 +1736,7 @@ This is done as if by <code>:depends-on</code>. <a name="Source-location-_0028_003apathname_0029"></a> -<h4 class="subsection">6.3.13 Source location (<code>:pathname</code>)</h4> +<h4 class="subsection">6.3.15 Source location (<code>:pathname</code>)</h4> <p>The <code>:pathname</code> option is optional in all cases for systems defined via <code>defsystem</code>, and generally is unnecessary. In the @@ -1722,10 +1781,10 @@ and <code>*load-truename*</code> is currently unbound from within an editor without clobbering its source location) </li></ul> -<a name="if_002dfeature-option"></a> -<h4 class="subsection">6.3.14 if-feature option</h4> +<a name="if_002dfeature-option-1"></a> +<h4 class="subsection">6.3.16 if-feature option</h4> <a name="index-_003aif_002dfeature-component-option"></a> -<a name="if_002dfeature_002doption"></a> +<a name="if_002dfeature-option"></a> <p>This option allows you to specify a feature expression to be evaluated as if by <code>#+</code> to conditionally include a component in your build. If the expression is false, the component is dropped @@ -1748,10 +1807,17 @@ been performed. <p>This option was added in ASDF 3. For more information, See <a href="#required_002dfeatures">Required features</a>. </p> -<a name="feature-requirement"></a> -<h4 class="subsection">6.3.15 feature requirement</h4> -<p>This requirement was removed in ASDF 3.1. Please do not use it. In -most cases, <code>:if-feature</code> (see <a href="#if_002dfeature_002doption">if-feature-option</a>) will provide +<a name="Entry-point-1"></a> +<h4 class="subsection">6.3.17 Entry point</h4> +<a name="index-_003aentry_002dpoint"></a> +<a name="Entry-point"></a><p>The <code>:entry-point</code> option allows a developer to specify the entry point of an executable program created by <code>program-op</code>. +</p> +<p>When <code>program-op</code> is invoked, the form passed to this option is converted to a function by <code>uiop:ensure-function</code> and bound to <code>uiop:*image-entry-point*</code>. Typically one will specify a string, e.g. <code>"foo:main"</code>, so that the executable starts with the <code>foo:main</code> function. Note that using the symbol <code>foo:main</code> instead might not work because the <code>foo</code> package doesn’t necessarily exist when ASDF reads the <code>defsystem</code> form. For more information on <code>program-op</code>, see <a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a>. +</p> +<a name="feature-requirement-1"></a> +<h4 class="subsection">6.3.18 feature requirement</h4> +<a name="feature-requirement"></a><p>This requirement was removed in ASDF 3.1. Please do not use it. In +most cases, <code>:if-feature</code> (see <a href="#if_002dfeature-option">if-feature option</a>) will provide an adequate substitute. </p> <p>The <code>feature</code> requirement used to ensure that a chain of component @@ -1794,14 +1860,19 @@ of output from ASDF operations. <a name="The-package_002dinferred_002dsystem-extension"></a> <a name="The-package_002dinferred_002dsystem-extension-1"></a> <h3 class="section">6.5 The package-inferred-system extension</h3> +<a name="index-Package-inferred-systems"></a> +<a name="index-Packages_002c-inferring-dependencies-from"></a> +<a name="index-package_002dinferred_002dsystem"></a> +<a name="index-One-package-per-file-systems"></a> <p>Starting with release 3.1.2, ASDF supports a one-package-per-file style of programming, -whereby each file is its own system, +in which each file is its own system, and dependencies are deduced from the <code>defpackage</code> form -(or its variant <code>uiop:define-package</code>). +or its variant, <code>uiop:define-package</code>. </p> -<p>In this style, packages refer to a system with the same name (downcased); +<p>In this style of system definition, package names map to systems with +the same name (in lower case letters), and if a system is defined with <code>:class package-inferred-system</code>, then system names that start with that name (using the slash <code>/</code> separator) @@ -1810,23 +1881,26 @@ For instance, if system <code>my-lib</code> is defined in <samp>/foo/bar/my-lib/my-lib.asd</samp>, then system <code>my-lib/src/utility</code> will be found in file <samp>/foo/bar/my-lib/src/utility.lisp</samp>. </p> -<p>This style was made popular by <code>faslpath</code> and <code>quick-build</code> before, -and at the cost of a stricter package discipline, -seems to make for more maintainable code. -It is used by ASDF itself (starting with ASDF 3), by <code>lisp-interface-library</code>, +<p>One package per file style was made popular by <code>faslpath</code> and <code>quick-build</code>, +and at the cost of stricter package discipline, +may yield more maintainable code. +This style is used in ASDF itself (starting with ASDF 3), by <code>lisp-interface-library</code>, and a few other libraries. </p> <p>To use this style, choose a toplevel system name, e.g. <code>my-lib</code>, -and create a file <samp>my-lib.asd</samp> -with the <code>:class :package-inferred-system</code> option in its <code>defsystem</code>. +and create a file <samp>my-lib.asd</samp>. +Define <code>my-lib</code> +using the <code>:class :package-inferred-system</code> option in its <code>defsystem</code>. For instance: </p><div class="example"> -<pre class="example">#-asdf3.1 (error "my-lib requires ASDF 3.1") +<pre class="example">;; This example is based on lil.asd of LISP-INTERFACE-LIBRARY. + +#-asdf3.1 (error "MY-LIB requires ASDF 3.1 or later.") (defsystem "my-lib" :class :package-inferred-system :depends-on ("my-lib/interface/all" - "my-lib/src/all" - "my-lib/extras/all") + "my-lib/src/all" + "my-lib/extras/all") :in-order-to ((test-op (load-op "my-lib/test/all"))) :perform (test-op (o c) (symbol-call :my-lib/test/all :test-suite))) @@ -1838,43 +1912,83 @@ For instance: (register-system-packages "closer-mop" - '(:c2mop :closer-common-lisp :c2cl :closer-common-lisp-user :c2cl-user)) + '(:c2mop + :closer-common-lisp + :c2cl + :closer-common-lisp-user + :c2cl-user)) </pre></div> -<p>In the code above, the first line checks that we are using ASDF 3.1, -which provides <code>package-inferred-system</code>. -</p> -<p>The function <code>register-system-packages</code> has to be called to register -packages used or provided by your system and its components -where the name of the system that provides the package -is not the downcase of the package name. -</p> -<p>Then, file <samp>interface/order.lisp</samp> under the <code>lil</code> hierarchy, -that defines abstract interfaces for order comparisons, -starts with the following form, -dependencies being trivially computed from the <code>:use</code> and <code>:mix</code> clauses: +<p>In the code above, the first form checks that we are using ASDF 3.1 or +later, which provides <code>package-inferred-system</code>. This is probably +no longer necessary, since none of the major lisp implementations +provides an older version of ASDF. +</p> +<a name="index-register_002dsystem_002dpackages"></a> +<p>The function <code>register-system-packages</code> must be called to register +packages used or provided by your system +when the name of the system/file that provides the package +is not the same as the package name (converted to lower case). +</p> +<p>Each file under the <code>my-lib</code> hierarchy will start with a +package definition. +<a name="index-define_002dpackage"></a> +<a name="index-uiop_003adefine_002dpackage"></a> +The form <code>uiop:define-package</code> is supported as well as +<code>defpackage</code>. +ASDF will compute dependencies from the +<code>:use</code>, <code>:mix</code>, and other importation clauses of this package definition. Take the file +<samp>interface/order.lisp</samp> as an example: </p> <div class="example"> -<pre class="example">(uiop:define-package :lil/interface/order +<pre class="example">(uiop:define-package :my-lib/interface/order (:use :closer-common-lisp - :lil/interface/definition - :lil/interface/base - :lil/interface/eq :lil/interface/group) + :my-lib/interface/definition + :my-lib/interface/base) (:mix :fare-utils :uiop :alexandria) (:export ...)) </pre></div> -<p>ASDF can tell that this file depends on system <code>closer-mop</code> (registered above), -<code>lil/interface/definition</code>, <code>lil/interface/base</code>, -<code>lil/interface/eq</code>, and <code>lil/interface/group</code> -(package and system names match, and they will be looked up hierarchically). +<p>ASDF can tell that this file/system depends on system <code>closer-mop</code> (registered above), +<code>my-lib/interface/definition</code>, and <code>my-lib/interface/base</code>. +</p> +<p>How can ASDF find the file <samp>interface/order.lisp</samp> from the +toplevel system <code>my-lib</code>, however? In the example above, +<samp>interface/all.lisp</samp> (and other <samp>all.lisp</samp>) reexport +all the symbols exported from the packages at the same or lower levels +of the hierarchy. This can be easily done with +<code>uiop:define-package</code>, which has many options that prove useful in this +context. For example: +</p> +<div class="example"> +<pre class="example">(uiop:define-package :my-lib/interface/all + (:nicknames :my-lib-interface) + (:use :closer-common-lisp) + (:mix :fare-utils :uiop :alexandria) + (:use-reexport + :my-lib/interface/definition + :my-lib/interface/base + :my-lib/interface/order + :my-lib/interface/monad/continuation)) +</pre></div> + +<p>Thus the top level system need only depend on the <code>my-lib/.../all</code> systems +because ASDF detects +<samp>interface/order.lisp</samp> and all other dependencies from <code>all</code> +systems’ <code>:use-reexport</code> clauses, which effectively +allow for “inheritance” of symbols being exported. </p> <p>ASDF also detects dependencies from <code>:import-from</code> clauses. -You may thus import a well-defined set of symbols from an existing package -as loaded from suitably named system; -or if you prefer to use any such symbol fully qualified by a package prefix, +You may thus import a well-defined set of symbols from an existing +package, and ASDF will know to load the system that provides that +package. In the following example, ASDF will infer that the current +system depends on <code>foo/baz</code> from the first <code>:import-from</code>. +If you prefer to use any such symbol fully qualified by a package prefix, you may declare a dependency on such a package and its corresponding system -via an <code>:import-from</code> clause with an empty list of symbols, as in: +via an <code>:import-from</code> clause with an empty list of symbols. For +example, if we preferred to use the name ‘foo/quux:bletch‘, the second, +empty, <code>:import-from</code> form would cause ASDF to load +<code>foo/quux</code>. </p> <div class="example"> <pre class="example">(defpackage :foo/bar @@ -1884,13 +1998,8 @@ via an <code>:import-from</code> clause with an empty list of symbols, as in: (:export ...)) </pre></div> -<p>The form <code>uiop:define-package</code> is supported as well as <code>defpackage</code>, -and has many options that prove useful in this context, -such as <code>:use-reexport</code> and <code>:mix-reexport</code> -that allow for “inheritance” of symbols being exported. -</p> <p>Note that starting with ASDF 3.1.5.6 only, ASDF will look for source files under -the <code>component-pathname</code> as specified via the <code>:pathname</code> option, +the <code>component-pathname</code> (specified via the <code>:pathname</code> option), whereas earlier versions ignore this option and use the <code>system-source-directory</code> where the <samp>.asd</samp> file resides. </p> @@ -1972,8 +2081,8 @@ discuss these in turn below. <p>Operations are invoked on systems via <code>operate</code>. <a name="operate"></a></p><dl> -<dt><a name="index-operate-1"></a>Generic function: <strong><code>operate</code></strong> <em><var>operation</var> <var>component</var> &rest <var>initargs</var> &key <code>force</code> <code>force-not</code> <code>verbose</code> &allow-other-keys</em></dt> -<dt><a name="index-oos-1"></a>Generic function: <strong><code>oos</code></strong> <em><var>operation</var> <var>component</var> &rest <var>initargs</var> &key &allow-other-keys</em></dt> +<dt><a name="index-operate-1"></a>Generic function: <strong>operate</strong> <em><var>operation</var> <var>component</var> &rest <var>initargs</var> &key <code>force</code> <code>force-not</code> <code>verbose</code> &allow-other-keys</em></dt> +<dt><a name="index-oos-1"></a>Generic function: <strong>oos</strong> <em><var>operation</var> <var>component</var> &rest <var>initargs</var> &key &allow-other-keys</em></dt> <dd><p><code>operate</code> invokes <var>operation</var> on <var>system</var>. <code>oos</code> is a synonym for <code>operate</code> (it stands for operate-on-system). </p> @@ -2026,7 +2135,7 @@ See <a href="#Miscellaneous-Functions">Miscellaneous Functions</a>. </dd></dl> <dl> -<dt><a name="index-make_002doperation"></a>Function: <strong><code>make-operation</code></strong> <em><var>operation-class</var> &rest <var>initargs</var></em></dt> +<dt><a name="index-make_002doperation"></a>Function: <strong>make-operation</strong> <em><var>operation-class</var> &rest <var>initargs</var></em></dt> <dd><a name="make_002doperation"></a> <p>The <var>initargs</var> are passed to <code>make-instance</code> call when creating the operation object. @@ -2054,7 +2163,7 @@ They are invoked via the <code>operate</code> generic function. </pre></div> <dl> -<dt><a name="index-compile_002dop"></a>Operation: <strong><code>compile-op</code></strong></dt> +<dt><a name="index-compile_002dop"></a>Operation: <strong>compile-op</strong></dt> <dd> <p>This operation compiles the specified component. A <code>cl-source-file</code> will be <code>compile-file</code>’d. @@ -2072,7 +2181,7 @@ Use <code>load-op</code> to load a system. </p></dd></dl> <dl> -<dt><a name="index-load_002dop"></a>Operation: <strong><code>load-op</code></strong></dt> +<dt><a name="index-load_002dop"></a>Operation: <strong>load-op</strong></dt> <dd> <p>This operation loads the compiled code for a specified component. A <code>cl-source-file</code> will have its compiled fasl <code>load</code>ed, @@ -2086,7 +2195,7 @@ as well as of its parent’s dependencies. </p></dd></dl> <dl> -<dt><a name="index-prepare_002dop"></a>Operation: <strong><code>prepare-op</code></strong></dt> +<dt><a name="index-prepare_002dop"></a>Operation: <strong>prepare-op</strong></dt> <dd> <p>This operation ensures that the dependencies of a component and its recursive parents are loaded (as per <code>load-op</code>), @@ -2095,7 +2204,8 @@ may be performed on a given component. </p></dd></dl> <dl> -<dt><a name="index-load_002dsource_002dop_002c"></a>Operation: <strong><code>load-source-op</code>,</strong> <em><code>prepare-source-op</code></em></dt> +<dt><a name="index-load_002dsource_002dop"></a>Operation: <strong>load-source-op</strong></dt> +<dt><a name="index-prepare_002dsource_002dop"></a>Operation: <strong>prepare-source-op</strong></dt> <dd> <p><code>load-source-op</code> will load the source for the files in a module rather than the compiled fasl output. @@ -2105,7 +2215,7 @@ that ensures the dependencies are themselves loaded via <code>load-source-op</co </dd></dl> <a name="test_002dop"></a><dl> -<dt><a name="index-test_002dop"></a>Operation: <strong><code>test-op</code></strong></dt> +<dt><a name="index-test_002dop"></a>Operation: <strong>test-op</strong></dt> <dd> <p>This operation will perform some tests on the module. The default method will do nothing. @@ -2158,7 +2268,18 @@ on a library. For example, one might have <dl> -<dt><a name="index-compile_002dbundle_002dop_002c"></a>Operation: <strong><code>compile-bundle-op</code>,</strong> <em><code>monolithic-compile-bundle-op</code>, <code>load-bundle-op</code>, <code>monolithic-load-bundle-op</code>, <code>deliver-asd-op</code>, <code>monolithic-deliver-asd-op</code>, <code>lib-op</code>, <code>monolithic-lib-op</code>, <code>dll-op</code>, <code>monolithic-dll-op</code>, <code>image-op</code>, <code>program-op</code></em></dt> +<dt><a name="index-compile_002dbundle_002dop"></a>Operation: <strong>compile-bundle-op</strong></dt> +<dt><a name="index-monolithic_002dcompile_002dbundle_002dop"></a>Operation: <strong>monolithic-compile-bundle-op</strong></dt> +<dt><a name="index-load_002dbundle_002dop"></a>Operation: <strong>load-bundle-op</strong></dt> +<dt><a name="index-monolithic_002dload_002dbundle_002dop"></a>Operation: <strong>monolithic-load-bundle-op</strong></dt> +<dt><a name="index-deliver_002dasd_002dop"></a>Operation: <strong>deliver-asd-op</strong></dt> +<dt><a name="index-monolithic_002ddeliver_002dasd_002dop"></a>Operation: <strong>monolithic-deliver-asd-op</strong></dt> +<dt><a name="index-lib_002dop"></a>Operation: <strong>lib-op</strong></dt> +<dt><a name="index-monolithic_002dlib_002dop"></a>Operation: <strong>monolithic-lib-op</strong></dt> +<dt><a name="index-dll_002dop"></a>Operation: <strong>dll-op</strong></dt> +<dt><a name="index-monolithic_002ddll_002dop"></a>Operation: <strong>monolithic-dll-op</strong></dt> +<dt><a name="index-image_002dop"></a>Operation: <strong>image-op</strong></dt> +<dt><a name="index-program_002dop"></a>Operation: <strong>program-op</strong></dt> <dd> <p>These are “bundle” operations, that can create a single-file “bundle” for all the contents of each system in an application, @@ -2166,12 +2287,12 @@ or for the entire application. </p> <p><code>compile-bundle-op</code> will create a single fasl file for each of the systems needed, grouping all its many fasls in one, -so you can deliver each system as a single fasl +so you can deliver each system as a single fasl. <code>monolithic-compile-bundle-op</code> will create a single fasl file for the target system and all its dependencies, so you can deliver your entire application as a single fasl. <code>load-bundle-op</code> will load the output of <code>compile-bundle-op</code>. -Note that if it the output is not up-to-date, +Note that if the output is not up-to-date, <code>compile-bundle-op</code> may load the intermediate fasls as a side-effect. Bundling fasls together matters a lot on ECL, where the dynamic linking involved in loading tens of individual fasls @@ -2227,7 +2348,7 @@ for building a linkable <samp>.a</samp> file (Windows: <samp>.lib</samp>) from all linkable object dependencies (FFI files, and on ECL, Lisp files too), and its monolithic equivalent <code>monolithic-lib-op</code>. And there is also <code>dll-op</code> -(respectively its monolithic equivalent <code>monolithic-lib-op</code>) +(respectively its monolithic equivalent <code>monolithic-dll-op</code>) for building a linkable <samp>.so</samp> file (Windows: <samp>.dll</samp>, MacOS X: <samp>.dynlib</samp>) to create a single dynamic library @@ -2250,7 +2371,14 @@ Maybe you have suggestions on how to better configure it? </p></dd></dl> <dl> -<dt><a name="index-concatenate_002dsource_002dop_002c"></a>Operation: <strong><code>concatenate-source-op</code>,</strong> <em><code>monolithic-concatenate-source-op</code>, <code>load-concatenated-source-op</code>, <code>compile-concatenated-source-op</code>, <code>load-compiled-concatenated-source-op</code>, <code>monolithic-load-concatenated-source-op</code>, <code>monolithic-compile-concatenated-source-op</code>, <code>monolithic-load-compiled-concatenated-source-op</code></em></dt> +<dt><a name="index-concatenate_002dsource_002dop"></a>Operation: <strong>concatenate-source-op</strong></dt> +<dt><a name="index-monolithic_002dconcatenate_002dsource_002dop"></a>Operation: <strong>monolithic-concatenate-source-op</strong></dt> +<dt><a name="index-load_002dconcatenated_002dsource_002dop"></a>Operation: <strong>load-concatenated-source-op</strong></dt> +<dt><a name="index-compile_002dconcatenated_002dsource_002dop"></a>Operation: <strong>compile-concatenated-source-op</strong></dt> +<dt><a name="index-load_002dcompiled_002dconcatenated_002dsource_002dop"></a>Operation: <strong>load-compiled-concatenated-source-op</strong></dt> +<dt><a name="index-monolithic_002dload_002dconcatenated_002dsource_002dop"></a>Operation: <strong>monolithic-load-concatenated-source-op</strong></dt> +<dt><a name="index-monolithic_002dcompile_002dconcatenated_002dsource_002dop"></a>Operation: <strong>monolithic-compile-concatenated-source-op</strong></dt> +<dt><a name="index-monolithic_002dload_002dcompiled_002dconcatenated_002dsource_002dop"></a>Operation: <strong>monolithic-load-compiled-concatenated-source-op</strong></dt> <dd> <p>These operations, as their respective names indicate, will concatenate all the <code>cl-source-file</code> source files in a system @@ -2619,7 +2747,7 @@ performed by the exported function <code>coerce-name</code>. <p>Unless overridden by a <code>:pathname</code> attribute, the name will be interpreted as a pathname specifier according to a Unix-style syntax. -See <a href="#The-defsystem-grammar">Pathname specifiers</a>. +See <a href="#Pathname-specifiers">Pathname specifiers</a>. </p> <a name="Version-identifier"></a> <h4 class="subsubsection">7.2.1.2 Version identifier</h4> @@ -2628,8 +2756,7 @@ See <a href="#The-defsystem-grammar">Pathname specifiers</a>. <p>This optional attribute specifies a version for the current component. The version should typically be a string of integers separated by dots, -for example ‘<samp>1.0.11</samp>’. -For more information on version specifiers, see <a href="#The-defsystem-grammar">The defsystem grammar</a>. +for example ‘<samp>1.0.11</samp>’. See <a href="#Version-specifiers">Version specifiers</a>. </p> <p>A version may then be queried by the generic function <code>version-satisfies</code>, to see if <code>:version</code> dependencies are satisfied, @@ -2675,7 +2802,7 @@ when the implementation is SBCL, CMUCL or Scieneer CL on an x86 machine. You cannot write it as <code>:if-feature (and x86 (or sbcl cmu scl))</code> since the symbols would not be read as keywords. </p> -<p>See <a href="#if_002dfeature_002doption">if-feature-option</a>. +<p>See <a href="#if_002dfeature-option">if-feature option</a>. </p> <a name="Dependencies-1"></a> <h4 class="subsubsection">7.2.1.4 Dependencies</h4> @@ -2764,7 +2891,7 @@ in the defsystem grammar. <p>This attribute is optional and if absent (which is the usual case), the component name will be used. </p> -<p>See <a href="#The-defsystem-grammar">Pathname specifiers</a>, +<p>See <a href="#Pathname-specifiers">Pathname specifiers</a>, for an explanation of how this attribute is interpreted. </p> <p>Note that the <code>defsystem</code> macro (used to create a “top-level” system) @@ -2857,7 +2984,7 @@ are inferred to be of this type. </li><li> <code>:if-component-dep-fails</code> This attribute was removed in ASDF 3. Do not use it. -Use <code>:if-feature</code> instead (see <a href="#required_002dfeatures">required-features</a>, and see <a href="#if_002dfeature_002doption">if-feature-option</a>). +Use <code>:if-feature</code> instead (see <a href="#required_002dfeatures">required-features</a>, and see <a href="#if_002dfeature-option">if-feature option</a>). </li><li> <code>:serial</code> When this attribute is set, each subcomponent of this component is assumed to depend on all subcomponents @@ -2984,7 +3111,7 @@ Therefore <code>"1.9.1"</code>, <code>"1.9.2"</code> and <co but <code>"1.8.4"</code> or <code>"1.9"</code> do not. For more information about how <code>version-satisfies</code> parses and interprets version strings and specifications, -see <a href="#The-defsystem-grammar">The defsystem grammar</a> (version specifiers) and +see <a href="#Version-specifiers">Version specifiers</a> and <a href="#Common-attributes-of-components">Common attributes of components</a>. </p> <p>Note that in versions of ASDF prior to 3.0.1, @@ -3411,20 +3538,21 @@ if it begins with a paren <code>(</code>, otherwise it will be interpreted much like <code>TEXINPUTS</code>, as a list of paths, where </p> -<p>* paths are separated - by a <code>:</code> (colon) on Unix platforms (including cygwin), - by a <code>;</code> (semicolon) on other platforms (mainly, Windows). -</p> -<p>* each entry is a directory to add to the search path. -</p> -<p>* if the entry ends with a double slash <code>//</code> - then it instead indicates a tree in the subdirectories - of which to recurse. -</p> -<p>* if the entry is the empty string (which may only appear once), - then it indicates that the inherited configuration should be - spliced there. -</p> +<ul> +<li> paths are separated by a <code>:</code> (colon) on Unix platforms + (including cygwin), by a <code>;</code> (semicolon) on other platforms + (mainly, Windows). + +</li><li> each entry is a directory to add to the search path. + +</li><li> if the entry ends with a double slash <code>//</code> then it instead + indicates a tree in the subdirectories of which to recurse. + +</li><li> if the entry is the empty string (which may only appear once), + then it indicates that the inherited configuration should be spliced + there. +</li></ul> + <hr> <a name="Search-Algorithm"></a> <a name="Search-Algorithm-1"></a> @@ -4205,18 +4333,18 @@ But so are good design ideas and elegant implementation tricks. <a name="Error-handling"></a> <a name="Error-handling-1"></a> <h2 class="chapter">10 Error handling</h2> -<a name="index-SYSTEM_002dDEFINITION_002dERROR"></a> -<a name="index-OPERATION_002dERROR"></a> +<a name="index-system_002ddefinition_002derror"></a> +<a name="index-operation_002derror"></a> <a name="ASDF-errors"></a> <h3 class="section">10.1 ASDF errors</h3> <p>If ASDF detects an incorrect system definition, it will signal a generalised instance of -<code>SYSTEM-DEFINITION-ERROR</code>. +<code>system-definition-error</code>. </p> <p>Operations may go wrong (for example when source files contain errors). These are signalled using generalised instances of -<code>OPERATION-ERROR</code>. +<code>operation-error</code>. </p> <a name="Compilation-error-and-warning-handling"></a> <h3 class="section">10.2 Compilation error and warning handling</h3> @@ -4468,7 +4596,7 @@ The <code>system-relative-pathname</code> function meets this need. and a keyword argument <var>type</var>: <var>system</var> is name of a system, whereas <var>name</var> and optionally <var>type</var> specify a relative pathname, interpreted like a component pathname specifier -by <code>coerce-pathname</code>. See <a href="#The-defsystem-grammar">Pathname specifiers</a>. +by <code>coerce-pathname</code>. See <a href="#Pathname-specifiers">Pathname specifiers</a>. </p> <p>It returns a pathname built from the location of the system’s source directory and the relative pathname. For example: @@ -5011,7 +5139,7 @@ where you must now use an explicit pathname object: must now be written with the <code>#p</code> syntax: <code>(defsystem ... :pathname #p"LOGICAL-HOST:PATH;TO;SYSTEM;" ...)</code> </p> -<p>See <a href="#The-defsystem-grammar">Pathname specifiers</a>. +<p>See <a href="#Pathname-specifiers">Pathname specifiers</a>. </p> <hr> @@ -5398,12 +5526,12 @@ so ASDF 3 doesn’t try (anymore) and loses any configuration from ASDF 2. <a name="index-monolithic_002dfasl_002dop-_0028obsolete_0029"></a> <a name="index-monolithic_002dload_002dfasl_002dop-_0028obsolete_0029"></a> <a name="index-monolithic_002dbinary_002dop-_0028obsolete_0029"></a> -<a name="index-compile_002dbundle_002dop"></a> -<a name="index-load_002dbundle_002dop"></a> -<a name="index-deliver_002dasd_002dop"></a> -<a name="index-monolithic_002dcompile_002dbundle_002dop"></a> -<a name="index-monolithic_002dload_002dbundle_002dop"></a> -<a name="index-monolithic_002ddeliver_002dasd_002dop"></a> +<a name="index-compile_002dbundle_002dop-1"></a> +<a name="index-load_002dbundle_002dop-1"></a> +<a name="index-deliver_002dasd_002dop-1"></a> +<a name="index-monolithic_002dcompile_002dbundle_002dop-1"></a> +<a name="index-monolithic_002dload_002dbundle_002dop-1"></a> +<a name="index-monolithic_002ddeliver_002dasd_002dop-1"></a> <p><code>asdf-ecl</code> and its short-lived successor <code>asdf-bundle</code> are no more, having been replaced by code now built into ASDF 3. @@ -5989,7 +6117,30 @@ see the <samp>TODO</samp> file in the source repository. <h2 class="unnumbered">Bibliography</h2> <ul> -<li> Francois-Rene Rideau: +<li> Andrey Mokhov, Neil Mitchell and Simon Peyton Jones: +“Build Systems à la Carte”, 2018. + <a href="https://www.microsoft.com/en-us/research/uploads/prod/2018/03/build-systems-final.pdf">https://www.microsoft.com/en-us/research/uploads/prod/2018/03/build-systems-final.pdf</a> + This article provides axes along which to describe build systems in general; + ASDF, in addition to being in-image (an axis not considered by these authors), + has the following characteristics: + ASDF’s persistent build information is file modification times + (the way ASDF is written, it should be easy enough to write an extension that modifies it + to use a “cloud cache” à la Bazel, + but that would involve using some database, network and cryptographic libraries, + which cannot reasonably be included in the base ASDF, + that must remain a minimal bootstrappable system with no external dependencies). + The object model of ASDF was initially designed for “static” dependencies + with a “topological” scheduler, but its <code>defsystem-depends-on</code> mechanism + (and more generally, the ability to call ASDF from within an <code>.asd</code> file) + allows for multiple <em>phases</em> of execution resulting + in “dynamic” dependencies with a “suspending” scheduler. + The rebuilder essentially uses a “dirty bit”, except that the in-image model + and the multiple phase support mean that’s actually more than a bit: + instead three bits, the timestamp and a phase depth level. + The build is guaranteed “minimal” in number of steps computed. + It is local; it assumes but does not enforce determinism; + it does not assume early cutoff of the build when rebuild dependencies didn’t change. +</li><li> Francois-Rene Rideau: “ASDF 3, or Why Lisp is Now an Acceptable Scripting Language”, 2014. This article describes the innovations in ASDF 3 and 3.1, as well as historical information on previous versions. @@ -6004,15 +6155,16 @@ see the <samp>TODO</samp> file in the source repository. modulo a different setup for toplevel hierarchies. </li><li> Zach Beane: “Quicklisp”, 2011. - The Quicklisp blog and Xach’s livejournal contain information on Quicklisp. + The Quicklisp blog and Xach’s personal blogs contain information on Quicklisp. <a href="http://blog.quicklisp.org/">http://blog.quicklisp.org/</a> - <a href="http://xach.livejournal.com/">http://xach.livejournal.com/</a> + <a href="http://lispblog.xach.com/">http://lispblog.xach.com/</a> (new) + <a href="http://xach.livejournal.com/">http://xach.livejournal.com/</a> (old) </li><li> Francois-Rene Rideau and Robert Goldman: “Evolving ASDF: More Cooperation, Less Coordination”, 2010. This article describes the main issues solved by ASDF 2, and exposes its design principles. - <a href="https://common-lisp.net/project/asdf/doc/ilc2010draft.pdf">https://common-lisp.net/project/asdf/doc/ilc2010draft.pdf</a> - <a href="https://gitlab.common-lisp.org/asdf/ilc2010">https://gitlab.common-lisp.org/asdf/ilc2010</a> + <a href="https://common-lisp.net/project/asdf/ilc2010draft.pdf">https://common-lisp.net/project/asdf/ilc2010draft.pdf</a> + <a href="http://rpgoldman.goldman-tribe.org/papers/ilc2010-asdf.pdf">http://rpgoldman.goldman-tribe.org/papers/ilc2010-asdf.pdf</a> </li><li> Francois-Rene Rideau and Spencer Brody: “XCVB: an eXtensible Component Verifier and Builder for Common Lisp”, 2009. This article describes XCVB, a proposed competitor for ASDF; @@ -6042,7 +6194,7 @@ see the <samp>TODO</samp> file in the source repository. are available in the CLOCC repository as <code>defsystem-3.x</code>. </li><li> Richard Elliot Robbins: “BUILD: A Tool for Maintaining Consistency in Modular Systems”, MIT AI TR 874, 1985. - <a href="ftp://publications.ai.mit.edu/ai-publications/pdf/AITR-874.pdf">ftp://publications.ai.mit.edu/ai-publications/pdf/AITR-874.pdf</a> + <a href="http://www.dtic.mil/dtic/tr/fulltext/u2/a162744.pdf">http://www.dtic.mil/dtic/tr/fulltext/u2/a162744.pdf</a> </li><li> Kent M. Pitman (kmp): “The Description of Large Systems”, MIT AI Memo 801, 1984. Available in updated-for-CL form on the web at <a href="http://nhplace.com/kent/Papers/Large-Systems.html">http://nhplace.com/kent/Papers/Large-Systems.html</a> @@ -6112,6 +6264,7 @@ see the <samp>TODO</samp> file in the source repository. <tr><td></td><td valign="top"><a href="#index-_003adefault_002dregistry-source-config-directive">:default-registry source config directive</a>:</td><td> </td><td valign="top"><a href="#Configuration-DSL">Configuration DSL</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_003adefsystem_002ddepends_002don">:defsystem-depends-on</a>:</td><td> </td><td valign="top"><a href="#The-defsystem-grammar">The defsystem grammar</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_003adirectory-source-config-directive">:directory source config directive</a>:</td><td> </td><td valign="top"><a href="#Configuration-DSL">Configuration DSL</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_003aentry_002dpoint">:entry-point</a>:</td><td> </td><td valign="top"><a href="#The-defsystem-grammar">The defsystem grammar</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_003aexclude-source-config-directive">:exclude source config directive</a>:</td><td> </td><td valign="top"><a href="#Configuration-DSL">Configuration DSL</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_003afeature-dependencies">:feature dependencies</a>:</td><td> </td><td valign="top"><a href="#The-defsystem-grammar">The defsystem grammar</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_003aif_002dfeature-component-option">:if-feature component option</a>:</td><td> </td><td valign="top"><a href="#The-defsystem-grammar">The defsystem grammar</a></td></tr> @@ -6169,9 +6322,12 @@ see the <samp>TODO</samp> file in the source repository. <tr><td></td><td valign="top"><a href="#index-mailing-list">mailing list</a>:</td><td> </td><td valign="top"><a href="#Mailing-list">Mailing list</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Concept-Index_cp_letter-O">O</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-One-package-per-file-systems">One package per file systems</a>:</td><td> </td><td valign="top"><a href="#The-package_002dinferred_002dsystem-extension">The package-inferred-system extension</a></td></tr> <tr><td></td><td valign="top"><a href="#index-operation">operation</a>:</td><td> </td><td valign="top"><a href="#Operations">Operations</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Concept-Index_cp_letter-P">P</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-Package-inferred-systems">Package inferred systems</a>:</td><td> </td><td valign="top"><a href="#The-package_002dinferred_002dsystem-extension">The package-inferred-system extension</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-Packages_002c-inferring-dependencies-from">Packages, inferring dependencies from</a>:</td><td> </td><td valign="top"><a href="#The-package_002dinferred_002dsystem-extension">The package-inferred-system extension</a></td></tr> <tr><td></td><td valign="top"><a href="#index-pathname-specifiers">pathname specifiers</a>:</td><td> </td><td valign="top"><a href="#The-defsystem-grammar">The defsystem grammar</a></td></tr> <tr><td></td><td valign="top"><a href="#index-Primary-system-name">Primary system name</a>:</td><td> </td><td valign="top"><a href="#Components">Components</a></td></tr> <tr><td colspan="4"> <hr></td></tr> @@ -6233,53 +6389,50 @@ see the <samp>TODO</samp> file in the source repository. </td></tr></table> <hr> -<a name="Function-and-Class-Index"></a> -<a name="Function-and-Class-Index-1"></a> -<h2 class="unnumbered">Function and Class Index</h2> +<a name="Function-and-Macro-Index"></a> +<a name="Function-and-Macro-Index-1"></a> +<h2 class="unnumbered">Function and Macro Index</h2> -<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Function-and-Class-Index_fn_letter-A"><b>A</b></a> +<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-A"><b>A</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-B"><b>B</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-C"><b>C</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-C"><b>C</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-D"><b>D</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-D"><b>D</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-E"><b>E</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-E"><b>E</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-F"><b>F</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-F"><b>F</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-I"><b>I</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-I"><b>I</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-L"><b>L</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-L"><b>L</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-M"><b>M</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-M"><b>M</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-O"><b>O</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-O"><b>O</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-P"><b>P</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-P"><b>P</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-R"><b>R</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-R"><b>R</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-S"><b>S</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-S"><b>S</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-T"><b>T</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-T"><b>T</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-U"><b>U</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-V"><b>V</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-V"><b>V</b></a> </td></tr></table> <table class="index-fn" border="0"> <tr><td></td><th align="left">Index Entry</th><td> </td><th align="left"> Section</th></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-A">A</a></th><td></td><td></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-A">A</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-already_002dloaded_002dsystems"><code>already-loaded-systems</code></a>:</td><td> </td><td valign="top"><a href="#Convenience-Functions">Convenience Functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-apply_002doutput_002dtranslations"><code>apply-output-translations</code></a>:</td><td> </td><td valign="top"><a href="#Output-location-API">Output location API</a></td></tr> <tr><td></td><td valign="top"><a href="#index-asdf_002dversion"><code>asdf-version</code></a>:</td><td> </td><td valign="top"><a href="#How-do-I-detect-the-ASDF-version_003f">How do I detect the ASDF version?</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-B">B</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-binary_002dop-_0028obsolete_0029"><code>binary-op (obsolete)</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> -<tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-C">C</a></th><td></td><td></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-C">C</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-clear_002dconfiguration"><code>clear-configuration</code></a>:</td><td> </td><td valign="top"><a href="#Resetting-the-ASDF-configuration">Resetting the ASDF configuration</a></td></tr> <tr><td></td><td valign="top"><a href="#index-clear_002doutput_002dtranslations"><code>clear-output-translations</code></a>:</td><td> </td><td valign="top"><a href="#Configuring-where-ASDF-stores-object-files">Configuring where ASDF stores object files</a></td></tr> <tr><td></td><td valign="top"><a href="#index-clear_002doutput_002dtranslations-1"><code>clear-output-translations</code></a>:</td><td> </td><td valign="top"><a href="#Output-location-API">Output location API</a></td></tr> @@ -6288,95 +6441,74 @@ see the <samp>TODO</samp> file in the source repository. <tr><td></td><td valign="top"><a href="#index-coerce_002dname"><code>coerce-name</code></a>:</td><td> </td><td valign="top"><a href="#Creating-new-operations">Creating new operations</a></td></tr> <tr><td></td><td valign="top"><a href="#index-coerce_002dname-1"><code>coerce-name</code></a>:</td><td> </td><td valign="top"><a href="#Components">Components</a></td></tr> <tr><td></td><td valign="top"><a href="#index-coerce_002dname-2"><code>coerce-name</code></a>:</td><td> </td><td valign="top"><a href="#Common-attributes-of-components">Common attributes of components</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-compile_002dbundle_002dop"><code>compile-bundle-op</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-compile_002dbundle_002dop_002c"><code><code>compile-bundle-op</code>,</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> <tr><td></td><td valign="top"><a href="#index-compile_002dfile_002a"><code>compile-file*</code></a>:</td><td> </td><td valign="top"><a href="#Controlling-file-compilation">Controlling file compilation</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-compile_002dop"><code><code>compile-op</code></code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> <tr><td></td><td valign="top"><a href="#index-compile_002dsystem"><code>compile-system</code></a>:</td><td> </td><td valign="top"><a href="#Convenience-Functions">Convenience Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-component-1"><code>component</code></a>:</td><td> </td><td valign="top"><a href="#The-object-model-of-ASDF">The object model of ASDF</a></td></tr> <tr><td></td><td valign="top"><a href="#index-component_002ddepends_002don"><code>component-depends-on</code></a>:</td><td> </td><td valign="top"><a href="#Creating-new-operations">Creating new operations</a></td></tr> <tr><td></td><td valign="top"><a href="#index-component_002dpathname"><code>component-pathname</code></a>:</td><td> </td><td valign="top"><a href="#Common-attributes-of-components">Common attributes of components</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-concatenate_002dsource_002dop_002c"><code><code>concatenate-source-op</code>,</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-D">D</a></th><td></td><td></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-D">D</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-define_002dpackage"><code>define-package</code></a>:</td><td> </td><td valign="top"><a href="#The-package_002dinferred_002dsystem-extension">The package-inferred-system extension</a></td></tr> <tr><td></td><td valign="top"><a href="#index-defsystem"><code>defsystem</code></a>:</td><td> </td><td valign="top"><a href="#The-defsystem-form">The defsystem form</a></td></tr> <tr><td></td><td valign="top"><a href="#index-defsystem-1"><code>defsystem</code></a>:</td><td> </td><td valign="top"><a href="#A-more-involved-example">A more involved example</a></td></tr> <tr><td></td><td valign="top"><a href="#index-defsystem-2"><code>defsystem</code></a>:</td><td> </td><td valign="top"><a href="#The-defsystem-grammar">The defsystem grammar</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-deliver_002dasd_002dop"><code>deliver-asd-op</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> <tr><td></td><td valign="top"><a href="#index-disable_002doutput_002dtranslations"><code>disable-output-translations</code></a>:</td><td> </td><td valign="top"><a href="#Output-location-API">Output location API</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-E">E</a></th><td></td><td></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-E">E</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-enable_002dasdf_002dbinary_002dlocations_002dcompatibility"><code>enable-asdf-binary-locations-compatibility</code></a>:</td><td> </td><td valign="top"><a href="#Output-Backward-Compatibility">Output Backward Compatibility</a></td></tr> <tr><td></td><td valign="top"><a href="#index-ensure_002doutput_002dtranslations"><code>ensure-output-translations</code></a>:</td><td> </td><td valign="top"><a href="#Output-location-API">Output location API</a></td></tr> <tr><td></td><td valign="top"><a href="#index-ensure_002dsource_002dregistry"><code>ensure-source-registry</code></a>:</td><td> </td><td valign="top"><a href="#Configuration-API">Configuration API</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-F">F</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-fasl_002dop-_0028obsolete_0029"><code>fasl-op (obsolete)</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-F">F</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-file_002dtype"><code>file-type</code></a>:</td><td> </td><td valign="top"><a href="#Pitfalls-of-the-transition-to-ASDF-2">Pitfalls of the transition to ASDF 2</a></td></tr> <tr><td></td><td valign="top"><a href="#index-find_002dcomponent"><code>find-component</code></a>:</td><td> </td><td valign="top"><a href="#Creating-new-operations">Creating new operations</a></td></tr> <tr><td></td><td valign="top"><a href="#index-find_002dcomponent-1"><code>find-component</code></a>:</td><td> </td><td valign="top"><a href="#Components">Components</a></td></tr> <tr><td></td><td valign="top"><a href="#index-find_002dsystem"><code>find-system</code></a>:</td><td> </td><td valign="top"><a href="#Components">Components</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-I">I</a></th><td></td><td></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-I">I</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-initialize_002doutput_002dtranslations"><code>initialize-output-translations</code></a>:</td><td> </td><td valign="top"><a href="#Output-location-API">Output location API</a></td></tr> <tr><td></td><td valign="top"><a href="#index-initialize_002dsource_002dregistry"><code>initialize-source-registry</code></a>:</td><td> </td><td valign="top"><a href="#Configuration-API">Configuration API</a></td></tr> <tr><td></td><td valign="top"><a href="#index-input_002dfiles"><code>input-files</code></a>:</td><td> </td><td valign="top"><a href="#Creating-new-operations">Creating new operations</a></td></tr> <tr><td></td><td valign="top"><a href="#index-input_002dfiles-1"><code>input-files</code></a>:</td><td> </td><td valign="top"><a href="#Creating-new-operations">Creating new operations</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-L">L</a></th><td></td><td></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-L">L</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-load_002dasd"><code>load-asd</code></a>:</td><td> </td><td valign="top"><a href="#The-defsystem-form">The defsystem form</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-load_002dbundle_002dop"><code>load-bundle-op</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-load_002dfasl_002dop-_0028obsolete_0029"><code>load-fasl-op (obsolete)</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-load_002dop"><code><code>load-op</code></code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-load_002dsource_002dop_002c"><code><code>load-source-op</code>,</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> <tr><td></td><td valign="top"><a href="#index-load_002dsystem"><code>load-system</code></a>:</td><td> </td><td valign="top"><a href="#Convenience-Functions">Convenience Functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-locate_002dsystem"><code>locate-system</code></a>:</td><td> </td><td valign="top"><a href="#Components">Components</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-M">M</a></th><td></td><td></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-M">M</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-make"><code>make</code></a>:</td><td> </td><td valign="top"><a href="#Convenience-Functions">Convenience Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-make_002doperation"><code><code>make-operation</code></code></a>:</td><td> </td><td valign="top"><a href="#Operations">Operations</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-make_002doperation"><code>make-operation</code></a>:</td><td> </td><td valign="top"><a href="#Operations">Operations</a></td></tr> <tr><td></td><td valign="top"><a href="#index-merge_002dpathnames_002a"><code>merge-pathnames*</code></a>:</td><td> </td><td valign="top"><a href="#Some-Utility-Functions">Some Utility Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-module"><code>module</code></a>:</td><td> </td><td valign="top"><a href="#Pre_002ddefined-subclasses-of-component">Pre-defined subclasses of component</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-monolithic_002dbinary_002dop-_0028obsolete_0029"><code>monolithic-binary-op (obsolete)</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-monolithic_002dcompile_002dbundle_002dop"><code>monolithic-compile-bundle-op</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-monolithic_002ddeliver_002dasd_002dop"><code>monolithic-deliver-asd-op</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-monolithic_002dfasl_002dop-_0028obsolete_0029"><code>monolithic-fasl-op (obsolete)</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-monolithic_002dload_002dbundle_002dop"><code>monolithic-load-bundle-op</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-monolithic_002dload_002dfasl_002dop-_0028obsolete_0029"><code>monolithic-load-fasl-op (obsolete)</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-O">O</a></th><td></td><td></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-O">O</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-oos"><code>oos</code></a>:</td><td> </td><td valign="top"><a href="#Convenience-Functions">Convenience Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-oos-1"><code><code>oos</code></code></a>:</td><td> </td><td valign="top"><a href="#Operations">Operations</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-oos-1"><code>oos</code></a>:</td><td> </td><td valign="top"><a href="#Operations">Operations</a></td></tr> <tr><td></td><td valign="top"><a href="#index-operate"><code>operate</code></a>:</td><td> </td><td valign="top"><a href="#Convenience-Functions">Convenience Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-operate-1"><code><code>operate</code></code></a>:</td><td> </td><td valign="top"><a href="#Operations">Operations</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-operation-1"><code>operation</code></a>:</td><td> </td><td valign="top"><a href="#The-object-model-of-ASDF">The object model of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-operate-1"><code>operate</code></a>:</td><td> </td><td valign="top"><a href="#Operations">Operations</a></td></tr> <tr><td></td><td valign="top"><a href="#index-operation_002ddone_002dp"><code>operation-done-p</code></a>:</td><td> </td><td valign="top"><a href="#Creating-new-operations">Creating new operations</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-OPERATION_002dERROR"><code>OPERATION-ERROR</code></a>:</td><td> </td><td valign="top"><a href="#Error-handling">Error handling</a></td></tr> <tr><td></td><td valign="top"><a href="#index-output_002dfiles"><code>output-files</code></a>:</td><td> </td><td valign="top"><a href="#Creating-new-operations">Creating new operations</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-P">P</a></th><td></td><td></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-P">P</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-package_002dinferred_002dsystem"><code>package-inferred-system</code></a>:</td><td> </td><td valign="top"><a href="#The-package_002dinferred_002dsystem-extension">The package-inferred-system extension</a></td></tr> <tr><td></td><td valign="top"><a href="#index-parse_002dunix_002dnamestring"><code>parse-unix-namestring</code></a>:</td><td> </td><td valign="top"><a href="#Some-Utility-Functions">Some Utility Functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-perform"><code>perform</code></a>:</td><td> </td><td valign="top"><a href="#Creating-new-operations">Creating new operations</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-prepare_002dop"><code><code>prepare-op</code></code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> <tr><td></td><td valign="top"><a href="#index-primary_002dsystem_002dname"><code>primary-system-name</code></a>:</td><td> </td><td valign="top"><a href="#Components">Components</a></td></tr> <tr><td></td><td valign="top"><a href="#index-primary_002dsystem_002dname-1"><code>primary-system-name</code></a>:</td><td> </td><td valign="top"><a href="#Components">Components</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-R">R</a></th><td></td><td></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-R">R</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-register_002dimmutable_002dsystem"><code>register-immutable-system</code></a>:</td><td> </td><td valign="top"><a href="#Operations">Operations</a></td></tr> <tr><td></td><td valign="top"><a href="#index-register_002dimmutable_002dsystem-1"><code>register-immutable-system</code></a>:</td><td> </td><td valign="top"><a href="#Miscellaneous-Functions">Miscellaneous Functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-register_002dpreloaded_002dsystem"><code>register-preloaded-system</code></a>:</td><td> </td><td valign="top"><a href="#Miscellaneous-Functions">Miscellaneous Functions</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-register_002dsystem_002dpackages"><code>register-system-packages</code></a>:</td><td> </td><td valign="top"><a href="#The-package_002dinferred_002dsystem-extension">The package-inferred-system extension</a></td></tr> <tr><td></td><td valign="top"><a href="#index-require_002dsystem"><code>require-system</code></a>:</td><td> </td><td valign="top"><a href="#Convenience-Functions">Convenience Functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-run_002dprogram"><code>run-program</code></a>:</td><td> </td><td valign="top"><a href="#Some-Utility-Functions">Some Utility Functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-run_002dshell_002dcommand"><code>run-shell-command</code></a>:</td><td> </td><td valign="top"><a href="#Miscellaneous-Functions">Miscellaneous Functions</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-S">S</a></th><td></td><td></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-S">S</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-slurp_002dinput_002dstream"><code>slurp-input-stream</code></a>:</td><td> </td><td valign="top"><a href="#Some-Utility-Functions">Some Utility Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-source_002dfile"><code>source-file</code></a>:</td><td> </td><td valign="top"><a href="#Pre_002ddefined-subclasses-of-component">Pre-defined subclasses of component</a></td></tr> <tr><td></td><td valign="top"><a href="#index-source_002dfile_002dtype"><code>source-file-type</code></a>:</td><td> </td><td valign="top"><a href="#Pitfalls-of-the-transition-to-ASDF-2">Pitfalls of the transition to ASDF 2</a></td></tr> <tr><td></td><td valign="top"><a href="#index-subpathname"><code>subpathname</code></a>:</td><td> </td><td valign="top"><a href="#Some-Utility-Functions">Some Utility Functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-subpathname_002a"><code>subpathname*</code></a>:</td><td> </td><td valign="top"><a href="#Some-Utility-Functions">Some Utility Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-system-1"><code>system</code></a>:</td><td> </td><td valign="top"><a href="#Pre_002ddefined-subclasses-of-component">Pre-defined subclasses of component</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-SYSTEM_002dDEFINITION_002dERROR"><code>SYSTEM-DEFINITION-ERROR</code></a>:</td><td> </td><td valign="top"><a href="#Error-handling">Error handling</a></td></tr> <tr><td></td><td valign="top"><a href="#index-system_002ddefsystem_002ddepends_002don"><code>system-defsystem-depends-on</code></a>:</td><td> </td><td valign="top"><a href="#Information-about-system-dependencies">Information about system dependencies</a></td></tr> <tr><td></td><td valign="top"><a href="#index-system_002ddepends_002don"><code>system-depends-on</code></a>:</td><td> </td><td valign="top"><a href="#Information-about-system-dependencies">Information about system dependencies</a></td></tr> <tr><td></td><td valign="top"><a href="#index-system_002drelative_002dpathname"><code>system-relative-pathname</code></a>:</td><td> </td><td valign="top"><a href="#Miscellaneous-Functions">Miscellaneous Functions</a></td></tr> @@ -6384,45 +6516,47 @@ see the <samp>TODO</samp> file in the source repository. <tr><td></td><td valign="top"><a href="#index-system_002dsource_002ddirectory"><code>system-source-directory</code></a>:</td><td> </td><td valign="top"><a href="#Miscellaneous-Functions">Miscellaneous Functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-system_002dweakly_002ddepends_002don"><code>system-weakly-depends-on</code></a>:</td><td> </td><td valign="top"><a href="#Information-about-system-dependencies">Information about system dependencies</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-T">T</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-test_002dop"><code><code>test-op</code></code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-T">T</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-test_002dsystem"><code>test-system</code></a>:</td><td> </td><td valign="top"><a href="#Convenience-Functions">Convenience Functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-traverse"><code>traverse</code></a>:</td><td> </td><td valign="top"><a href="#Operations">Operations</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Function-and-Class-Index_fn_letter-V">V</a></th><td></td><td></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-U">U</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-uiop_003adefine_002dpackage"><code>uiop:define-package</code></a>:</td><td> </td><td valign="top"><a href="#The-package_002dinferred_002dsystem-extension">The package-inferred-system extension</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Function-and-Macro-Index_fn_letter-V">V</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-version_002dsatisfies"><code>version-satisfies</code></a>:</td><td> </td><td valign="top"><a href="#Common-attributes-of-components">Common attributes of components</a></td></tr> <tr><td></td><td valign="top"><a href="#index-version_002dsatisfies-1"><code>version-satisfies</code></a>:</td><td> </td><td valign="top"><a href="#Functions">Functions</a></td></tr> <tr><td colspan="4"> <hr></td></tr> </table> -<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Function-and-Class-Index_fn_letter-A"><b>A</b></a> +<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-A"><b>A</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-B"><b>B</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-C"><b>C</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-C"><b>C</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-D"><b>D</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-D"><b>D</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-E"><b>E</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-E"><b>E</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-F"><b>F</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-F"><b>F</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-I"><b>I</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-I"><b>I</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-L"><b>L</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-L"><b>L</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-M"><b>M</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-M"><b>M</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-O"><b>O</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-O"><b>O</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-P"><b>P</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-P"><b>P</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-R"><b>R</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-R"><b>R</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-S"><b>S</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-S"><b>S</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-T"><b>T</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-T"><b>T</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-U"><b>U</b></a> -<a class="summary-letter" href="#Function-and-Class-Index_fn_letter-V"><b>V</b></a> +<a class="summary-letter" href="#Function-and-Macro-Index_fn_letter-V"><b>V</b></a> </td></tr></table> @@ -6448,7 +6582,6 @@ see the <samp>TODO</samp> file in the source repository. <tr><td></td><td valign="top"><a href="#index-_002afeatures_002a-1"><code>*features*</code></a>:</td><td> </td><td valign="top"><a href="#Introduction">Introduction</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_002aimage_002ddump_002dhook_002a"><code>*image-dump-hook*</code></a>:</td><td> </td><td valign="top"><a href="#Resetting-the-ASDF-configuration">Resetting the ASDF configuration</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_002aLOAD_002dPATHNAME_002a"><code>*LOAD-PATHNAME*</code></a>:</td><td> </td><td valign="top"><a href="#LOAD_002dPATHNAME-has-a-weird-value">LOAD-PATHNAME has a weird value</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_002aload_002dsystem_002doperation_002a"><code>*load-system-operation*</code></a>:</td><td> </td><td valign="top"><a href="#Convenience-Functions">Convenience Functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_002aLOAD_002dTRUENAME_002a"><code>*LOAD-TRUENAME*</code></a>:</td><td> </td><td valign="top"><a href="#LOAD_002dPATHNAME-has-a-weird-value">LOAD-PATHNAME has a weird value</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_002anil_002dpathname_002a"><code>*nil-pathname*</code></a>:</td><td> </td><td valign="top"><a href="#Some-Utility-Functions">Some Utility Functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_002aoldest_002dforward_002dcompatible_002dasdf_002dversion_002a"><code>*oldest-forward-compatible-asdf-version*</code></a>:</td><td> </td><td valign="top"><a href="#Pitfalls-of-the-upgrade-to-ASDF-3">Pitfalls of the upgrade to ASDF 3</a></td></tr> @@ -6457,7 +6590,7 @@ see the <samp>TODO</samp> file in the source repository. <tr><td></td><td valign="top"><a href="#index-_002asystem_002ddefinition_002dsearch_002dfunctions_002a"><code>*system-definition-search-functions*</code></a>:</td><td> </td><td valign="top"><a href="#Components">Components</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Variable-Index_vr_letter-A">A</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-asdf_003a_003a_002auser_002dcache_002a"><code><code>asdf::*user-cache*</code></code></a>:</td><td> </td><td valign="top"><a href="#Output-Configuration-DSL">Output Configuration DSL</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-asdf_003a_003a_002auser_002dcache_002a"><code>asdf::*user-cache*</code></a>:</td><td> </td><td valign="top"><a href="#Output-Configuration-DSL">Output Configuration DSL</a></td></tr> <tr><td></td><td valign="top"><a href="#index-ASDF_005fOUTPUT_005fTRANSLATIONS"><code>ASDF_OUTPUT_TRANSLATIONS</code></a>:</td><td> </td><td valign="top"><a href="#Controlling-where-ASDF-saves-compiled-files">Controlling where ASDF saves compiled files</a></td></tr> <tr><td colspan="4"> <hr></td></tr> </table> @@ -6468,6 +6601,129 @@ see the <samp>TODO</samp> file in the source repository. </td></tr></table> +<hr> +<a name="Class-and-Type-Index"></a> +<a name="Class-and-Type-Index-1"></a> +<h2 class="unnumbered">Class and Type Index</h2> + +<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Class-and-Type-Index_tp_letter-B"><b>B</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-C"><b>C</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-D"><b>D</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-F"><b>F</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-I"><b>I</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-L"><b>L</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-M"><b>M</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-O"><b>O</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-P"><b>P</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-S"><b>S</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-T"><b>T</b></a> + +</td></tr></table> +<table class="index-tp" border="0"> +<tr><td></td><th align="left">Index Entry</th><td> </td><th align="left"> Section</th></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Class-and-Type-Index_tp_letter-B">B</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-binary_002dop-_0028obsolete_0029"><code>binary-op (obsolete)</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Class-and-Type-Index_tp_letter-C">C</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-compile_002dbundle_002dop"><code>compile-bundle-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-compile_002dbundle_002dop-1"><code>compile-bundle-op</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-compile_002dconcatenated_002dsource_002dop"><code>compile-concatenated-source-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-compile_002dop"><code>compile-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-component-1"><code>component</code></a>:</td><td> </td><td valign="top"><a href="#The-object-model-of-ASDF">The object model of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-concatenate_002dsource_002dop"><code>concatenate-source-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Class-and-Type-Index_tp_letter-D">D</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-deliver_002dasd_002dop"><code>deliver-asd-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-deliver_002dasd_002dop-1"><code>deliver-asd-op</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-dll_002dop"><code>dll-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Class-and-Type-Index_tp_letter-F">F</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-fasl_002dop-_0028obsolete_0029"><code>fasl-op (obsolete)</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Class-and-Type-Index_tp_letter-I">I</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-image_002dop"><code>image-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Class-and-Type-Index_tp_letter-L">L</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-lib_002dop"><code>lib-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-load_002dbundle_002dop"><code>load-bundle-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-load_002dbundle_002dop-1"><code>load-bundle-op</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-load_002dcompiled_002dconcatenated_002dsource_002dop"><code>load-compiled-concatenated-source-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-load_002dconcatenated_002dsource_002dop"><code>load-concatenated-source-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-load_002dfasl_002dop-_0028obsolete_0029"><code>load-fasl-op (obsolete)</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-load_002dop"><code>load-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-load_002dsource_002dop"><code>load-source-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Class-and-Type-Index_tp_letter-M">M</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-module"><code>module</code></a>:</td><td> </td><td valign="top"><a href="#Pre_002ddefined-subclasses-of-component">Pre-defined subclasses of component</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002dbinary_002dop-_0028obsolete_0029"><code>monolithic-binary-op (obsolete)</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002dcompile_002dbundle_002dop"><code>monolithic-compile-bundle-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002dcompile_002dbundle_002dop-1"><code>monolithic-compile-bundle-op</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002dcompile_002dconcatenated_002dsource_002dop"><code>monolithic-compile-concatenated-source-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002dconcatenate_002dsource_002dop"><code>monolithic-concatenate-source-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002ddeliver_002dasd_002dop"><code>monolithic-deliver-asd-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002ddeliver_002dasd_002dop-1"><code>monolithic-deliver-asd-op</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002ddll_002dop"><code>monolithic-dll-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002dfasl_002dop-_0028obsolete_0029"><code>monolithic-fasl-op (obsolete)</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002dlib_002dop"><code>monolithic-lib-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002dload_002dbundle_002dop"><code>monolithic-load-bundle-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002dload_002dbundle_002dop-1"><code>monolithic-load-bundle-op</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002dload_002dcompiled_002dconcatenated_002dsource_002dop"><code>monolithic-load-compiled-concatenated-source-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002dload_002dconcatenated_002dsource_002dop"><code>monolithic-load-concatenated-source-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-monolithic_002dload_002dfasl_002dop-_0028obsolete_0029"><code>monolithic-load-fasl-op (obsolete)</code></a>:</td><td> </td><td valign="top"><a href="#What-happened-to-the-bundle-operations">What happened to the bundle operations</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Class-and-Type-Index_tp_letter-O">O</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-operation-1"><code>operation</code></a>:</td><td> </td><td valign="top"><a href="#The-object-model-of-ASDF">The object model of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-operation_002derror"><code>operation-error</code></a>:</td><td> </td><td valign="top"><a href="#Error-handling">Error handling</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Class-and-Type-Index_tp_letter-P">P</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-prepare_002dop"><code>prepare-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-prepare_002dsource_002dop"><code>prepare-source-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-program_002dop"><code>program-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Class-and-Type-Index_tp_letter-S">S</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-source_002dfile"><code>source-file</code></a>:</td><td> </td><td valign="top"><a href="#Pre_002ddefined-subclasses-of-component">Pre-defined subclasses of component</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-system-1"><code>system</code></a>:</td><td> </td><td valign="top"><a href="#Pre_002ddefined-subclasses-of-component">Pre-defined subclasses of component</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-system_002ddefinition_002derror"><code>system-definition-error</code></a>:</td><td> </td><td valign="top"><a href="#Error-handling">Error handling</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Class-and-Type-Index_tp_letter-T">T</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-test_002dop"><code>test-op</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-operations-of-ASDF">Predefined operations of ASDF</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +</table> +<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Class-and-Type-Index_tp_letter-B"><b>B</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-C"><b>C</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-D"><b>D</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-F"><b>F</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-I"><b>I</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-L"><b>L</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-M"><b>M</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-O"><b>O</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-P"><b>P</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-S"><b>S</b></a> + +<a class="summary-letter" href="#Class-and-Type-Index_tp_letter-T"><b>T</b></a> + +</td></tr></table> + <div class="footnote"> <hr> <h4 class="footnotes-heading">Footnotes</h4> diff --git a/src/contrib/asdf/doc/asdf.info b/src/contrib/asdf/doc/asdf.info index d28e66c482154062b378b7b37f4a979d78c0ea3a..1de484e5846ae8ffe52888c085f369154598d006 100644 --- a/src/contrib/asdf/doc/asdf.info +++ b/src/contrib/asdf/doc/asdf.info @@ -1,4 +1,4 @@ -This is asdf.info, produced by makeinfo version 6.1 from asdf.texinfo. +This is asdf.info, produced by makeinfo version 6.5 from asdf.texinfo. This manual describes ASDF, a system definition facility for Common Lisp programs and libraries. @@ -6,16 +6,16 @@ programs and libraries. You can find the latest version of this manual at <https://common-lisp.net/project/asdf/asdf.html>. - ASDF Copyright (C) 2001-2016 Daniel Barlow and contributors. + ASDF Copyright © 2001-2019 Daniel Barlow and contributors. - This manual Copyright (C) 2001-2016 Daniel Barlow and contributors. + This manual Copyright © 2001-2019 Daniel Barlow and contributors. - This manual revised (C) 2009-2016 Robert P. Goldman and Francois-Rene + This manual revised © 2009-2019 Robert P. Goldman and Francois-Rene Rideau. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including +“Softwareâ€), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to @@ -24,7 +24,7 @@ the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + THE SOFTWARE IS PROVIDED “AS ISâ€, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY @@ -43,7 +43,7 @@ File: asdf.info, Node: Top, Next: Introduction, Prev: (dir), Up: (dir) ASDF: Another System Definition Facility **************************************** -Manual for Version 3.3.2 +Manual for Version 3.3.3 This manual describes ASDF, a system definition facility for Common Lisp programs and libraries. @@ -51,16 +51,16 @@ Lisp programs and libraries. You can find the latest version of this manual at <https://common-lisp.net/project/asdf/asdf.html>. - ASDF Copyright (C) 2001-2016 Daniel Barlow and contributors. + ASDF Copyright © 2001-2019 Daniel Barlow and contributors. - This manual Copyright (C) 2001-2016 Daniel Barlow and contributors. + This manual Copyright © 2001-2019 Daniel Barlow and contributors. - This manual revised (C) 2009-2016 Robert P. Goldman and Francois-Rene + This manual revised © 2009-2019 Robert P. Goldman and Francois-Rene Rideau. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including +“Softwareâ€), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to @@ -69,7 +69,7 @@ the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + THE SOFTWARE IS PROVIDED “AS ISâ€, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY @@ -95,10 +95,11 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. * Ongoing Work:: * Bibliography:: * Concept Index:: -* Function and Class Index:: -* Variable Index:: +* Function and Macro Index:: +* Variable Index:: +* Class and Type Index:: - -- The Detailed Node Listing -- + — The Detailed Node Listing — Loading ASDF @@ -208,7 +209,7 @@ FAQ * Issues with using and extending ASDF to define systems:: * ASDF development FAQs:: -"What has changed between ASDF 1, ASDF 2, and ASDF 3?" +“What has changed between ASDF 1, ASDF 2, and ASDF 3?†* What are ASDF 1 2 3?:: * How do I detect the ASDF version?:: @@ -228,7 +229,7 @@ Issues with installing the proper version of ASDF * My Common Lisp implementation comes with an outdated version of ASDF. What to do?:: * I'm a Common Lisp implementation vendor. When and how should I upgrade ASDF?:: -* After upgrading ASDF, ASDF (and Quicklisp) can't find my systems: After upgrading ASDF. +* After upgrading ASDF, ASDF (and Quicklisp) can’t find my systems: After upgrading ASDF. Issues with configuring ASDF @@ -258,14 +259,15 @@ File: asdf.info, Node: Introduction, Next: Quick start summary, Prev: Top, U 1 Introduction ************** -ASDF is Another System Definition Facility: a tool for specifying how -systems of Common Lisp software are made up of components (sub-systems -and files), and how to operate on these components in the right order so -that they can be compiled, loaded, tested, etc. If you are new to ASDF, -*note the quick start guide: Quick start summary. +ASDF, or Another System Definition Facility, is a _build system_: a tool +for specifying how systems of Common Lisp software are made up of +components (sub-systems and files), and how to operate on these +components in the right order so that they can be compiled, loaded, +tested, etc. If you are new to ASDF, *note the quick start guide: Quick +start summary. ASDF presents three faces: one for users of Common Lisp software who -want to reuse other people's code, one for writers of Common Lisp +want to reuse other people’s code, one for writers of Common Lisp software who want to specify how to build their systems, and one for implementers of Common Lisp extensions who want to extend the build system. For more specifics, *note Using ASDF::, to learn how to use @@ -274,19 +276,19 @@ learn how to define a system of your own. *Note The object model of ASDF::, for a description of the ASDF internals and how to extend ASDF. Note that ASDF is _not_ a tool for library and system _installation_; -it plays a role like 'make' or 'ant', not like a package manager. In +it plays a role like ‘make’ or ‘ant’, not like a package manager. In particular, ASDF should not to be confused with Quicklisp or ASDF-Install, that attempt to find and download ASDF systems for you. Despite what the name might suggest, ASDF-Install was never a part of -ASDF, it was a separate piece of software. ASDF-Install is also -unmaintained and obsolete. We recommend you use Quicklisp -(<http://www.quicklisp.org/>) instead, a Common Lisp package manager -which works well and is being actively maintained. If you want to -download software from version control instead of tarballs, so you may -more easily modify it, we recommend clbuild +ASDF; it was always a separate piece of software. ASDF-Install has also +been unmaintained and obsolete for a very long time. We recommend you +use Quicklisp (<http://www.quicklisp.org/>) instead, a Common Lisp +package manager which works well and is being actively maintained. If +you want to download software from version control instead of tarballs, +so you may more easily modify it, we recommend clbuild (<http://common-lisp.net/project/clbuild/>). As for where on your filesystem to install Common Lisp software, we recommend subdirectories -of '~/common-lisp/': starting with ASDF 3.1.2 (2014), this hierarchy is +of ‘~/common-lisp/’: starting with ASDF 3.1.2 (2014), this hierarchy is included in the default source-registry configuration. Finally, note that this manual is incomplete. All the bases are @@ -302,39 +304,39 @@ File: asdf.info, Node: Quick start summary, Next: Loading ASDF, Prev: Introdu 2 Quick start summary ********************* - * To load an ASDF system: + • To load an ASDF system: - * Load ASDF itself into your Lisp image, using '(require - "asdf")'. Check that you have a recent version using - '(asdf:asdf-version)'. For more details, or if any of the + • Load ASDF itself into your Lisp image, using ‘(require + "asdf")’. Check that you have a recent version using + ‘(asdf:asdf-version)’. For more details, or if any of the above fails, *note Loading ASDF::. - * Make sure software is installed where ASDF can find it. The + • Make sure software is installed where ASDF can find it. The simplest way is to put all your Lisp code in subdirectories of - '~/common-lisp/' (starting with ASDF 3.1.2), or - '~/.local/share/common-lisp/source/' (for ASDF 2 and later, or + ‘~/common-lisp/’ (starting with ASDF 3.1.2), or + ‘~/.local/share/common-lisp/source/’ (for ASDF 2 and later, or if you want to keep source in a hidden directory). For more details, *note Configuring ASDF to find your systems::. - * Load your system with '(asdf:load-system "MY-SYSTEM")'. *Note + • Load your system with ‘(asdf:load-system "MY-SYSTEM")’. *Note Using ASDF::. - * To make your own ASDF system: + • To make your own ASDF system: - * As above, load and configure ASDF. + • As above, load and configure ASDF. - * Make a new directory for your system, 'MY-SYSTEM/', again in a + • Make a new directory for your system, ‘MY-SYSTEM/’, again in a location where ASDF can find it. All else being equal, the - easiest location is probably '~/common-lisp/my-system/'. + easiest location is probably ‘~/common-lisp/my-system/’. *Note Configuring ASDF to find your systems::. - * Create an ASDF system definition listing the dependencies of + • Create an ASDF system definition listing the dependencies of your system, its components, and their interdependencies, and - put it in 'MY-SYSTEM.asd'. This file must have the same name + put it in ‘MY-SYSTEM.asd’. This file must have the same name as your system, all lowercase. *Note Defining systems with defsystem::. - * Use '(asdf:load-system "MY-SYSTEM")' to make sure it's all + • Use ‘(asdf:load-system "MY-SYSTEM")’ to make sure it’s all working properly. *Note Using ASDF::. @@ -361,39 +363,39 @@ The recommended way to load ASDF is via: (require "asdf") All actively maintained Lisp implementations now include a copy of -ASDF 3 that you can load this way using Common Lisp's 'require' +ASDF 3 that you can load this way using Common Lisp’s ‘require’ function.(1) - If the implementation you are using doesn't provide a recent ASDF 3, + If the implementation you are using doesn’t provide a recent ASDF 3, we recommend you upgrade it. If for some reason you would rather not -upgrade it, we recommend you replace your implementation's ASDF. *Note +upgrade it, we recommend you replace your implementation’s ASDF. *Note Replacing your implementation's ASDF::. If all else fails, see *note Loading ASDF from source:: below. If you use an actively maintained implementation that fails to provide an up-to-date enough stable release of ASDF, you may also send a -bug report to your Lisp vendor and complain about it -- or you may fix -the issue yourself if it's free software. +bug report to your Lisp vendor and complain about it — or you may fix +the issue yourself if it’s free software. As of the writing of this manual, the following implementations provide ASDF 3 this way: ABCL, Allegro CL, CLASP, Clozure CL, CMUCL, ECL, GNU CLISP, LispWorks, MKCL, SBCL. The following implementations -only provide ASDF 2: MOCL, XCL. The following implementations don't +only provide ASDF 2: MOCL, XCL. The following implementations don’t provide ASDF: Corman CL, GCL, Genera, MCL, SCL. The latter implementations are not actively maintained (except maybe GCL); if some of them are ever released again, they probably will include ASDF 3. For maximum convenience you might want to have ASDF loaded whenever you start your Lisp implementation, for example by loading it from the -startup script or dumping a custom core -- check your Lisp -implementation's manual for details. SLIME notably sports a -'slime-asdf' contrib that makes life easier with ASDF. +startup script or dumping a custom core — check your Lisp +implementation’s manual for details. SLIME notably sports a +‘slime-asdf’ contrib that makes life easier with ASDF. ---------- Footnotes ---------- - (1) NB: all implementations except GNU CLISP also accept '(require -"ASDF")', '(require 'asdf)' and '(require :asdf)'. For portability's -sake, you should use '(require "asdf")'. + (1) NB: all implementations except GNU CLISP also accept ‘(require +"ASDF")’, ‘(require 'asdf)’ and ‘(require :asdf)’. For portability’s +sake, you should use ‘(require "asdf")’. File: asdf.info, Node: Checking whether ASDF is loaded, Next: Upgrading ASDF, Prev: Loading a pre-installed ASDF, Up: Loading ASDF @@ -430,10 +432,10 @@ but you want a more recent ASDF version than your implementation provides, then you just need to ensure the more recent ASDF is installed in a configured path, like any other system. We recommend you download an official tarball or checkout a release from git into -'~/common-lisp/asdf/'. (*note Configuring ASDF to find your systems::). +‘~/common-lisp/asdf/’. (*note Configuring ASDF to find your systems::). - Once the source code for ASDF is installed, you don't need any extra -step to load it beyond the usual '(require "asdf")': ASDF 3 will + Once the source code for ASDF is installed, you don’t need any extra +step to load it beyond the usual ‘(require "asdf")’: ASDF 3 will automatically look whether an updated version of itself is available amongst the regularly configured systems, before it compiles anything else. @@ -444,30 +446,30 @@ Replacing your implementation's ASDF::. File: asdf.info, Node: Replacing your implementation's ASDF, Next: Loading ASDF from source, Prev: Upgrading ASDF, Up: Loading ASDF -3.4 Replacing your implementation's ASDF +3.4 Replacing your implementation’s ASDF ======================================== All maintained implementations now provide ASDF 3 in their latest -release. If yours doesn't, we recommend you upgrade it. +release. If yours doesn’t, we recommend you upgrade it. - Now, if you insist on using an old implementation that didn't provide + Now, if you insist on using an old implementation that didn’t provide ASDF or provided an old version, we recommend installing a recent ASDF, -as explained below, into your implementation's installation directory. +as explained below, into your implementation’s installation directory. Thus your modified implementation will now provide ASDF 3. This requires proper write permissions and may necessitate execution as a system administrator. The ASDF source repository contains a tool to help you upgrade your -implementation's ASDF. You can invoke it from the shell command-line as -'tools/asdf-tools install-asdf lispworks' (where you can replace -'lispworks' by the name of the relevant implementation), or you can -'(load "tools/install-asdf.lisp")' from your Lisp REPL. +implementation’s ASDF. You can invoke it from the shell command-line as +‘tools/asdf-tools install-asdf lispworks’ (where you can replace +‘lispworks’ by the name of the relevant implementation), or you can +‘(load "tools/install-asdf.lisp")’ from your Lisp REPL. This script works on Allegro CL, Clozure CL, CMU CL, ECL, GCL, GNU -CLISP, LispWorks, MKCL, SBCL, SCL, XCL. It doesn't work on ABCL, Corman +CLISP, LispWorks, MKCL, SBCL, SCL, XCL. It doesn’t work on ABCL, Corman CL, Genera, MCL, MOCL. Happily, ABCL is usually pretty up to date and -shouldn't need that script. GCL requires a very recent version, and -hasn't been tested much. Corman CL, Genera, MCL are obsolete anyway. +shouldn’t need that script. GCL requires a very recent version, and +hasn’t been tested much. Corman CL, Genera, MCL are obsolete anyway. MOCL is incomplete. @@ -479,21 +481,21 @@ File: asdf.info, Node: Loading ASDF from source, Prev: Replacing your implemen If you write build scripts that must remain portable to old machines with old implementations that you cannot ensure have been upgraded or modified to provide a recent ASDF, you may have to install the file -'asdf.lisp' somewhere and load it with: +‘asdf.lisp’ somewhere and load it with: (load "/path/to/your/installed/asdf.lisp") - The single file 'asdf.lisp' is all you normally need to use ASDF. + The single file ‘asdf.lisp’ is all you normally need to use ASDF. You can extract this file from latest release tarball on the ASDF website (https://common-lisp.net/project/asdf/). If you are daring and willing to report bugs, you can get the latest and greatest version of ASDF from its git repository. *Note Getting the latest version::. - For scripts that try to use ASDF simply via 'require' at first, and -make heroic attempts to load it the hard way if at first they don't -succeed, see 'tools/load-asdf.lisp' distributed with the ASDF source -repository, or the code of 'cl-launch' (https://cliki.net/cl-launch). + For scripts that try to use ASDF simply via ‘require’ at first, and +make heroic attempts to load it the hard way if at first they don’t +succeed, see ‘tools/load-asdf.lisp’ distributed with the ASDF source +repository, or the code of ‘cl-launch’ (https://cliki.net/cl-launch). File: asdf.info, Node: Configuring ASDF, Next: Using ASDF, Prev: Loading ASDF, Up: Top @@ -523,50 +525,50 @@ File: asdf.info, Node: Configuring ASDF to find your systems, Next: Configurin ========================================= In order to compile and load your systems, ASDF must be configured to -find the '.asd' files that contain system definitions. +find the ‘.asd’ files that contain system definitions. There are a number of different techniques for setting yourself up with ASDF, starting from easiest to the most complex: - * Put all of your systems in one of the standard locations, + • Put all of your systems in one of the standard locations, subdirectories of - * '~/common-lisp/' or - * '~/.local/share/common-lisp/source/'. - If you install software there, you don't need further + • ‘~/common-lisp/’ or + • ‘~/.local/share/common-lisp/source/’. + If you install software there, you don’t need further configuration.(1) You can then skip to the next section. *Note Loading a system::. - * If you're using some tool to install software (e.g. Quicklisp), + • If you’re using some tool to install software (e.g. Quicklisp), the authors of that tool should already have configured ASDF. - * If you have more specific desires about how to lay out your + • If you have more specific desires about how to lay out your software on disk, the preferred way to configure where ASDF finds - your systems is the 'source-registry' facility, fully described in + your systems is the ‘source-registry’ facility, fully described in its own chapter of this manual. *Note Controlling where ASDF searches for systems::. Here is a quick recipe for getting started. First create the directory - '~/.config/common-lisp/source-registry.conf.d/'(2); there create a - file with any name of your choice but with the type 'conf'(3), for - instance '50-luser-lisp.conf'; in this file, add the following line + ‘~/.config/common-lisp/source-registry.conf.d/’(2); there create a + file with any name of your choice but with the type ‘conf’(3), for + instance ‘50-luser-lisp.conf’; in this file, add the following line to tell ASDF to recursively scan all the subdirectories under - '/home/luser/lisp/' for '.asd' files: '(:tree "/home/luser/lisp/")' + ‘/home/luser/lisp/’ for ‘.asd’ files: ‘(:tree "/home/luser/lisp/")’ - That's enough. You may replace '/home/luser/lisp/' by wherever you - want to install your source code. You don't actually need to - specify anything if you use the default '~/common-lisp/' as above + That’s enough. You may replace ‘/home/luser/lisp/’ by wherever you + want to install your source code. You don’t actually need to + specify anything if you use the default ‘~/common-lisp/’ as above and your implementation provides ASDF 3.1.2 or later. If your implementation provides an earlier variant of ASDF 3, you might - want to specify '(:tree (:home "common-lisp/"))' for bootstrap + want to specify ‘(:tree (:home "common-lisp/"))’ for bootstrap purposes, then install a recent source tree of ASDF under - '~/common-lisp/asdf/'. + ‘~/common-lisp/asdf/’. - If you prefer to use a "link farm", which is faster to use but + If you prefer to use a “link farmâ€, which is faster to use but costlier to manage than a recursive traversal, say at - '/home/luser/.asd-link-farm/', then you may instead (or - additionally) create a file '42-asd-link-farm.conf', containing the - line: '(:directory "/home/luser/.asd-link-farm/")' + ‘/home/luser/.asd-link-farm/’, then you may instead (or + additionally) create a file ‘42-asd-link-farm.conf’, containing the + line: ‘(:directory "/home/luser/.asd-link-farm/")’ ASDF will automatically read your configuration the first time you try to find a system. If necessary, you can reset the @@ -574,8 +576,8 @@ with ASDF, starting from easiest to the most complex: (asdf:clear-source-registry) - * In earlier versions of ASDF, the system source registry was - configured using a global variable, 'asdf:*central-registry*'. For + • In earlier versions of ASDF, the system source registry was + configured using a global variable, ‘asdf:*central-registry*’. For more details about this, see the following section, *note Configuring ASDF to find your systems --- old style::. Unless you need to understand this, skip directly to *note Configuring where @@ -587,67 +589,67 @@ you. ---------- Footnotes ---------- - (1) '~/common-lisp/' is only included in the default configuration + (1) ‘~/common-lisp/’ is only included in the default configuration starting with ASDF 3.1.2 or later. If your implementation provides an earlier variant of ASDF, you may need to explicitly configure it to use this path, as further explained. (2) For Windows users, and starting with ASDF 3.1.5, start from your -'%LOCALAPPDATA%', which is usually '~/AppData/Local/' (but you can ask -in a 'CMD.EXE' terminal 'echo %LOCALAPPDATA%' to make sure) and +‘%LOCALAPPDATA%’, which is usually ‘~/AppData/Local/’ (but you can ask +in a ‘CMD.EXE’ terminal ‘echo %LOCALAPPDATA%’ to make sure) and underneath create a subpath -'config/common-lisp/source-registry.conf.d/'. +‘config/common-lisp/source-registry.conf.d/’. - (3) By requiring the '.conf' extension, and ignoring other files, + (3) By requiring the ‘.conf’ extension, and ignoring other files, ASDF allows you to have disabled files, editor backups, etc. in the same directory with your active configuration files. - ASDF will also ignore files whose names start with a '.' character. + ASDF will also ignore files whose names start with a ‘.’ character. It is customary to start the filename with two digits, to control the -sorting of the 'conf' files in the source registry directory, and thus +sorting of the ‘conf’ files in the source registry directory, and thus the order in which the directories will be scanned. File: asdf.info, Node: Configuring ASDF to find your systems --- old style, Next: Configuring where ASDF stores object files, Prev: Configuring ASDF to find your systems, Up: Configuring ASDF -4.2 Configuring ASDF to find your systems -- old style -====================================================== +4.2 Configuring ASDF to find your systems — old style +===================================================== Novices may skip this section. Please _do not_ use the central-registry if you are a novice, and _do not_ instruct novices to use the central-registry. - The old way to configure ASDF to find your systems is by 'push'ing -directory pathnames onto the variable 'asdf:*central-registry*'. + The old way to configure ASDF to find your systems is by ‘push’ing +directory pathnames onto the variable ‘asdf:*central-registry*’. You _must_ configure this variable _after_ you load ASDF 3 or later, yet _before_ the first time you try to use it. This loading and configuring of ASDF must happen as part of some initialization script: typically, either a script you maintain that builds your project, or -your implementation's initialization script (e.g. '~/.sbclrc' for +your implementation’s initialization script (e.g. ‘~/.sbclrc’ for SBCL). Also, if you are using an ancient ASDF 2 or earlier to load ASDF 3 or later, then after it loads the ancient ASDF, your script _must_ configure the central-registry a first time to tell ASDF 1 or 2 where to -find ASDF 3, then load ASDF 3 with e.g. '(asdf:operate 'asdf:load-op -"asdf")', then configure the central-registry again, because ASDF 3 will +find ASDF 3, then load ASDF 3 with e.g. ‘(asdf:operate 'asdf:load-op +"asdf")’, then configure the central-registry again, because ASDF 3 will not preserve the central-registry from ASDF 2 when upgrading. You should probably be using the source-registry instead, which will be -preserved (unless you manually called 'asdf:initialize-source-registry' +preserved (unless you manually called ‘asdf:initialize-source-registry’ with an argument, in which case you will have to do it again indeed). However, if you are using an ancient ASDF 2 or earlier, we _strongly_ recommend that you should instead upgrade your implementation, or overwrite the ancient ASDF installation with a more recent one: *Note Replacing your implementation's ASDF::. - The 'asdf:*central-registry*' is empty by default in ASDF 2 or ASDF + The ‘asdf:*central-registry*’ is empty by default in ASDF 2 or ASDF 3, but is still supported for compatibility with ASDF 1. When used, it takes precedence over the above source-registry.(1) - For example, let's say you want ASDF to find the '.asd' file -'/home/me/src/foo/foo.asd'. In your Lisp initialization file, you could + For example, let’s say you want ASDF to find the ‘.asd’ file +‘/home/me/src/foo/foo.asd’. In your Lisp initialization file, you could have the following: (require "asdf") @@ -656,23 +658,23 @@ have the following: Note the trailing slash: when searching for a system, ASDF will evaluate each entry of the central registry and coerce the result to a pathname.(2) The trailing directory name separator is necessary to tell -Lisp that you're discussing a directory rather than a file. If you -leave it out, ASDF is likely to look in '/home/me/src/' instead of -'/home/me/src/foo/' as you intended, and fail to find your system +Lisp that you’re discussing a directory rather than a file. If you +leave it out, ASDF is likely to look in ‘/home/me/src/’ instead of +‘/home/me/src/foo/’ as you intended, and fail to find your system definition. Modern versions of ASDF will issue an error and offer you to remove such entries from the central-registry. - Typically there are a lot of '.asd' files, and a common idiom was to -put _symbolic links_ to all of one's '.asd' files in a common directory -and push _that_ directory (the "link farm") onto -'asdf:*central-registry*', instead of pushing each individual system + Typically there are a lot of ‘.asd’ files, and a common idiom was to +put _symbolic links_ to all of one’s ‘.asd’ files in a common directory +and push _that_ directory (the “link farmâ€) onto +‘asdf:*central-registry*’, instead of pushing each individual system directory. ASDF knows to follow _symlinks_ to the actual location of the systems.(3) - For example, if '#p"/home/me/cl/systems/"' is an element of -'*central-registry*', you could set up the system FOO as follows: + For example, if ‘#p"/home/me/cl/systems/"’ is an element of +‘*central-registry*’, you could set up the system FOO as follows: $ cd /home/me/cl/systems/ $ ln -s ~/src/foo/foo.asd . @@ -685,24 +687,24 @@ search path. ---------- Footnotes ---------- (1) It is possible to further customize the system definition file -search. That's considered advanced use, and covered later: search -forward for '*system-definition-search-functions*'. *Note Defining +search. That’s considered advanced use, and covered later: search +forward for ‘*system-definition-search-functions*’. *Note Defining systems with defsystem::. - (2) ASDF will indeed call 'eval' on each entry. It will skip entries -that evaluate to 'nil'. + (2) ASDF will indeed call ‘eval’ on each entry. It will skip entries +that evaluate to ‘nil’. Strings and pathname objects are self-evaluating, in which case the -'eval' step does nothing; but you may push arbitrary s-expressions onto +‘eval’ step does nothing; but you may push arbitrary s-expressions onto the central registry. These s-expressions may be evaluated to compute context-dependent entries, e.g. things that depend on the value of shell variables or the identity of the user. - The variable 'asdf:*central-registry*' is thus a list of "system -directory designators". A "system directory designator" is a form which + The variable ‘asdf:*central-registry*’ is thus a list of “system +directory designatorsâ€. A “system directory designator†is a form which will be evaluated whenever a system is to be found, and must evaluate to -a directory to look in (or 'nil'). By "directory", we mean "designator -for a pathname with a non-empty DIRECTORY component". +a directory to look in (or ‘nil’). By “directoryâ€, we mean “designator +for a pathname with a non-empty DIRECTORY componentâ€. (3) On Windows, you can use Windows shortcuts instead of POSIX symlinks. if you try aliases under MacOS, we are curious to hear about @@ -715,7 +717,7 @@ File: asdf.info, Node: Configuring where ASDF stores object files, Next: Reset ============================================== ASDF lets you configure where object files will be stored. Sensible -defaults are provided and you shouldn't normally have to worry about it. +defaults are provided and you shouldn’t normally have to worry about it. This allows the same source code repository to be shared between several versions of several Common Lisp implementations, between several @@ -723,7 +725,7 @@ users using different compilation options, with users who lack write privileges on shared source directories, etc. This also keeps source directories from being cluttered with object/fasl files. - Starting with ASDF 2, the 'asdf-output-translations' facility was + Starting with ASDF 2, the ‘asdf-output-translations’ facility was added to ASDF itself. This facility controls where object files will be stored. This facility is fully described in a chapter of this manual, *note Controlling where ASDF saves compiled files::. @@ -749,14 +751,14 @@ you may use the following function: Undoes any ASDF configuration regarding source-registry or output-translations. - This function is pushed onto the 'uiop:*image-dump-hook*' by default, -which means that if you save an image using 'uiop:dump-image', or via -'asdf:image-op' and 'asdf:program-op', it will be automatically called + This function is pushed onto the ‘uiop:*image-dump-hook*’ by default, +which means that if you save an image using ‘uiop:dump-image’, or via +‘asdf:image-op’ and ‘asdf:program-op’, it will be automatically called to clear your configuration. If for some reason you prefer to call your -implementation's underlying functionality, be sure to call -'clear-configuration' manually, or push it into your implementation's -equivalent of 'uiop:*image-dump-hook*', e.g. 'sb-ext:*save-hooks*' on -SBCL, or 'ext:*before-save-initializations*' on CMUCL and SCL, etc. +implementation’s underlying functionality, be sure to call +‘clear-configuration’ manually, or push it into your implementation’s +equivalent of ‘uiop:*image-dump-hook*’, e.g. ‘sb-ext:*save-hooks*’ on +SBCL, or ‘ext:*before-save-initializations*’ on CMUCL and SCL, etc. File: asdf.info, Node: Using ASDF, Next: Defining systems with defsystem, Prev: Configuring ASDF, Up: Top @@ -782,20 +784,21 @@ following Lisp form: (asdf:load-system :FOO) On some implementations (*note Convenience Functions::), ASDF hooks -into the 'cl:require' facility and you can just use: +into the ‘cl:require’ facility and you can just use: (require :FOO) - Note that the canonical name of a system is a string, conventionally -lowercase. A system name can also be specified as a symbol (including a -keyword), in which case its 'symbol-name' is taken and lowercased. The -name must be a suitable value for the ':name' initarg to 'make-pathname' -in whatever filesystem the system is to be found. + Note that the canonical name of a system is a string, in _lowercase_. +System names can also be specified as symbols (including keyword +symbols). If a symbol is given as argument, its package is ignored, its +‘symbol-name’ is taken, and converted to lowercase. The name must be a +suitable value for the ‘:name’ initarg to ‘make-pathname’ in whatever +filesystem the system is to be found. - The lower-casing-symbols behaviour is unconventional, but was -selected after some consideration. The type of systems we want to -support either have lowercase as customary case (Unix, Mac, Windows) or -silently convert lowercase to uppercase (lpns). + Using lowercase as canonical is unconventional, but was selected +after some consideration. The type of file systems we support either +have lowercase as customary case (Unix, Mac, Windows) or silently +convert lowercase to uppercase (lpns). File: asdf.info, Node: Convenience Functions, Next: Moving on, Prev: Loading a system, Up: Using ASDF @@ -804,98 +807,95 @@ File: asdf.info, Node: Convenience Functions, Next: Moving on, Prev: Loading ========================= ASDF provides three commands for the most common system operations: -'load-system', 'compile-system', and 'test-system'. +‘load-system’, ‘compile-system’, and ‘test-system’. - ASDF also provides 'require-system', a variant of 'load-system' that + ASDF also provides ‘require-system’, a variant of ‘load-system’ that skips loading systems that are already loaded. This is sometimes useful, for example, in order to avoid re-loading libraries that come pre-loaded into your lisp implementation. - ASDF also provides 'make', a way of allowing system developers to + ASDF also provides ‘make’, a way of allowing system developers to choose a default operation for their systems. For example, a developer who has created a system intended to format a specific document, might -make document-formatting the default operation invoked by 'make', -instead of loading. If the system developer doesn't specify in the +make document-formatting the default operation invoked by ‘make’, +instead of loading. If the system developer doesn’t specify in the system definition, the default operation will be loading. Because ASDF is an extensible system for defining _operations_ on -_components_, it also provides a generic function 'operate', so you may +_components_, it also provides a generic function ‘operate’, so you may arbitrarily operate on your systems beyond the default operations. (At -the interactive REPL, users often use its shorter alias 'oos', which -stands for operate-on-system, a name inherited from 'mk-defsystem'.) -You'll use 'operate' whenever you want to do something beyond compiling, +the interactive REPL, users often use its shorter alias ‘oos’, which +stands for operate-on-system, a name inherited from ‘mk-defsystem’.) +You’ll use ‘operate’ whenever you want to do something beyond compiling, loading and testing. -- Function: load-system system &rest keys &key force force-not verbose version &allow-other-keys - Apply 'operate' with the operation from '*load-system-operation*' - the SYSTEM, and any provided keyword arguments. - '*load-system-operation*' by default is 'load-op'; it would be - 'load-bundle-op' by default on ECL, if only an implementation bug - were fixed. Calling 'load-system' is the regular, recommended way - to load a system into the current image. + Apply ‘operate’ with the operation ‘load-op’, the SYSTEM, and any + provided keyword arguments. Calling ‘load-system’ is the regular, + recommended way to load a system into the current image. -- Function: compile-system system &rest keys &key force force-not verbose version &allow-other-keys - Apply 'operate' with the operation 'compile-op', the SYSTEM, and + Apply ‘operate’ with the operation ‘compile-op’, the SYSTEM, and any provided keyword arguments. This will make sure all the files in the system are compiled, but not necessarily load any of them in the current image; on most systems, it will _not_ load all compiled files in the current image. This function exists for symmetry with - 'load-system' but is not recommended unless you are writing build - scripts and know what you're doing. But then, you might be - interested in 'program-op' rather than 'compile-op'. + ‘load-system’ but is not recommended unless you are writing build + scripts and know what you’re doing. But then, you might be + interested in ‘program-op’ rather than ‘compile-op’. -- Function: test-system system &rest keys &key force force-not verbose version &allow-other-keys - Apply 'operate' with the operation 'test-op', the SYSTEM, and any + Apply ‘operate’ with the operation ‘test-op’, the SYSTEM, and any provided keyword arguments. *Note test-op::. -- Function: make system &rest keys &key &allow-other-keys - Do "The Right Thing" with your system. Starting with ASDF 3.1, - this function 'make' is also available. The default behaviour is - to load the system as if by 'load-system'; but system authors can + Do “The Right Thing†with your system. Starting with ASDF 3.1, + this function ‘make’ is also available. The default behaviour is + to load the system as if by ‘load-system’; but system authors can override this default in their system definition they may specify an alternate operation as the intended use of their system, with a - ':build-operation' option in the 'defsystem' form (*note - build-operation: The defsystem grammar.), and an intended output - pathname for that operation with ':build-pathname'. This function - is experimental and largely untested. Use at your own risk. + ‘:build-operation’ option in the ‘defsystem’ form (*note + Build-operation::), and an intended output pathname for that + operation with ‘:build-pathname’. This function is experimental + and largely untested. Use at your own risk. -- Function: require-system system &rest keys &key &allow-other-keys - 'require-system' skips any update to systems that have already been - loaded, in the spirit of 'cl:require'. It does it by calling - 'load-system' with a keyword option excluding already loaded + ‘require-system’ skips any update to systems that have already been + loaded, in the spirit of ‘cl:require’. It does it by calling + ‘load-system’ with a keyword option excluding already loaded systems.(1). On actively maintained free software implementations (namely recent versions of ABCL, Clozure CL, CMUCL, ECL, GNU CLISP, - MKCL and SBCL), once ASDF itself is loaded, 'cl:require' too can - load ASDF systems, by falling back on 'require-system' for module + MKCL and SBCL), once ASDF itself is loaded, ‘cl:require’ too can + load ASDF systems, by falling back on ‘require-system’ for module names not recognized by the implementation. (Note however that - 'require-system' does _not_ fall back on 'cl:require'; that would - introduce an "interesting" potential infinite loop to break + ‘require-system’ does _not_ fall back on ‘cl:require’; that would + introduce an “interesting†potential infinite loop to break somehow.) - 'cl:require' and 'require-system' are appropriate to load code that + ‘cl:require’ and ‘require-system’ are appropriate to load code that is not being modified during the current programming session. - 'cl:require' will notably load the implementation-provided - extension modules; 'require-system' won't, unless they are also + ‘cl:require’ will notably load the implementation-provided + extension modules; ‘require-system’ won’t, unless they are also defined as systems somehow, which SBCL and MKCL do. - 'require-system' may also be used to load any number of ASDF - systems that the user isn't either developing or debugging, for + ‘require-system’ may also be used to load any number of ASDF + systems that the user isn’t either developing or debugging, for which a previously installed version is deemed to be satisfactory; - 'cl:require' on the above-mentioned implementations will delegate - to 'require-system' and may load them as well. But for code that + ‘cl:require’ on the above-mentioned implementations will delegate + to ‘require-system’ and may load them as well. But for code that you are actively developing, debugging, or otherwise modifying, you - should use 'load-system', so ASDF will pick on your modifications + should use ‘load-system’, so ASDF will pick on your modifications and transitively re-build the modified files and everything that - depends on them (that the requested SYSTEM itself depends on -- - ASDF itself never builds anything unless it's an explicitly - requested system or the dependencies thereof). + depends on them (that the requested SYSTEM itself depends on — ASDF + itself never builds anything unless it’s an explicitly requested + system or the dependencies thereof). ---------- Footnotes ---------- - (1) For the curious, the option is ':force-not -(already-loaded-systems)'. + (1) For the curious, the option is ‘:force-not +(already-loaded-systems)’. File: asdf.info, Node: Moving on, Prev: Convenience Functions, Up: Using ASDF @@ -903,7 +903,7 @@ File: asdf.info, Node: Moving on, Prev: Convenience Functions, Up: Using ASDF 5.3 Moving on ============= -That's all you need to know to use ASDF to load systems written by +That’s all you need to know to use ASDF to load systems written by others. The rest of this manual deals with writing system definitions for Common Lisp software you write yourself, including how to extend ASDF to define new operation and component types. @@ -932,11 +932,11 @@ File: asdf.info, Node: The defsystem form, Next: A more involved example, Pre ====================== This section begins with an example of a system definition, then gives -the full grammar of 'defsystem'. +the full grammar of ‘defsystem’. - Let's look at a simple system. This is a complete file that should -be saved as 'hello-lisp.asd' (in order that ASDF can find it when -ordered to operate on the system named '"hello-lisp"'). + Let’s look at a simple system. This is a complete file that should +be saved as ‘hello-lisp.asd’ (in order that ASDF can find it when +ordered to operate on the system named ‘"hello-lisp"’). ;; Usual Lisp comments are allowed here @@ -952,42 +952,42 @@ ordered to operate on the system named '"hello-lisp"'). Some notes about this example: - * The 'defsystem' form defines a system named 'hello-lisp' that - contains three source files: 'packages.lisp', 'macros.lisp' and - 'hello.lisp'. + • The ‘defsystem’ form defines a system named ‘hello-lisp’ that + contains three source files: ‘packages.lisp’, ‘macros.lisp’ and + ‘hello.lisp’. - * The '.lisp' suffix is implicit for Lisp source files. The source - files are located in the same directory as the '.asd' file with the + • The ‘.lisp’ suffix is implicit for Lisp source files. The source + files are located in the same directory as the ‘.asd’ file with the system definition. - * The file 'macros' depends on 'packages' (presumably because the - package it's in is defined in 'packages'), and the file 'hello' - depends on 'macros' (and hence, transitively on 'packages'). This - means that ASDF will compile and load 'packages' then 'macros' - before starting the compilation of file 'hello'. + • The file ‘macros’ depends on ‘packages’ (presumably because the + package it’s in is defined in ‘packages’), and the file ‘hello’ + depends on ‘macros’ (and hence, transitively on ‘packages’). This + means that ASDF will compile and load ‘packages’ then ‘macros’ + before starting the compilation of file ‘hello’. - * This example system has external dependencies on two other systems, - 'optima.ppcre' (that provides a friendly interface to matching - regular expressions), and 'command-line-arguments' (that provides a + • This example system has external dependencies on two other systems, + ‘optima.ppcre’ (that provides a friendly interface to matching + regular expressions), and ‘command-line-arguments’ (that provides a way to parse arguments passed from the shell command line). To use this system, ASDF must be configured to find installed copies of these systems; it will load them before it tries to compile and - load 'hello-lisp'. + load ‘hello-lisp’. - * This system also defines a bunch of metadata. While it is optional - to define these fields (and other fields like ':bug-tracker', - ':mailto', ':long-name', ':long-description', ':source-control'), - it is strongly recommended to define the fields ':description', - ':version', ':author', and ':licence', especially if you intend + • This system also defines a bunch of metadata. While it is optional + to define these fields (and other fields like ‘:bug-tracker’, + ‘:mailto’, ‘:long-name’, ‘:long-description’, ‘:source-control’), + it is strongly recommended to define the fields ‘:description’, + ‘:version’, ‘:author’, and ‘:licence’, especially if you intend your software to be eventually included in Quicklisp. - * Make sure you know how the ':version' numbers will be parsed! Only + • Make sure you know how the ‘:version’ numbers will be parsed! Only period-separated non-negative integers are accepted at present. - See below Version specifiers in *note The defsystem grammar::. + *Note Version specifiers::. - * This file contains a single form, the 'defsystem' declaration. No - 'in-package' form, no 'asdf:' package prefix, no nothing. Just the - one naked 'defsystem' form. This is what we recommend. More + • This file contains a single form, the ‘defsystem’ declaration. No + ‘in-package’ form, no ‘asdf:’ package prefix, no nothing. Just the + one naked ‘defsystem’ form. This is what we recommend. More complex system definition files are possible with arbitrary Lisp code, but we recommend that you keep it simple if you can. This will make your system definitions more robust and more @@ -995,7 +995,7 @@ ordered to operate on the system named '"hello-lisp"'). This is all you need to know to define simple systems. The next example is much more involved, to give you a glimpse of how you can do -more complex things. However, since it's ultimately arbitrary Lisp +more complex things. However, since it’s ultimately arbitrary Lisp code, there is no bottom to the rabbit hole. @@ -1004,7 +1004,7 @@ File: asdf.info, Node: A more involved example, Next: The defsystem grammar, 6.2 A more involved example =========================== -Let's illustrate some more involved uses of 'defsystem' via a slightly +Let’s illustrate some more involved uses of ‘defsystem’ via a slightly convoluted example: (in-package :asdf-user) @@ -1034,31 +1034,31 @@ convoluted example: Here are some notes about this example: - * The main thing this file does is define a system 'foo'. It also - contains other Lisp forms, which we'll examine below. + • The main thing this file does is define a system ‘foo’. It also + contains other Lisp forms, which we’ll examine below. - * Besides Lisp source files, this system contains a ':module' - component named '"mod"', which is a collection of three Lisp source - files 'utils.lisp', 'reader.lisp', 'cooker.lisp' and 'data.raw' + • Besides Lisp source files, this system contains a ‘:module’ + component named ‘"mod"’, which is a collection of three Lisp source + files ‘utils.lisp’, ‘reader.lisp’, ‘cooker.lisp’ and ‘data.raw’ - * Note that the ':static-file' does not have an implicit file type, + • Note that the ‘:static-file’ does not have an implicit file type, unlike the Lisp source files. - * This files will be located in a subdirectory of the main code - directory named 'mod/' (this location could have been overridden to + • This files will be located in a subdirectory of the main code + directory named ‘mod/’ (this location could have been overridden to be in the same directory, or in a different subdirectory; see the - discussion of the ':pathname' option in *note The defsystem + discussion of the ‘:pathname’ option in *note The defsystem grammar::). - * The ':serial t' says that each sub-component of 'mod' depends on - the previous components, so that 'cooker.lisp' depends-on - 'utils.lisp', which depends-on 'reader.lisp'. Also 'data.raw' - depends on all of them, but that doesn't matter since it's a static + • The ‘:serial t’ says that each sub-component of ‘mod’ depends on + the previous components, so that ‘cooker.lisp’ depends-on + ‘reader.lisp’, which depends-on ‘utils.lisp’. Also ‘data.raw’ + depends on all of them, but that doesn’t matter since it’s a static file; on the other hand, if it appeared first, then all the Lisp files would be recompiled when the data is modified, which is probably not what is desired in this case. - * The method-form tokens provide a shorthand for defining methods on + • The method-form tokens provide a shorthand for defining methods on particular components. This part :output-files (compile-op (o c) (list "data.cooked")) @@ -1076,7 +1076,7 @@ convoluted example: :in (component-pathname (find-component c "data.raw")) :out (first (output-files o c)))) - where '...' is the component in question. In this case '...' would + where ‘...’ is the component in question. In this case ‘...’ would expand to something like (find-component "foo" "mod") @@ -1085,82 +1085,82 @@ convoluted example: grammar::. For more details on what these methods do, *note Operations:: in *note The object model of ASDF::. - * There is an additional 'defmethod' with a similar effect, because + • There is an additional ‘defmethod’ with a similar effect, because ASDF (as of ASDF 3.1.5) fails to accept inline-methods as above for - 'action-description', instead only supporting the deprecated - 'explain' interface. + ‘action-description’, instead only supporting the deprecated + ‘explain’ interface. - * In this case, these methods describe how this module defines code + • In this case, these methods describe how this module defines code that it then uses to cook some data. - * Importantly, ASDF is told about the input and output files used by + • Importantly, ASDF is told about the input and output files used by the data cooker, and to make sure everyone agrees, the cooking function explicitly uses ASDF to access pathnames to the input and output data. - * The file starts with a form '(in-package :asdf-user)', but it is + • The file starts with a form ‘(in-package :asdf-user)’, but it is actually redundant, not necessary and not recommended. But yet more complex cases (also not recommended) may usefully use an - 'in-package' form. + ‘in-package’ form. - * Indeed, ASDF does not load '.asd' files simply with 'cl:load', and + • Indeed, ASDF does not load ‘.asd’ files simply with ‘cl:load’, and neither should you. You should let ASDF find and load them when - you operate on systems. If you somehow _must_ load a '.asd' file, - use the same function 'asdf:load-asd' that ASDF uses. Among other - things, it already binds the '*package*' to 'asdf-user'. Recent - versions of SLIME (2013-02 and later) know to do that when you 'C-c - C-k' when you use the 'slime-asdf' contrib. - - * You shouldn't use an 'in-package' form if you're keeping things - simple. You should only use 'in-package' (and before it, a - 'defpackage') when you're going to define new classes, functions, - variables, macros, etc., in the '.asd' file, and want to thereby + you operate on systems. If you somehow _must_ load a ‘.asd’ file, + use the same function ‘asdf:load-asd’ that ASDF uses. Among other + things, it already binds the ‘*package*’ to ‘asdf-user’. Recent + versions of SLIME (2013-02 and later) know to do that when you ‘C-c + C-k’ when you use the ‘slime-asdf’ contrib. + + • You shouldn’t use an ‘in-package’ form if you’re keeping things + simple. You should only use ‘in-package’ (and before it, a + ‘defpackage’) when you’re going to define new classes, functions, + variables, macros, etc., in the ‘.asd’ file, and want to thereby avoid name clashes. Manuals for old versions of ASDF recommended - use of such an idiom in '.asd' files, but as of ASDF 3, we - recommend that you don't do that anymore, and instead define any + use of such an idiom in ‘.asd’ files, but as of ASDF 3, we + recommend that you don’t do that anymore, and instead define any ASDF extensions in their own system, on which you can then declare - a dependency using ':defsystem-depends-on'. *Note The defsystem + a dependency using ‘:defsystem-depends-on’. *Note The defsystem grammar::. - * More generally, you can always rely on symbols from packages - 'asdf', 'common-lisp' and 'uiop' being available in '.asd' files -- - most importantly including 'defsystem'. It is therefore redundant - and in bad taste to use a package-prefixed 'asdf:defsystem' symbol - in a '.asd' file. Just use '(defsystem ...)'. Only package-prefix + • More generally, you can always rely on symbols from packages + ‘asdf’, ‘common-lisp’ and ‘uiop’ being available in ‘.asd’ files — + most importantly including ‘defsystem’. It is therefore redundant + and in bad taste to use a package-prefixed ‘asdf:defsystem’ symbol + in a ‘.asd’ file. Just use ‘(defsystem ...)’. Only package-prefix it when somehow dynamically generating system definitions from a - package that doesn't already use the ASDF package. + package that doesn’t already use the ASDF package. - * 'asdf-user' is actually only available starting since ASDF 3, but + • ‘asdf-user’ is actually only available starting since ASDF 3, but then again, ASDF 1 and 2 did crazy things with packages that ASDF 3 has stopped doing(1), and since all implementations provide ASDF 3, - you shouldn't care about compatibility with ASDF 2. We do not + you shouldn’t care about compatibility with ASDF 2. We do not support ASDF 2 anymore, and we recommend that neither should you. - * Starting with ASDF 3.1, 'asdf-user' uses 'uiop', whereas in earlier - variants of ASDF 3 it only used 'uiop/package'. We recommend you + • Starting with ASDF 3.1, ‘asdf-user’ uses ‘uiop’, whereas in earlier + variants of ASDF 3 it only used ‘uiop/package’. We recommend you either prefix use of UIOP functions with the package prefix - 'uiop:', or make sure your system ':depends-on ((:version "asdf" - "3.1.2"))' or has a '#-asdf3.1 (error "MY-SYSTEM requires ASDF - 3.1.2")'. + ‘uiop:’, or make sure your system ‘:depends-on ((:version "asdf" + "3.1.2"))’ or has a ‘#-asdf3.1 (error "MY-SYSTEM requires ASDF + 3.1.2")’. - * Finally, we elided most metadata, but showed how you can have ASDF - automatically extract the system's version from a source file. In + • Finally, we elided most metadata, but showed how you can have ASDF + automatically extract the system’s version from a source file. In this case, the 3rd subform of the 4th form (note that Lisp uses 0-based indexing, English uses 1-based indexing). Presumably, the - 4th form looks like '(defparameter *foo-version* "5.6.7")'. + 4th form looks like ‘(defparameter *foo-version* "5.6.7")’. ---------- Footnotes ---------- (1) ASDF 1 and 2 (up until 2.26) used to dynamically create and -delete temporary packages 'asdf_N_', one for each '.asd' file, in a +delete temporary packages ‘asdf_N_’, one for each ‘.asd’ file, in a misguided attempt to thereby reduce name clashes; but it failed at that goal and only made things more complex. ASDF 3 just uses a shared -package 'asdf-user' instead, and relies on the usual Common Lisp +package ‘asdf-user’ instead, and relies on the usual Common Lisp conventions to avoid clashes. As far as package oddities go, you may -just notice that the 'asdf-user' package also uses 'uiop/common-lisp', a -variant of the 'common-lisp' package that papers over deficiencies in +just notice that the ‘asdf-user’ package also uses ‘uiop/common-lisp’, a +variant of the ‘common-lisp’ package that papers over deficiencies in more obscure Common Lisp implementations; but unless you care about -Corman Lisp, GCL, Genera or MCL, you shouldn't be concerned. +Corman Lisp, GCL, Genera or MCL, you shouldn’t be concerned. File: asdf.info, Node: The defsystem grammar, Next: Other code in .asd files, Prev: A more involved example, Up: Defining systems with defsystem @@ -1168,11 +1168,19 @@ File: asdf.info, Node: The defsystem grammar, Next: Other code in .asd files, 6.3 The defsystem grammar ========================= - system-definition := ( defsystem system-designator SYSTEM-OPTION* ) + system-definition := ( defsystem system-designator SYSTEM-OPTION*) + + system-designator := simple-component-name | complex-component-name + + simple-component-name := lower-case string | symbol + NOTE: Underscores are not permitted. See below. + + complex-component-name := string | symbol + See below. system-option := :defsystem-depends-on system-list | :weakly-depends-on SYSTEM-LIST - | :class class-name (see discussion below) + | :class class-name # *note System class names:: | :build-operation OPERATION-NAME | system-option | module-option @@ -1185,6 +1193,7 @@ File: asdf.info, Node: The defsystem grammar, Next: Other code in .asd files, | :long-name string | :source-control source-control | :version version-specifier + | :entry-point object # *note Entry point:: source-control := (keyword string) @@ -1212,13 +1221,13 @@ File: asdf.info, Node: The defsystem grammar, Next: Other code in .asd files, component-type := :module | :file | :static-file | other-component-type other-component-type := symbol-by-name - (*note Component types: The defsystem grammar.) + # *note Component types:: # This is used in :depends-on, as opposed to ``dependency,'' # which is used in :in-order-to dependency-def := simple-component-name | ( :feature FEATURE-EXPRESSION dependency-def ) - # (*note Feature dependencies: The defsystem grammar.) + # *note Feature dependencies:: | ( :version simple-component-name version-specifier ) | ( :require module-name ) @@ -1233,6 +1242,10 @@ File: asdf.info, Node: The defsystem grammar, Next: Other code in .asd files, | symbol pathname-specifier := pathname | string | symbol + NOTE: pathnames should be all lower case, and have no + underscores, although hyphens are permitted. + + version-specifier := string | (:read-file-form <pathname-specifier> <form-specifier>?) @@ -1241,71 +1254,114 @@ File: asdf.info, Node: The defsystem grammar, Next: Other code in .asd files, form-specifier := :at [ integer | ( integer+ )] method-form := (operation-name qual lambda-list &rest body) - qual := method qualifier? + qual := method-qualifier? + method-qualifier = :before | :after | :around feature-expression := keyword | (:and FEATURE-EXPRESSION*) | (:or FEATURE-EXPRESSION*) | (:not FEATURE-EXPRESSION) -6.3.1 Component names ---------------------- +6.3.1 System designators +------------------------ + +System designators are either simple component names, or complex +(“slashyâ€) component names. + +6.3.2 Simple component names (‘simple-component-name’) +------------------------------------------------------ + +Simple component names may be written as either strings or symbols. + + When using strings, use lower case exclusively. + + Symbols will be interpreted as convenient shorthand for the string +that is their ‘symbol-name’, converted to lower case. Put differently, +a symbol may be a simple component name _designator_, but the simple +component name itself is the string. + + *Never* use underscores in component names, whether written as +strings or symbols. + + *Never* use slashes (“/â€) in simple component names. A slash +indicates a _complex_ component name; see below. Using a slash +improperly will cause ASDF to issue a warning. -Component names ('simple-component-name') may be either strings or -symbols. + Violating these constraints by mixing case, or including underscores +in component names, may lead to systems or components being impossible +to find, because component names are interpreted as file names. These +problems will _definitely_ occur for users who have configured ASDF +using logical pathnames. -6.3.2 Component types +6.3.3 Complex component names +----------------------------- + +A complex component name is a master name followed by a slash, followed +by a subsidiary name. This allows programmers to put multiple system +definitions in a single ‘.asd’ file, while still allowing ASDF to find +these systems. + + The master name of a complex system *must* be the same as the name of +the ‘.asd’ file. + + The file ‘foo.asd’ will contain the definition of the system ‘"foo"’. +However, it may _also_ contain definitions of subsidiary systems, such +as ‘"foo/test"’, ‘"foo/docs"’, and so forth. ASDF will “know†that if +you ask it to load system ‘"foo/test"’ it should look for that system’s +definition in ‘foo.asd’. + +6.3.4 Component types --------------------- Component type names, even if expressed as keywords, will be looked up by name in the current package and in the asdf package, if not found in -the current package. So a component type 'my-component-type', in the -current package 'my-system-asd' can be specified as -':my-component-type', or 'my-component-type'. +the current package. So a component type ‘my-component-type’, in the +current package ‘my-system-asd’ can be specified as +‘:my-component-type’, or ‘my-component-type’. - 'system' and its subclasses are _not_ allowed as component types for + ‘system’ and its subclasses are _not_ allowed as component types for such children components. -6.3.3 System class names +6.3.5 System class names ------------------------ A system class name will be looked up in the same way as a Component -type (see above), except that only 'system' and its subclasses are +type (see above), except that only ‘system’ and its subclasses are allowed. Typically, one will not need to specify a system class name, unless using a non-standard system class defined in some ASDF extension, -typically loaded through 'DEFSYSTEM-DEPENDS-ON', see below. For such -class names in the ASDF package, we recommend that the ':class' option +typically loaded through ‘DEFSYSTEM-DEPENDS-ON’, see below. For such +class names in the ASDF package, we recommend that the ‘:class’ option be specified using a keyword symbol, such as :class :MY-NEW-SYSTEM-SUBCLASS This practice will ensure that package name conflicts are avoided. -Otherwise, the symbol 'MY-NEW-SYSTEM-SUBCLASS' will be read into the +Otherwise, the symbol ‘MY-NEW-SYSTEM-SUBCLASS’ will be read into the current package _before_ it has been exported from the ASDF extension -loaded by ':defsystem-depends-on', causing a name conflict in the +loaded by ‘:defsystem-depends-on’, causing a name conflict in the current package. -6.3.4 Defsystem depends on +6.3.6 Defsystem depends on -------------------------- -The ':defsystem-depends-on' option to 'defsystem' allows the programmer +The ‘:defsystem-depends-on’ option to ‘defsystem’ allows the programmer to specify another ASDF-defined system or set of systems that must be loaded _before_ the system definition is processed. Typically this is used to load an ASDF extension that is used in the system definition. -6.3.5 Build-operation +6.3.7 Build-operation --------------------- -The ':build-operation' option to 'defsystem' allows the programmer to -specify an operation that will be applied, in place of 'load-op' when -'make' (*note make: Convenience Functions.) is run on the system. The +The ‘:build-operation’ option to ‘defsystem’ allows the programmer to +specify an operation that will be applied, in place of ‘load-op’ when +‘make’ (*note make: Convenience Functions.) is run on the system. The option value should be the name of an operation. E.g., -':build-operation doc-op' +‘:build-operation doc-op’ This feature is experimental and largely untested. Use at your own risk. -6.3.6 Weakly depends on +6.3.8 Weakly depends on ----------------------- We do _NOT_ recommend you use this feature. If you are tempted to write @@ -1314,7 +1370,7 @@ should instead write system FOO in a parametric way, and offer some special variable and/or some hook to specialize its behaviour; then you should write a system FOO+BAR that does the hooking of things together. - The (deprecated) ':weakly-depends-on' option to 'defsystem' allows + The (deprecated) ‘:weakly-depends-on’ option to ‘defsystem’ allows the programmer to specify another ASDF-defined system or set of systems that ASDF should _try_ to load, but need not load in order to be successful. Typically this is used if there are a number of systems @@ -1322,68 +1378,70 @@ that, if present, could provide additional functionality, but which are not necessary for basic function. Currently, although it is specified to be an option only to -'defsystem', this option is accepted at any component, but it probably -only makes sense at the 'defsystem' level. Programmers are cautioned -not to use this component option except at the 'defsystem' level, as +‘defsystem’, this option is accepted at any component, but it probably +only makes sense at the ‘defsystem’ level. Programmers are cautioned +not to use this component option except at the ‘defsystem’ level, as this anomalous behaviour may be removed without warning. -6.3.7 Pathname specifiers +6.3.9 Pathname specifiers ------------------------- -A pathname specifier ('pathname-specifier') may be a pathname, a string +A pathname specifier (‘pathname-specifier’) may be a pathname, a string or a symbol. When no pathname specifier is given for a component, which is the usual case, the component name itself is used. If a string is given, which is the usual case, the string will be -interpreted as a Unix-style pathname where '/' characters will be +interpreted as a Unix-style pathname where ‘/’ characters will be interpreted as directory separators. Usually, Unix-style relative -pathnames are used (i.e. not starting with '/', as opposed to absolute +pathnames are used (i.e. not starting with ‘/’, as opposed to absolute pathnames); they are relative to the path of the parent component. -Finally, depending on the 'component-type', the pathname may be -interpreted as either a file or a directory, and if it's a file, a file -type may be added corresponding to the 'component-type', or else it will +Finally, depending on the ‘component-type’, the pathname may be +interpreted as either a file or a directory, and if it’s a file, a file +type may be added corresponding to the ‘component-type’, or else it will be extracted from the string itself (if applicable). - For instance, the 'component-type' ':module' wants a directory -pathname, and so a string '"foo/bar"' will be interpreted as the -pathname '#p"foo/bar/"'. On the other hand, the 'component-type' -':file' wants a file of type 'lisp', and so a string '"foo/bar"' will be -interpreted as the pathname '#p"foo/bar.lisp"', and a string -'"foo/bar.quux"' will be interpreted as the pathname -'#p"foo/bar.quux.lisp"'. Finally, the 'component-type' ':static-file' -wants a file without specifying a type, and so a string '"foo/bar"' will -be interpreted as the pathname '#p"foo/bar"', and a string -'"foo/bar.quux"' will be interpreted as the pathname '#p"foo/bar.quux"'. - - ASDF interprets the string '".."' as the pathname directory component -word ':back', which when merged, goes back one level in the directory + For instance, the ‘component-type’ ‘:module’ wants a directory +pathname, and so a string ‘"foo/bar"’ will be interpreted as the +pathname ‘#p"foo/bar/"’. On the other hand, the ‘component-type’ +‘:file’ wants a file of type ‘lisp’, and so a string ‘"foo/bar"’ will be +interpreted as the pathname ‘#p"foo/bar.lisp"’, and a string +‘"foo/bar.quux"’ will be interpreted as the pathname +‘#p"foo/bar.quux.lisp"’. Finally, the ‘component-type’ ‘:static-file’ +wants a file without specifying a type, and so a string ‘"foo/bar"’ will +be interpreted as the pathname ‘#p"foo/bar"’, and a string +‘"foo/bar.quux"’ will be interpreted as the pathname ‘#p"foo/bar.quux"’. + + ASDF interprets the string ‘".."’ as the pathname directory component +word ‘:back’, which when merged, goes back one level in the directory hierarchy. If a symbol is given, it will be translated into a string, and downcased in the process. The downcasing of symbols is unconventional, -but was selected after some consideration. Observations suggest that -the type of systems we want to support either have lowercase as -customary case (Unix, Mac, windows) or silently convert lowercase to -uppercase (lpns), so this makes more sense than attempting to use ':case -:common' as argument to 'make-pathname', which is reported not to work -on some implementations. +but was selected after some consideration. The file systems we support +either have lowercase as customary case (Unix, Mac, Windows) or silently +convert lowercase to uppercase (lpns), so this makes more sense than +attempting to use ‘:case :common’ as argument to ‘make-pathname’, which +is reported not to work on some implementations. + + Please avoid using underscores in system names, or component (module +or file) names, since underscores are not compatible with logical +pathnames (*note Using logical pathnames::). Pathname objects may be given to override the path for a component. -Such objects are typically specified using reader macros such as '#p' or -'#.(make-pathname ...)'. Note however, that '#p...' is a shorthand for -'#.(parse-namestring ...)' and that the behaviour of 'parse-namestring' +Such objects are typically specified using reader macros such as ‘#p’ or +‘#.(make-pathname ...)’. Note however, that ‘#p...’ is a shorthand for +‘#.(parse-namestring ...)’ and that the behaviour of ‘parse-namestring’ is completely non-portable, unless you are using Common Lisp -'logical-pathname's, which themselves involve other non-portable -behaviour (*note Using logical pathnames: The defsystem grammar, below). -Pathnames made with '#.(make-pathname ...)' can usually be done more -easily with the string syntax above. The only case that you really need -a pathname object is to override the component-type default file type -for a given component. Therefore, pathname objects should only rarely -be used. Unhappily, ASDF 1 used not to properly support parsing -component names as strings specifying paths with directories, and the -cumbersome '#.(make-pathname ...)' syntax had to be used. An -alternative to '#.' read-time evaluation is to use '(eval `(defsystem -... ,pathname ...))'. +‘logical-pathname’s, which themselves involve other non-portable +behaviour (*note Using logical pathnames::). Pathnames made with +‘#.(make-pathname ...)’ can usually be done more easily with the string +syntax above. The only case that you really need a pathname object is +to override the component-type default file type for a given component. +Therefore, pathname objects should only rarely be used. Unhappily, ASDF +1 used not to properly support parsing component names as strings +specifying paths with directories, and the cumbersome ‘#.(make-pathname +...)’ syntax had to be used. An alternative to ‘#.’ read-time +evaluation is to use ‘(eval `(defsystem ... ,pathname ...))’. Note that when specifying pathname objects, ASDF does not do any special interpretation of the pathname influenced by the component type, @@ -1394,31 +1452,31 @@ a directory or a file with appropriate type); on the other hand, you can circumvent the file type that would otherwise be forced upon you if you were specifying a string. -6.3.8 Version specifiers ------------------------- +6.3.10 Version specifiers +------------------------- Version specifiers are strings to be parsed as period-separated lists of -integers. I.e., in the example, '"0.2.1"' is to be interpreted, roughly -speaking, as '(0 2 1)'. In particular, version '"0.2.1"' is interpreted -the same as '"0.0002.1"', though the latter is not canonical and may -lead to a warning being issued. Also, '"1.3"' and '"1.4"' are both -strictly 'uiop:version<' to '"1.30"', quite unlike what would have +integers. I.e., in the example, ‘"0.2.1"’ is to be interpreted, roughly +speaking, as ‘(0 2 1)’. In particular, version ‘"0.2.1"’ is interpreted +the same as ‘"0.0002.1"’, though the latter is not canonical and may +lead to a warning being issued. Also, ‘"1.3"’ and ‘"1.4"’ are both +strictly ‘uiop:version<’ to ‘"1.30"’, quite unlike what would have happened had the version strings been interpreted as decimal fractions. - Instead of a string representing the version, the ':version' argument + Instead of a string representing the version, the ‘:version’ argument can be an expression that is resolved to such a string using the following trivial domain-specific language: in addition to being a -literal string, it can be an expression of the form '(:read-file-form -<pathname-or-string> [:at <access-at-specifier]>)', or '(:read-file-line -<pathname-or-string> [:at <access-at-specifier]?>)'. As the name +literal string, it can be an expression of the form ‘(:read-file-form +<pathname-or-string> [:at <access-at-specifier>])’, or ‘(:read-file-line +<pathname-or-string> [:at <access-at-specifier>])’. As the name suggests, the former will be resolved by reading a form in the specified pathname (read as a subpathname of the current system if relative or a unix-namestring), and the latter by reading a line. You may use a -'uiop:access-at' specifier with the ':at' keyword, by default the -specifier is '0', meaning the first form/line is returned. For -':read-file-form', subforms can also be specified, with e.g. '(1 2 2)' -specifying "the third subform (index 2) of the third subform (index 2) -of the second form (index 1)" in the file (mind the off-by-one error in +‘uiop:access-at’ specifier with the ‘:at’ keyword, by default the +specifier is ‘0’, meaning the first form/line is returned. For +‘:read-file-form’, subforms can also be specified, with e.g. ‘(1 2 2)’ +specifying “the third subform (index 2) of the third subform (index 2) +of the second form (index 1)†in the file (mind the off-by-one error in the English language). System definers are encouraged to use version identifiers of the form @@ -1428,36 +1486,35 @@ number. *Note Common attributes of components::. -6.3.9 Require -------------- +6.3.11 Require +-------------- -Use the implementation's own 'require' to load the MODULE-NAME. +Use the implementation’s own ‘require’ to load the MODULE-NAME. - It is good taste to use ':if-feature _:implementation-name_' rather -than '#+_implementation-name_' to only depend on the specified module on -the specific implementation that provides it. *Note -if-feature-option::. + It is good taste to use ‘(:feature _:implementation-name_ (:require +MODULE-NAME))’ rather than ‘#+_implementation-name_ (:require +MODULE-NAME)’ to only depend on the specified module on the specific +implementation that provides it. *Note Feature dependencies::. -6.3.10 Feature dependencies +6.3.12 Feature dependencies --------------------------- -A feature dependency is of the form '(:feature FEATURE-EXPRESSION -DEPENDENCY)' If the FEATURE-EXPRESSION is satisfied by the running lisp +A feature dependency is of the form ‘(:feature FEATURE-EXPRESSION +DEPENDENCY)’ If the FEATURE-EXPRESSION is satisfied by the running lisp at the time the system definition is parsed, then the DEPENDENCY will be -added to the system's dependencies. If the FEATURE-EXPRESSION is _not_ +added to the system’s dependencies. If the FEATURE-EXPRESSION is _not_ satisfied, then the feature dependency form is ignored. - Note that this means that ':feature' *cannot* be used to enforce a + Note that this means that ‘:feature’ *cannot* be used to enforce a feature dependency for the system in question. I.e., it cannot be used to require that a feature hold in order for the system definition to be -loaded. E.g., one cannot use '(:feature :sbcl)' to require that a +loaded. E.g., one cannot use ‘(:feature :sbcl)’ to require that a system only be used on SBCL. Feature dependencies are not to be confused with the obsolete feature -requirement (*note feature requirement: The defsystem grammar.), or with -'if-feature'. +requirement (*note feature requirement::), or with ‘if-feature’. -6.3.11 Using logical pathnames +6.3.13 Using logical pathnames ------------------------------ We do not generally recommend the use of logical pathnames, especially @@ -1465,17 +1522,17 @@ not so to newcomers to Common Lisp. However, we do support the use of logical pathnames by old timers, when such is their preference. To use logical pathnames, you will have to provide a pathname object -as a ':pathname' specifier to components that use it, using such syntax -as '#p"LOGICAL-HOST:absolute;path;to;component.lisp"'. +as a ‘:pathname’ specifier to components that use it, using such syntax +as ‘#p"LOGICAL-HOST:absolute;path;to;component.lisp"’. You only have to specify such logical pathname for your system or -some top-level component. Sub-components' relative pathnames, specified +some top-level component. Sub-components’ relative pathnames, specified using the string syntax for names, will be properly merged with the pathnames of their parents. The specification of a logical pathname host however is _not_ otherwise directly supported in the ASDF syntax for pathname specifiers as strings. - The 'asdf-output-translation' layer will avoid trying to resolve and + The ‘asdf-output-translation’ layer will avoid trying to resolve and translate logical pathnames. The advantage of this is that you can define yourself what translations you want to use with the logical pathname facility. The disadvantage is that if you do not define such @@ -1493,7 +1550,7 @@ single character case, digits and hyphens. While you can solve the first issue on your own, describing how to do it on each of fifteen implementations supported by ASDF is more than we can document. As for the second issue, mind that the limitation is notably enforced on SBCL, -and that you therefore can't portably violate the limitations but must +and that you therefore can’t portably violate the limitations but must instead define some encoding of your own and add individual mappings to name physical pathnames that do not fit the restrictions. This can notably be a problem when your Lisp files are part of a larger project @@ -1503,12 +1560,12 @@ are shared with software written in different programming languages where conventions include the use of underscores, dots or CamelCase in pathnames. -6.3.12 Serial dependencies +6.3.14 Serial dependencies -------------------------- -If the ':serial t' option is specified for a module, ASDF will add +If the ‘:serial t’ option is specified for a module, ASDF will add dependencies for each child component, on all the children textually -preceding it. This is done as if by ':depends-on'. +preceding it. This is done as if by ‘:depends-on’. :serial t :components ((:file "a") (:file "b") (:file "c")) @@ -1519,78 +1576,93 @@ preceding it. This is done as if by ':depends-on'. (:file "b" :depends-on ("a")) (:file "c" :depends-on ("a" "b"))) -6.3.13 Source location (':pathname') +6.3.15 Source location (‘:pathname’) ------------------------------------ -The ':pathname' option is optional in all cases for systems defined via -'defsystem', and generally is unnecessary. In the simple case, source +The ‘:pathname’ option is optional in all cases for systems defined via +‘defsystem’, and generally is unnecessary. In the simple case, source files will be found in the same directory as the system or, in the case of modules, in a subdirectory with the same name as the module. More specifically, ASDF follows a hairy set of rules that are designed so that - 1. 'find-system' will load a system from disk and have its pathname + 1. ‘find-system’ will load a system from disk and have its pathname default to the right place. 2. This pathname information will not be overwritten with - '*default-pathname-defaults*' (which could be somewhere else - altogether) if the user loads up the '.asd' file into his editor + ‘*default-pathname-defaults*’ (which could be somewhere else + altogether) if the user loads up the ‘.asd’ file into his editor and interactively re-evaluates that form. If a system is being loaded for the first time, its top-level pathname will be set to: - * The host/device/directory parts of '*load-truename*', if it is + • The host/device/directory parts of ‘*load-truename*’, if it is bound. - * '*default-pathname-defaults*', otherwise. + • ‘*default-pathname-defaults*’, otherwise. If a system is being redefined, the top-level pathname will be - * changed, if explicitly supplied or obtained from '*load-truename*' + • changed, if explicitly supplied or obtained from ‘*load-truename*’ (so that an updated source location is reflected in the system definition) - * changed if it had previously been set from - '*default-pathname-defaults*' + • changed if it had previously been set from + ‘*default-pathname-defaults*’ - * left as before, if it had previously been set from - '*load-truename*' and '*load-truename*' is currently unbound (so - that a developer can evaluate a 'defsystem' form from within an + • left as before, if it had previously been set from + ‘*load-truename*’ and ‘*load-truename*’ is currently unbound (so + that a developer can evaluate a ‘defsystem’ form from within an editor without clobbering its source location) -6.3.14 if-feature option +6.3.16 if-feature option ------------------------ This option allows you to specify a feature expression to be evaluated -as if by '#+' to conditionally include a component in your build. If +as if by ‘#+’ to conditionally include a component in your build. If the expression is false, the component is dropped as well as any -dependency pointing to it. As compared to using '#+' which is expanded +dependency pointing to it. As compared to using ‘#+’ which is expanded at read-time, this allows you to have an object in your component hierarchy that can be used for manipulations beside building your project, and that is accessible to outside code that wishes to reason about system structure. - Programmers should be careful to consider *when* the ':if-feature' is + Programmers should be careful to consider *when* the ‘:if-feature’ is evaluated. Recall that ASDF first computes a build plan, and then executes that plan. ASDF will check to see whether or not a feature is present *at planning time*, not during the build. It follows that one -cannot use ':if-feature' to check features that are set during the +cannot use ‘:if-feature’ to check features that are set during the course of the build. It can only be used to check the state of features before any build operations have been performed. This option was added in ASDF 3. For more information, *Note Required features: required-features. -6.3.15 feature requirement +6.3.17 Entry point +------------------ + +The ‘:entry-point’ option allows a developer to specify the entry point +of an executable program created by ‘program-op’. + + When ‘program-op’ is invoked, the form passed to this option is +converted to a function by ‘uiop:ensure-function’ and bound to +‘uiop:*image-entry-point*’. Typically one will specify a string, e.g. +‘"foo:main"’, so that the executable starts with the ‘foo:main’ +function. Note that using the symbol ‘foo:main’ instead might not work +because the ‘foo’ package doesn’t necessarily exist when ASDF reads the +‘defsystem’ form. For more information on ‘program-op’, *note +Predefined operations of ASDF::. + +6.3.18 feature requirement -------------------------- This requirement was removed in ASDF 3.1. Please do not use it. In -most cases, ':if-feature' (*note if-feature-option::) will provide an +most cases, ‘:if-feature’ (*note if-feature option::) will provide an adequate substitute. - The 'feature' requirement used to ensure that a chain of component + The ‘feature’ requirement used to ensure that a chain of component dependencies would fail when a key feature was absent. Used in -conjunction with ':if-component-dep-fails' this provided a roundabout +conjunction with ‘:if-component-dep-fails’ this provided a roundabout way to express conditional compilation. @@ -1599,21 +1671,21 @@ File: asdf.info, Node: Other code in .asd files, Next: The package-inferred-sy 6.4 Other code in .asd files ============================ -Files containing 'defsystem' forms are regular Lisp files that are -executed by 'load'. Consequently, you can put whatever Lisp code you +Files containing ‘defsystem’ forms are regular Lisp files that are +executed by ‘load’. Consequently, you can put whatever Lisp code you like into these files. However, it is recommended to keep such forms to -a minimal, and to instead define 'defsystem' extensions that you use -with ':defsystem-depends-on'. +a minimal, and to instead define ‘defsystem’ extensions that you use +with ‘:defsystem-depends-on’. - If however, you might insist on including code in the '.asd' file + If however, you might insist on including code in the ‘.asd’ file itself, e.g., to examine and adjust the compile-time environment, -possibly adding appropriate features to '*features*'. If so, here are +possibly adding appropriate features to ‘*features*’. If so, here are some conventions we recommend you follow, so that users can control -certain details of execution of the Lisp in '.asd' files: +certain details of execution of the Lisp in ‘.asd’ files: - * Any informative output (other than warnings and errors, which are - the condition system's to dispose of) should be sent to the - standard CL stream '*standard-output*', so that users can easily + • Any informative output (other than warnings and errors, which are + the condition system’s to dispose of) should be sent to the + standard CL stream ‘*standard-output*’, so that users can easily control the disposition of output from ASDF operations. @@ -1623,33 +1695,35 @@ File: asdf.info, Node: The package-inferred-system extension, Prev: Other code ========================================= Starting with release 3.1.2, ASDF supports a one-package-per-file style -of programming, whereby each file is its own system, and dependencies -are deduced from the 'defpackage' form (or its variant -'uiop:define-package'). - - In this style, packages refer to a system with the same name -(downcased); and if a system is defined with ':class -package-inferred-system', then system names that start with that name -(using the slash '/' separator) refer to files under the filesystem -hierarchy where the system is defined. For instance, if system 'my-lib' -is defined in '/foo/bar/my-lib/my-lib.asd', then system -'my-lib/src/utility' will be found in file -'/foo/bar/my-lib/src/utility.lisp'. - - This style was made popular by 'faslpath' and 'quick-build' before, -and at the cost of a stricter package discipline, seems to make for more -maintainable code. It is used by ASDF itself (starting with ASDF 3), by -'lisp-interface-library', and a few other libraries. - - To use this style, choose a toplevel system name, e.g. 'my-lib', and -create a file 'my-lib.asd' with the ':class :package-inferred-system' -option in its 'defsystem'. For instance: - #-asdf3.1 (error "my-lib requires ASDF 3.1") +of programming, in which each file is its own system, and dependencies +are deduced from the ‘defpackage’ form or its variant, +‘uiop:define-package’. + + In this style of system definition, package names map to systems with +the same name (in lower case letters), and if a system is defined with +‘:class package-inferred-system’, then system names that start with that +name (using the slash ‘/’ separator) refer to files under the filesystem +hierarchy where the system is defined. For instance, if system ‘my-lib’ +is defined in ‘/foo/bar/my-lib/my-lib.asd’, then system +‘my-lib/src/utility’ will be found in file +‘/foo/bar/my-lib/src/utility.lisp’. + + One package per file style was made popular by ‘faslpath’ and +‘quick-build’, and at the cost of stricter package discipline, may yield +more maintainable code. This style is used in ASDF itself (starting +with ASDF 3), by ‘lisp-interface-library’, and a few other libraries. + + To use this style, choose a toplevel system name, e.g. ‘my-lib’, and +create a file ‘my-lib.asd’. Define ‘my-lib’ using the ‘:class +:package-inferred-system’ option in its ‘defsystem’. For instance: + ;; This example is based on lil.asd of LISP-INTERFACE-LIBRARY. + + #-asdf3.1 (error "MY-LIB requires ASDF 3.1 or later.") (defsystem "my-lib" :class :package-inferred-system :depends-on ("my-lib/interface/all" - "my-lib/src/all" - "my-lib/extras/all") + "my-lib/src/all" + "my-lib/extras/all") :in-order-to ((test-op (load-op "my-lib/test/all"))) :perform (test-op (o c) (symbol-call :my-lib/test/all :test-suite))) @@ -1661,40 +1735,71 @@ option in its 'defsystem'. For instance: (register-system-packages "closer-mop" - '(:c2mop :closer-common-lisp :c2cl :closer-common-lisp-user :c2cl-user)) - - In the code above, the first line checks that we are using ASDF 3.1, -which provides 'package-inferred-system'. - - The function 'register-system-packages' has to be called to register -packages used or provided by your system and its components where the -name of the system that provides the package is not the downcase of the -package name. - - Then, file 'interface/order.lisp' under the 'lil' hierarchy, that -defines abstract interfaces for order comparisons, starts with the -following form, dependencies being trivially computed from the ':use' -and ':mix' clauses: - - (uiop:define-package :lil/interface/order + '(:c2mop + :closer-common-lisp + :c2cl + :closer-common-lisp-user + :c2cl-user)) + +In the code above, the first form checks that we are using ASDF 3.1 or +later, which provides ‘package-inferred-system’. This is probably no +longer necessary, since none of the major lisp implementations provides +an older version of ASDF. + + The function ‘register-system-packages’ must be called to register +packages used or provided by your system when the name of the +system/file that provides the package is not the same as the package +name (converted to lower case). + + Each file under the ‘my-lib’ hierarchy will start with a package +definition. The form ‘uiop:define-package’ is supported as well as +‘defpackage’. ASDF will compute dependencies from the ‘:use’, ‘:mix’, +and other importation clauses of this package definition. Take the file +‘interface/order.lisp’ as an example: + + (uiop:define-package :my-lib/interface/order (:use :closer-common-lisp - :lil/interface/definition - :lil/interface/base - :lil/interface/eq :lil/interface/group) + :my-lib/interface/definition + :my-lib/interface/base) (:mix :fare-utils :uiop :alexandria) (:export ...)) - ASDF can tell that this file depends on system 'closer-mop' -(registered above), 'lil/interface/definition', 'lil/interface/base', -'lil/interface/eq', and 'lil/interface/group' (package and system names -match, and they will be looked up hierarchically). + ASDF can tell that this file/system depends on system ‘closer-mop’ +(registered above), ‘my-lib/interface/definition’, and +‘my-lib/interface/base’. + + How can ASDF find the file ‘interface/order.lisp’ from the toplevel +system ‘my-lib’, however? In the example above, ‘interface/all.lisp’ +(and other ‘all.lisp’) reexport all the symbols exported from the +packages at the same or lower levels of the hierarchy. This can be +easily done with ‘uiop:define-package’, which has many options that +prove useful in this context. For example: - ASDF also detects dependencies from ':import-from' clauses. You may -thus import a well-defined set of symbols from an existing package as -loaded from suitably named system; or if you prefer to use any such + (uiop:define-package :my-lib/interface/all + (:nicknames :my-lib-interface) + (:use :closer-common-lisp) + (:mix :fare-utils :uiop :alexandria) + (:use-reexport + :my-lib/interface/definition + :my-lib/interface/base + :my-lib/interface/order + :my-lib/interface/monad/continuation)) + + Thus the top level system need only depend on the ‘my-lib/.../all’ +systems because ASDF detects ‘interface/order.lisp’ and all other +dependencies from ‘all’ systems’ ‘:use-reexport’ clauses, which +effectively allow for “inheritance†of symbols being exported. + + ASDF also detects dependencies from ‘:import-from’ clauses. You may +thus import a well-defined set of symbols from an existing package, and +ASDF will know to load the system that provides that package. In the +following example, ASDF will infer that the current system depends on +‘foo/baz’ from the first ‘:import-from’. If you prefer to use any such symbol fully qualified by a package prefix, you may declare a dependency -on such a package and its corresponding system via an ':import-from' -clause with an empty list of symbols, as in: +on such a package and its corresponding system via an ‘:import-from’ +clause with an empty list of symbols. For example, if we preferred to +use the name ‘foo/quux:bletch‘, the second, empty, ‘:import-from’ form +would cause ASDF to load ‘foo/quux’. (defpackage :foo/bar (:use :cl) @@ -1702,15 +1807,10 @@ clause with an empty list of symbols, as in: (:import-from :foo/quux) (:export ...)) - The form 'uiop:define-package' is supported as well as 'defpackage', -and has many options that prove useful in this context, such as -':use-reexport' and ':mix-reexport' that allow for "inheritance" of -symbols being exported. - Note that starting with ASDF 3.1.5.6 only, ASDF will look for source -files under the 'component-pathname' as specified via the ':pathname' -option, whereas earlier versions ignore this option and use the -'system-source-directory' where the '.asd' file resides. +files under the ‘component-pathname’ (specified via the ‘:pathname’ +option), whereas earlier versions ignore this option and use the +‘system-source-directory’ where the ‘.asd’ file resides. File: asdf.info, Node: The object model of ASDF, Next: Controlling where ASDF searches for systems, Prev: Defining systems with defsystem, Up: Top @@ -1719,37 +1819,37 @@ File: asdf.info, Node: The object model of ASDF, Next: Controlling where ASDF ************************** ASDF is designed in an object-oriented way from the ground up. Both a -system's structure and the operations that can be performed on systems +system’s structure and the operations that can be performed on systems follow an extensible protocol, allowing programmers to add new -behaviours to ASDF. For example, 'cffi' adds support for special FFI +behaviours to ASDF. For example, ‘cffi’ adds support for special FFI description files that interface with C libraries and for wrapper files -that embed C code in Lisp. 'asdf-jar' supports creating Java JAR -archives in ABCL. 'poiu' supports compiling code in parallel using +that embed C code in Lisp. ‘asdf-jar’ supports creating Java JAR +archives in ABCL. ‘poiu’ supports compiling code in parallel using background processes. - The key classes in ASDF are 'component' and 'operation'. A -'component' represents an individual source file or a group of source + The key classes in ASDF are ‘component’ and ‘operation’. A +‘component’ represents an individual source file or a group of source files, and the products (e.g., fasl files) produced from it. An -'operation' represents a transformation that can be performed on a +‘operation’ represents a transformation that can be performed on a component, turning them from source files to intermediate results to final outputs. Components are related by _dependencies_, specified in system definitions. - When ordered to 'operate' with some operation on a component (usually + When ordered to ‘operate’ with some operation on a component (usually a system), ASDF will first compute a _plan_ by traversing the dependency -graph using function 'make-plan'.(1) The resulting plan object contains -an ordered list of _actions_. An action is a pair of an 'operation' and -a 'component', representing a particular build step to be 'perform'ed. +graph using function ‘make-plan’.(1) The resulting plan object contains +an ordered list of _actions_. An action is a pair of an ‘operation’ and +a ‘component’, representing a particular build step to be ‘perform’ed. The ordering of the plan ensures that no action is performed before all its dependencies have been fulfilled.(2) - In this chapter, we describe ASDF's object-oriented protocol, the + In this chapter, we describe ASDF’s object-oriented protocol, the classes that make it up, and the generic functions on those classes. These generic functions often take both an operation and a component as arguments: much of the power and configurability of ASDF is provided by -this use of CLOS's multiple dispatch. We will describe the built-in +this use of CLOS’s multiple dispatch. We will describe the built-in component and operation classes, and explain how to extend the ASDF -protocol by defining new classes and methods for ASDF's generic +protocol by defining new classes and methods for ASDF’s generic functions. We will also describe the many _hooks_ that can be configured to customize the behaviour of existing _functions_. @@ -1763,15 +1863,15 @@ configured to customize the behaviour of existing _functions_. ---------- Footnotes ---------- (1) Historically, the function that built a plan was called -'traverse', and returned a list of actions; it was deprecated in favor -of 'make-plan' (that returns a plan object) when the 'plan' objects were +‘traverse’, and returned a list of actions; it was deprecated in favor +of ‘make-plan’ (that returns a plan object) when the ‘plan’ objects were introduced with ASDF 3; the old function is kept for backward compatibility and debugging purposes only, and may be removed in the near future. - (2) The term _action_ was used by Kent Pitman in his article, "The -Description of Large Systems," (*note Bibliography::), and we suspect -might be traced to 'make'. Although the term was only used by ASDF + (2) The term _action_ was used by Kent Pitman in his article, “The +Description of Large Systems,†(*note Bibliography::), and we suspect +might be traced to ‘make’. Although the term was only used by ASDF hackers starting with ASDF 2, the concept was there since the very beginning of ASDF 1, just not clearly articulated. @@ -1781,22 +1881,22 @@ File: asdf.info, Node: Operations, Next: Components, Prev: The object model o 7.1 Operations ============== -An "operation" object of the appropriate type is instantiated whenever +An “operation†object of the appropriate type is instantiated whenever the user wants to do something with a system like - * compile all its files - * load the files into a running lisp environment - * copy its source files somewhere else + • compile all its files + • load the files into a running lisp environment + • copy its source files somewhere else Operations can be invoked directly, or examined to see what their effects would be without performing them. There are a bunch of methods specialised on operation and component type that actually do the grunt -work. Operations are invoked on systems via 'operate' (*note +work. Operations are invoked on systems via ‘operate’ (*note operate::). ASDF contains a number of pre-defined operation classes for common, and even fairly uncommon tasks that you might want to do with it. In -addition, ASDF contains "abstract" operation classes that programmers +addition, ASDF contains “abstract†operation classes that programmers can use as building blocks to define ASDF extensions. We discuss these in turn below. @@ -1805,38 +1905,38 @@ in turn below. * Predefined operations of ASDF:: * Creating new operations:: - Operations are invoked on systems via 'operate'. - -- Generic function: 'operate' OPERATION COMPONENT &rest INITARGS &key - 'force' 'force-not' 'verbose' &allow-other-keys - -- Generic function: 'oos' OPERATION COMPONENT &rest INITARGS &key + Operations are invoked on systems via ‘operate’. + -- Generic function: operate OPERATION COMPONENT &rest INITARGS &key + ‘force’ ‘force-not’ ‘verbose’ &allow-other-keys + -- Generic function: oos OPERATION COMPONENT &rest INITARGS &key &allow-other-keys - 'operate' invokes OPERATION on SYSTEM. 'oos' is a synonym for - 'operate' (it stands for operate-on-system). + ‘operate’ invokes OPERATION on SYSTEM. ‘oos’ is a synonym for + ‘operate’ (it stands for operate-on-system). OPERATION is an operation designator: it can be an operation object - itself, or, typically, a symbol that is passed to 'make-operation' - (which will call 'make-instance'), to create the operation object. + itself, or, typically, a symbol that is passed to ‘make-operation’ + (which will call ‘make-instance’), to create the operation object. COMPONENT is a component designator: it can be a component object itself, or, typically, a string or symbol (to be - 'string-downcase'd) that names a system, more rarely a list of + ‘string-downcase’d) that names a system, more rarely a list of strings or symbols that designate a subcomponent of a system. - The ability to pass INITARGS to 'make-operation' is now deprecated, + The ability to pass INITARGS to ‘make-operation’ is now deprecated, and will be removed. For more details, *note make-operation::. Note that dependencies may cause the operation to invoke other operations on the system or its components: the new operations may or may not be created with the same INITARGS as the original one (for the moment). - If FORCE is ':all', then all systems are forced to be recompiled - even if not modified since last compilation. If FORCE is 't', then + If FORCE is ‘:all’, then all systems are forced to be recompiled + even if not modified since last compilation. If FORCE is ‘t’, then only the system being loaded is forced to be recompiled even if not modified since last compilation, but other systems are not affected. If FORCE is a list, then it specifies a list of systems that are forced to be recompiled even if not modified since last - compilation. If FORCE-NOT is ':all', then all systems are forced + compilation. If FORCE-NOT is ‘:all’, then all systems are forced not to be recompiled even if modified since last compilation. If - FORCE-NOT is 't', then all systems but the system being loaded are + FORCE-NOT is ‘t’, then all systems but the system being loaded are forced not to be recompiled even if modified since last compilation (note: this was changed in ASDF 3.1.2). If FORCE-NOT is a list, then it specifies a list of systems that are forced not to be @@ -1846,24 +1946,24 @@ in turn below. were already compiled. FORCE-NOT takes precedences over FORCE, as it should, really, but unhappily only since ASDF 3.1.2. Moreover, systems which have been registered as immutable by - 'register-immutable-system' (since ASDF 3.1.5) are always - considered FORCED-NOT, and even their '.asd' are not refreshed from + ‘register-immutable-system’ (since ASDF 3.1.5) are always + considered FORCED-NOT, and even their ‘.asd’ are not refreshed from the filesystem. *Note Miscellaneous Functions::. - To see what 'operate' would do, you can use: + To see what ‘operate’ would do, you can use: (asdf:traverse operation-class system-name) - -- Function: 'make-operation' OPERATION-CLASS &rest INITARGS + -- Function: make-operation OPERATION-CLASS &rest INITARGS - The INITARGS are passed to 'make-instance' call when creating the + The INITARGS are passed to ‘make-instance’ call when creating the operation object. - *Note:*INITARGS for 'operation's are now deprecated, and will be + *Note:*INITARGS for ‘operation’s are now deprecated, and will be removed from ASDF in the near future. - *Note:* 'operation' instances must *never* be created using - 'make-instance' directly: only through 'make-operation'. Attempts - to directly make 'operation' instances will cause a run-time error. + *Note:* ‘operation’ instances must *never* be created using + ‘make-instance’ directly: only through ‘make-operation’. Attempts + to directly make ‘operation’ instances will cause a run-time error. File: asdf.info, Node: Predefined operations of ASDF, Next: Creating new operations, Prev: Operations, Up: Operations @@ -1871,60 +1971,61 @@ File: asdf.info, Node: Predefined operations of ASDF, Next: Creating new opera 7.1.1 Predefined operations of ASDF ----------------------------------- -All the operations described in this section are in the 'asdf' package. -They are invoked via the 'operate' generic function. +All the operations described in this section are in the ‘asdf’ package. +They are invoked via the ‘operate’ generic function. (asdf:operate 'asdf:OPERATION-NAME :SYSTEM-NAME {OPERATION-OPTIONS ...}) - -- Operation: 'compile-op' + -- Operation: compile-op This operation compiles the specified component. A - 'cl-source-file' will be 'compile-file''d. All the children and + ‘cl-source-file’ will be ‘compile-file’’d. All the children and dependencies of a system or module will be recursively compiled by - 'compile-op'. + ‘compile-op’. - 'compile-op' depends on 'prepare-op' which itself depends on a - 'load-op' of all of a component's dependencies, as well as of its - parent's dependencies. When 'operate' is called on 'compile-op', + ‘compile-op’ depends on ‘prepare-op’ which itself depends on a + ‘load-op’ of all of a component’s dependencies, as well as of its + parent’s dependencies. When ‘operate’ is called on ‘compile-op’, all these dependencies will be loaded as well as compiled; yet, some parts of the system main remain unloaded, because nothing - depends on them. Use 'load-op' to load a system. + depends on them. Use ‘load-op’ to load a system. - -- Operation: 'load-op' + -- Operation: load-op This operation loads the compiled code for a specified component. - A 'cl-source-file' will have its compiled fasl 'load'ed, which fasl - is the output of 'compile-op' that 'load-op' depends on. + A ‘cl-source-file’ will have its compiled fasl ‘load’ed, which fasl + is the output of ‘compile-op’ that ‘load-op’ depends on. - 'load-op' will recursively load all the children of a system or + ‘load-op’ will recursively load all the children of a system or module. - 'load-op' also depends on 'prepare-op' which itself depends on a - 'load-op' of all of a component's dependencies, as well as of its - parent's dependencies. + ‘load-op’ also depends on ‘prepare-op’ which itself depends on a + ‘load-op’ of all of a component’s dependencies, as well as of its + parent’s dependencies. - -- Operation: 'prepare-op' + -- Operation: prepare-op This operation ensures that the dependencies of a component and its - recursive parents are loaded (as per 'load-op'), as a prerequisite - before 'compile-op' and 'load-op' operations may be performed on a + recursive parents are loaded (as per ‘load-op’), as a prerequisite + before ‘compile-op’ and ‘load-op’ operations may be performed on a given component. - -- Operation: 'load-source-op', 'prepare-source-op' + -- Operation: load-source-op + -- Operation: prepare-source-op - 'load-source-op' will load the source for the files in a module - rather than the compiled fasl output. It has a 'prepare-source-op' - analog to 'prepare-op', that ensures the dependencies are - themselves loaded via 'load-source-op'. + ‘load-source-op’ will load the source for the files in a module + rather than the compiled fasl output. It has a ‘prepare-source-op’ + analog to ‘prepare-op’, that ensures the dependencies are + themselves loaded via ‘load-source-op’. - -- Operation: 'test-op' + -- Operation: test-op This operation will perform some tests on the module. The default method will do nothing. The default dependency is to require - 'load-op' to be performed on the module first. Its default - 'operation-done-p' method returns 'nil', which means that the - operation is _never_ done - we assume that if you invoke the - 'test-op', you want to test the system, even if you have already + ‘load-op’ to be performed on the module first. Its default + ‘operation-done-p’ method returns ‘nil’, which means that the + operation is _never_ done – we assume that if you invoke the + ‘test-op’, you want to test the system, even if you have already done so. The results of this operation are not defined by ASDF. It has @@ -1933,7 +2034,7 @@ They are invoked via the 'operate' generic function. various test libraries and test techniques in use in the community, and given the fact that ASDF operations do not return a value indicating success or failure. For those willing to go to the - effort, we suggest defining conditions to signal when a 'test-op' + effort, we suggest defining conditions to signal when a ‘test-op’ fails, and storing in those conditions information that describes which tests fail. @@ -1948,7 +2049,7 @@ They are invoked via the 'operate' generic function. :depends-on ("foo" "fiveam") ; fiveam is a test framework library ...) - Then one defines 'perform' methods on 'test-op' such as the + Then one defines ‘perform’ methods on ‘test-op’ such as the following: (defsystem "foo/test" :depends-on ("foo" "fiveam") ; fiveam is a test framework library @@ -1958,102 +2059,109 @@ They are invoked via the 'operate' generic function. :foo-tests))) ...) - -- Operation: 'compile-bundle-op', 'monolithic-compile-bundle-op', - 'load-bundle-op', 'monolithic-load-bundle-op', - 'deliver-asd-op', 'monolithic-deliver-asd-op', 'lib-op', - 'monolithic-lib-op', 'dll-op', 'monolithic-dll-op', - 'image-op', 'program-op' - - These are "bundle" operations, that can create a single-file - "bundle" for all the contents of each system in an application, or + -- Operation: compile-bundle-op + -- Operation: monolithic-compile-bundle-op + -- Operation: load-bundle-op + -- Operation: monolithic-load-bundle-op + -- Operation: deliver-asd-op + -- Operation: monolithic-deliver-asd-op + -- Operation: lib-op + -- Operation: monolithic-lib-op + -- Operation: dll-op + -- Operation: monolithic-dll-op + -- Operation: image-op + -- Operation: program-op + + These are “bundle†operations, that can create a single-file + “bundle†for all the contents of each system in an application, or for the entire application. - 'compile-bundle-op' will create a single fasl file for each of the + ‘compile-bundle-op’ will create a single fasl file for each of the systems needed, grouping all its many fasls in one, so you can - deliver each system as a single fasl 'monolithic-compile-bundle-op' - will create a single fasl file for the target system and all its - dependencies, so you can deliver your entire application as a - single fasl. 'load-bundle-op' will load the output of - 'compile-bundle-op'. Note that if it the output is not up-to-date, - 'compile-bundle-op' may load the intermediate fasls as a - side-effect. Bundling fasls together matters a lot on ECL, where + deliver each system as a single fasl. + ‘monolithic-compile-bundle-op’ will create a single fasl file for + the target system and all its dependencies, so you can deliver your + entire application as a single fasl. ‘load-bundle-op’ will load + the output of ‘compile-bundle-op’. Note that if the output is not + up-to-date, ‘compile-bundle-op’ may load the intermediate fasls as + a side-effect. Bundling fasls together matters a lot on ECL, where the dynamic linking involved in loading tens of individual fasls can be noticeably more expensive than loading a single one. - NB: 'compile-bundle-op', 'monolithic-compile-bundle-op', - 'load-bundle-op', 'monolithic-load-bundle-op', 'deliver-asd-op', - 'monolithic-deliver-asd-op' were respectively called 'fasl-op', - 'monolithic-fasl-op', 'load-fasl-op', 'monolithic-load-fasl-op', - 'binary-op', 'monolithic-binary-op' before ASDF 3.1. The old names + NB: ‘compile-bundle-op’, ‘monolithic-compile-bundle-op’, + ‘load-bundle-op’, ‘monolithic-load-bundle-op’, ‘deliver-asd-op’, + ‘monolithic-deliver-asd-op’ were respectively called ‘fasl-op’, + ‘monolithic-fasl-op’, ‘load-fasl-op’, ‘monolithic-load-fasl-op’, + ‘binary-op’, ‘monolithic-binary-op’ before ASDF 3.1. The old names still exist for backward compatibility, though they poorly label what is going on. - Once you have created a fasl with 'compile-bundle-op', you can use - 'precompiled-system' to deliver it in a way that is compatible with + Once you have created a fasl with ‘compile-bundle-op’, you can use + ‘precompiled-system’ to deliver it in a way that is compatible with clients having dependencies on your system, whether it is - distributed as source or as a single binary; the '.asd' file to be + distributed as source or as a single binary; the ‘.asd’ file to be delivered with the fasl will look like this: (defsystem :mysystem :class :precompiled-system :fasl (some expression that will evaluate to a pathname)) - Or you can use 'deliver-asd-op' to let ASDF create such a system - for you as well as the 'compile-bundle-op' output, or - 'monolithic-deliver-asd-op'. This allows you to deliver code for + Or you can use ‘deliver-asd-op’ to let ASDF create such a system + for you as well as the ‘compile-bundle-op’ output, or + ‘monolithic-deliver-asd-op’. This allows you to deliver code for your systems or applications as a single file. Of course, if you want to test the result in the current image, _before_ you try to - use any newly created '.asd' files, you should not forget to - '(asdf:clear-configuration)' or at least - '(asdf:clear-source-registry)', so it re-populates the + use any newly created ‘.asd’ files, you should not forget to + ‘(asdf:clear-configuration)’ or at least + ‘(asdf:clear-source-registry)’, so it re-populates the source-registry from the filesystem. - The 'program-op' operation will create an executable program from + The ‘program-op’ operation will create an executable program from the specified system and its dependencies. You can use UIOP for its pre-image-dump hooks, its post-image-restore hooks, and its access to command-line arguments. And you can specify an entry - point 'my-app:main' by specifying in your 'defsystem' the option - ':entry-point "my-app:main"'. Depending on your implementation, - running '(asdf:operate 'asdf:program-op :my-app)' may quit the + point ‘my-app:main’ by specifying in your ‘defsystem’ the option + ‘:entry-point "my-app:main"’. Depending on your implementation, + running ‘(asdf:operate 'asdf:program-op :my-app)’ may quit the current Lisp image upon completion. See the example in - 'test/hello-world-example.asd' and 'test/hello.lisp', as built and - tested by 'test/test-program.script' and - 'test/make-hello-world.lisp'. 'image-op' will dump an image that + ‘test/hello-world-example.asd’ and ‘test/hello.lisp’, as built and + tested by ‘test/test-program.script’ and + ‘test/make-hello-world.lisp’. ‘image-op’ will dump an image that may not be standalone and does not start its own function, but follows the usual execution convention of the underlying Lisp, just with more code pre-loaded, for use as an intermediate build result or with a wrapper invocation script. - There is also 'lib-op' for building a linkable '.a' file (Windows: - '.lib') from all linkable object dependencies (FFI files, and on + There is also ‘lib-op’ for building a linkable ‘.a’ file (Windows: + ‘.lib’) from all linkable object dependencies (FFI files, and on ECL, Lisp files too), and its monolithic equivalent - 'monolithic-lib-op'. And there is also 'dll-op' (respectively its - monolithic equivalent 'monolithic-lib-op') for building a linkable - '.so' file (Windows: '.dll', MacOS X: '.dynlib') to create a single + ‘monolithic-lib-op’. And there is also ‘dll-op’ (respectively its + monolithic equivalent ‘monolithic-dll-op’) for building a linkable + ‘.so’ file (Windows: ‘.dll’, MacOS X: ‘.dynlib’) to create a single dynamic library for all the extra FFI code to be linked into each of your systems (respectively your entire application). - All these "bundle" operations are available since ASDF 3 on all + All these “bundle†operations are available since ASDF 3 on all actively supported Lisp implementations, but may be unavailable on unmaintained legacy implementations. This functionality was previously available for select implementations, as part of a - separate system 'asdf-bundle', itself descended from the ECL-only - 'asdf-ecl'. + separate system ‘asdf-bundle’, itself descended from the ECL-only + ‘asdf-ecl’. The pathname of the output of bundle operations is subject to output-translation as usual, unless the operation is equal to the - ':build-operation' argument to 'defsystem'. This behaviour is not + ‘:build-operation’ argument to ‘defsystem’. This behaviour is not very satisfactory and may change in the future. Maybe you have suggestions on how to better configure it? - -- Operation: 'concatenate-source-op', - 'monolithic-concatenate-source-op', - 'load-concatenated-source-op', - 'compile-concatenated-source-op', - 'load-compiled-concatenated-source-op', - 'monolithic-load-concatenated-source-op', - 'monolithic-compile-concatenated-source-op', - 'monolithic-load-compiled-concatenated-source-op' + -- Operation: concatenate-source-op + -- Operation: monolithic-concatenate-source-op + -- Operation: load-concatenated-source-op + -- Operation: compile-concatenated-source-op + -- Operation: load-compiled-concatenated-source-op + -- Operation: monolithic-load-concatenated-source-op + -- Operation: monolithic-compile-concatenated-source-op + -- Operation: monolithic-load-compiled-concatenated-source-op These operations, as their respective names indicate, will - concatenate all the 'cl-source-file' source files in a system (or + concatenate all the ‘cl-source-file’ source files in a system (or in a system and all its dependencies, if monolithic), in the order defined by dependencies, then load the result, or compile and then load the result. @@ -2063,8 +2171,8 @@ They are invoked via the 'operate' generic function. or compiles and then loads properly. ASDF itself is delivered as a single source file this way, using - 'monolithic-concatenate-source-op', prepending a prelude and the - 'uiop' library before the 'asdf/defsystem' system itself. + ‘monolithic-concatenate-source-op’, prepending a prelude and the + ‘uiop’ library before the ‘asdf/defsystem’ system itself. File: asdf.info, Node: Creating new operations, Prev: Predefined operations of ASDF, Up: Operations @@ -2074,46 +2182,46 @@ File: asdf.info, Node: Creating new operations, Prev: Predefined operations of ASDF was designed to be extensible in an object-oriented fashion. To teach ASDF new tricks, a programmer can implement the behaviour he wants -by creating a subclass of 'operation'. +by creating a subclass of ‘operation’. - ASDF's pre-defined operations are in no way "privileged", but it is -requested that developers never use the 'asdf' package for operations -they develop themselves. The rationale for this rule is that we don't -want to establish a "global asdf operation name registry", but also want + ASDF’s pre-defined operations are in no way “privilegedâ€, but it is +requested that developers never use the ‘asdf’ package for operations +they develop themselves. The rationale for this rule is that we don’t +want to establish a “global asdf operation name registryâ€, but also want to avoid name clashes. Your operation _must_ usually provide methods for one or more of the following generic functions: - * 'perform' Unless your operation, like 'prepare-op', is for + • ‘perform’ Unless your operation, like ‘prepare-op’, is for dependency propagation only, the most important function for which - to define a method is usually 'perform', which will be called to + to define a method is usually ‘perform’, which will be called to perform the operation on a specified component, after all dependencies have been performed. - The 'perform' method must call 'input-files' and 'output-files' + The ‘perform’ method must call ‘input-files’ and ‘output-files’ (see below) to locate its inputs and outputs, because the user is allowed to override the method or tweak the output-translation mechanism. Perform should only use the primary value returned by - 'output-files'. If one and only one output file is expected, it - can call 'output-file' that checks that this is the case and + ‘output-files’. If one and only one output file is expected, it + can call ‘output-file’ that checks that this is the case and returns the first and only list element. - * 'output-files' If your perform method has any output, you must + • ‘output-files’ If your perform method has any output, you must define a method for this function. for ASDF to determine where the outputs of performing operation lie. Your method may return two values, a list of pathnames, and a - boolean. If the boolean is 'nil' (or you fail to return multiple - values), then enclosing ':around' methods may translate these + boolean. If the boolean is ‘nil’ (or you fail to return multiple + values), then enclosing ‘:around’ methods may translate these pathnames, e.g. to ensure object files are somehow stored in some - implementation-dependent cache. If the boolean is 't' then the - pathnames are marked not be translated by the enclosing ':around' + implementation-dependent cache. If the boolean is ‘t’ then the + pathnames are marked not be translated by the enclosing ‘:around’ method. - * 'component-depends-on' If the action of performing the operation on + • ‘component-depends-on’ If the action of performing the operation on a component has dependencies, you must define a method on - 'component-depends-on'. + ‘component-depends-on’. Your method will take as specialized arguments an operation and a component which together identify an action, and return a list of @@ -2121,36 +2229,36 @@ following generic functions: of entries is described below. It is _strongly_ advised that you should always append the results - of '(call-next-method)' to the results of your method, or - "interesting" failures will likely occur, unless you're a true + of ‘(call-next-method)’ to the results of your method, or + “interesting†failures will likely occur, unless you’re a true specialist of ASDF internals. It is unhappily too late to - compatibly use the 'append' method combination, but conceptually - that's the protocol that is being manually implemented. + compatibly use the ‘append’ method combination, but conceptually + that’s the protocol that is being manually implemented. - Each entry returned by 'component-depends-on' is itself a list. + Each entry returned by ‘component-depends-on’ is itself a list. The first element of an entry is an operation designator: either an operation object designating itself, or a symbol that names an operation class (that ASDF will instantiate using - 'make-operation'). For instance, 'load-op', 'compile-op' and - 'prepare-op' are common such names, denoting the respective + ‘make-operation’). For instance, ‘load-op’, ‘compile-op’ and + ‘prepare-op’ are common such names, denoting the respective operations. The rest of each entry is a list of component designators: either a component object designating itself, or an identifier to be used - with 'find-component'. 'find-component' will be called with the - current component's parent as parent, and the identifier as second + with ‘find-component’. ‘find-component’ will be called with the + current component’s parent as parent, and the identifier as second argument. The identifier is typically a string, a symbol (to be - downcased as per 'coerce-name'), or a list of strings or symbols. - In particular, the empty list 'nil' denotes the parent itself. + downcased as per ‘coerce-name’), or a list of strings or symbols. + In particular, the empty list ‘nil’ denotes the parent itself. An operation _may_ provide methods for the following generic functions: - * 'input-files' A method for this function is often not needed, since - ASDF has a pretty clever default 'input-files' mechanism. You only + • ‘input-files’ A method for this function is often not needed, since + ASDF has a pretty clever default ‘input-files’ mechanism. You only need create a method if there are multiple ultimate input files. - Most operations inherit from 'selfward-operation', which + Most operations inherit from ‘selfward-operation’, which appropriately sets the input-files to include the source file itself. @@ -2158,19 +2266,19 @@ functions: Return a list of pathnames that represent the input to OPERATION performed on COMPONENT. - * 'operation-done-p' You only need to define a method on that + • ‘operation-done-p’ You only need to define a method on that function if you can detect conditions that invalidate previous runs of the operation, even though no filesystem timestamp has changed, - in which case you return 'nil' (the default is 't'). + in which case you return ‘nil’ (the default is ‘t’). - For instance, the method for 'test-op' always returns 'nil', so - that tests are always run afresh. Of course, the 'test-op' for + For instance, the method for ‘test-op’ always returns ‘nil’, so + that tests are always run afresh. Of course, the ‘test-op’ for your system could depend on a deterministically repeatable - 'test-report-op', and just read the results from the report files, - in which case you could have this method return 't'. + ‘test-report-op’, and just read the results from the report files, + in which case you could have this method return ‘t’. Operations that print output should send that output to the standard -CL stream '*standard-output*', as the Lisp compiler and loader do. +CL stream ‘*standard-output*’, as the Lisp compiler and loader do. File: asdf.info, Node: Components, Next: Dependencies, Prev: Operations, Up: The object model of ASDF @@ -2178,131 +2286,131 @@ File: asdf.info, Node: Components, Next: Dependencies, Prev: Operations, Up: 7.2 Components ============== -A 'component' represents an individual source file or a group of source -files, and the things that get transformed into. A 'system' is a +A ‘component’ represents an individual source file or a group of source +files, and the things that get transformed into. A ‘system’ is a component at the top level of the component hierarchy, that can be found -via 'find-system'. A 'source-file' is a component representing a single +via ‘find-system’. A ‘source-file’ is a component representing a single source-file and the successive output files into which it is -transformed. A 'module' is an intermediate component itself grouping +transformed. A ‘module’ is an intermediate component itself grouping several other components, themselves source-files or further modules. - A "system designator" is a system itself, or a string or symbol that + A “system designator†is a system itself, or a string or symbol that behaves just like any other component name (including with regard to the case conversion rules for component names). - A "component designator", relative to a base component, is either a + A “component designatorâ€, relative to a base component, is either a component itself, or a string or symbol, or a list of designators. -- Function: find-system system-designator &optional (error-p t) - Given a system designator, 'find-system' finds and returns a + Given a system designator, ‘find-system’ finds and returns a system. If no system is found, an error of type - 'missing-component' is thrown, or 'nil' is returned if 'error-p' is + ‘missing-component’ is thrown, or ‘nil’ is returned if ‘error-p’ is false. - To find and update systems, 'find-system' funcalls each element in - the '*system-definition-search-functions*' list, expecting a + To find and update systems, ‘find-system’ funcalls each element in + the ‘*system-definition-search-functions*’ list, expecting a pathname to be returned, or a system object, from which a pathname may be extracted, and that will be registered. The resulting pathname (if any) is loaded if one of the following conditions is true: - * there is no system of that name in memory - * the pathname is different from that which was previously + • there is no system of that name in memory + • the pathname is different from that which was previously loaded - * the file's 'last-modified' time exceeds the 'last-modified' + • the file’s ‘last-modified’ time exceeds the ‘last-modified’ time of the system in memory - When system definitions are loaded from '.asd' files, they are - implicitly loaded into the 'ASDF-USER' package, which uses 'ASDF', - 'UIOP' and 'UIOP/COMMON-LISP'(1) Programmers who do anything - non-trivial in a '.asd' file, such as defining new variables, - functions or classes, should include 'defpackage' and 'in-package' - forms in this file, so they will not overwrite each others' + When system definitions are loaded from ‘.asd’ files, they are + implicitly loaded into the ‘ASDF-USER’ package, which uses ‘ASDF’, + ‘UIOP’ and ‘UIOP/COMMON-LISP’(1) Programmers who do anything + non-trivial in a ‘.asd’ file, such as defining new variables, + functions or classes, should include ‘defpackage’ and ‘in-package’ + forms in this file, so they will not overwrite each others’ extensions. Such forms might also help the files behave - identically if loaded manually with 'cl:load' for development or + identically if loaded manually with ‘cl:load’ for development or debugging, though we recommend you use the function - 'asdf::load-asd' instead, which the 'slime-asdf' contrib knows + ‘asdf::load-asd’ instead, which the ‘slime-asdf’ contrib knows about. - The default value of '*system-definition-search-functions*' is a + The default value of ‘*system-definition-search-functions*’ is a list of three functions. The first function looks in each of the - directories given by evaluating members of '*central-registry*' for + directories given by evaluating members of ‘*central-registry*’ for a file whose name is the name of the system and whose type is - 'asd'; the first such file is returned, whether or not it turns out + ‘asd’; the first such file is returned, whether or not it turns out to actually define the appropriate system. The second function does something similar, for the directories specified in the - 'source-registry', but searches the filesystem only once and caches + ‘source-registry’, but searches the filesystem only once and caches its results. The third function makes the - 'package-inferred-system' extension work, *note The + ‘package-inferred-system’ extension work, *note The package-inferred-system extension::. Because of the way these search functions are defined, you should - put the definition for a system FOO in a file named 'foo.asd', in a + put the definition for a system FOO in a file named ‘foo.asd’, in a directory that is in the central registry or which can be found using the source registry configuration. It is often useful to define multiple systems in a same file, but - ASDF can only locate a system's definition file based on the system - name. For this reason, ASDF 3's system search algorithm has been - extended to allow a file 'foo.asd' to contain secondary systems + ASDF can only locate a system’s definition file based on the system + name. For this reason, ASDF 3’s system search algorithm has been + extended to allow a file ‘foo.asd’ to contain secondary systems named FOO/BAR, FOO/BAZ, FOO/QUUX, etc., in addition to the primary system named FOO. The first component of a system name, separated - by the slash character, '/', is called the primary name of a + by the slash character, ‘/’, is called the primary name of a system. The primary name may be extracted by function - 'asdf::primary-system-name'; when ASDF 3 is told to find a system + ‘asdf::primary-system-name’; when ASDF 3 is told to find a system whose name has a slash, it will first attempt to load the corresponding primary system, and will thus see any such definitions, and/or any definition of a - 'package-inferred-system'.(2) If your file 'foo.asd' also defines + ‘package-inferred-system’.(2) If your file ‘foo.asd’ also defines systems that do not follow this convention, e.g., a system named FOO-TEST, ASDF will not be able to automatically locate a definition for these systems, and will only see their definition if you explicitly find or load the primary system using e.g. - '(asdf:find-system "foo")' before you try to use them. We strongly + ‘(asdf:find-system "foo")’ before you try to use them. We strongly recommend against this practice, though it is currently supported for backward compatibility. -- Function: primary-system-name name - Internal (not exported) function, 'asdf::primary-system-name'. - Returns the primary system name (the portion before the slash, '/', + Internal (not exported) function, ‘asdf::primary-system-name’. + Returns the primary system name (the portion before the slash, ‘/’, in a secondary system name) from NAME. -- Function: locate-system name This function should typically _not_ be invoked directly. It is exported as part of the API only for programmers who wish to - provide their own '*system-definition-search-functions*'. + provide their own ‘*system-definition-search-functions*’. Given a system NAME designator, try to locate where to load the system definition from. Returns five values: FOUNDP, FOUND-SYSTEM, PATHNAME, PREVIOUS, and PREVIOUS-TIME. FOUNDP is true when a system was found, either a new as yet unregistered one, or a previously registered one. The FOUND-SYSTEM return value will be a - 'system' object, if a system definition is found in your source - registry. The system definition will _not_ be loaded if it hasn't + ‘system’ object, if a system definition is found in your source + registry. The system definition will _not_ be loaded if it hasn’t been loaded already. PATHNAME when not null is a path from which to load the system, either associated with FOUND-SYSTEM, or with the PREVIOUS system. If PREVIOUS is not null, it will be a - _previously loaded_ 'system' object of the same name (note that the + _previously loaded_ ‘system’ object of the same name (note that the system _definition_ is previously-loaded: the system itself may or may not be). PREVIOUS-TIME when not null is the timestamp of the previous system definition file, at the time when the PREVIOUS system definition was loaded. - For example, if your current registry has 'foo.asd' in - '/current/path/to/foo.asd', but system 'foo' was previously loaded - from '/previous/path/to/foo.asd' then LOCATE-SYSTEM will return the + For example, if your current registry has ‘foo.asd’ in + ‘/current/path/to/foo.asd’, but system ‘foo’ was previously loaded + from ‘/previous/path/to/foo.asd’ then LOCATE-SYSTEM will return the following values: - 1. FOUNDP will be 't', - 2. FOUND-SYSTEM will be 'nil', - 3. PATHNAME will be '#p"/current/path/to/foo.asd"', - 4. PREVIOUS will be an object of type 'SYSTEM' with - 'system-source-file' slot value of - '#p"/previous/path/to/foo.asd"' + 1. FOUNDP will be ‘t’, + 2. FOUND-SYSTEM will be ‘nil’, + 3. PATHNAME will be ‘#p"/current/path/to/foo.asd"’, + 4. PREVIOUS will be an object of type ‘SYSTEM’ with + ‘system-source-file’ slot value of + ‘#p"/previous/path/to/foo.asd"’ 5. PREVIOUS-TIME will be the timestamp of - '#p"/previous/path/to/foo.asd"' at the time it was loaded. + ‘#p"/previous/path/to/foo.asd"’ at the time it was loaded. -- Function: find-component base path @@ -2312,25 +2420,25 @@ component itself, or a string or symbol, or a list of designators. If PATH is a component object, it designates itself, independently from the base. - If PATH is a string, or symbol denoting a string via 'coerce-name', + If PATH is a string, or symbol denoting a string via ‘coerce-name’, then BASE is resolved to a component object, which must be a system or module, and the designated component is the child named by the PATH. - If PATH is a 'cons' cell, 'find-component' with the base and the - 'car' of the PATH, and the resulting object is used as the base for - a tail call to 'find-component' with the 'car' of the PATH. + If PATH is a ‘cons’ cell, ‘find-component’ with the base and the + ‘car’ of the PATH, and the resulting object is used as the base for + a tail call to ‘find-component’ with the ‘car’ of the PATH. If BASE is a component object, it designates itself. - If BASE is null, then PATH is used as the base, with 'nil' as the + If BASE is null, then PATH is used as the base, with ‘nil’ as the path. - If BASE is a string, or symbol denoting a string via 'coerce-name', - it designates a system as per 'find-system'. + If BASE is a string, or symbol denoting a string via ‘coerce-name’, + it designates a system as per ‘find-system’. - If BASE is a 'cons' cell, it designates the component found by - 'find-component' with its 'car' as base and 'cdr' as path. + If BASE is a ‘cons’ cell, it designates the component found by + ‘find-component’ with its ‘car’ as base and ‘cdr’ as path. * Menu: @@ -2340,16 +2448,16 @@ component itself, or a string or symbol, or a list of designators. ---------- Footnotes ---------- - (1) Note that between releases 2.27 and 3.0.3, only 'UIOP/PACKAGE', -not all of 'UIOP', was used; if you want your code to work with releases + (1) Note that between releases 2.27 and 3.0.3, only ‘UIOP/PACKAGE’, +not all of ‘UIOP’, was used; if you want your code to work with releases earlier than 3.1.2, you may have to explicitly define a package that -uses 'UIOP', or use proper package prefix to your symbols, as in -'uiop:version<'. +uses ‘UIOP’, or use proper package prefix to your symbols, as in +‘uiop:version<’. (2) ASDF 2.26 and earlier versions do not support this primary system name convention. With these versions of ASDF you must explicitly load -'foo.asd' before you can use system FOO/BAR defined therein, e.g. using -'(asdf:find-system "foo")'. We do not support ASDF 2, and recommend +‘foo.asd’ before you can use system FOO/BAR defined therein, e.g. using +‘(asdf:find-system "foo")’. We do not support ASDF 2, and recommend that you should upgrade to ASDF 3. @@ -2359,67 +2467,66 @@ File: asdf.info, Node: Common attributes of components, Next: Pre-defined subc ------------------------------------- All components, regardless of type, have the following attributes. All -attributes except 'name' are optional. +attributes except ‘name’ are optional. 7.2.1.1 Name ............ A component name is a string or a symbol. If a symbol, its name is taken and lowercased. This translation is performed by the exported -function 'coerce-name'. +function ‘coerce-name’. - Unless overridden by a ':pathname' attribute, the name will be + Unless overridden by a ‘:pathname’ attribute, the name will be interpreted as a pathname specifier according to a Unix-style syntax. -*Note Pathname specifiers: The defsystem grammar. +*Note Pathname specifiers::. 7.2.1.2 Version identifier .......................... This optional attribute specifies a version for the current component. The version should typically be a string of integers separated by dots, -for example '1.0.11'. For more information on version specifiers, see -*note The defsystem grammar::. +for example ‘1.0.11’. *Note Version specifiers::. A version may then be queried by the generic function -'version-satisfies', to see if ':version' dependencies are satisfied, +‘version-satisfies’, to see if ‘:version’ dependencies are satisfied, and when specifying dependencies, a constraint of minimal version to -satisfy can be specified using e.g. '(:version "mydepname" "1.0.11")'. +satisfy can be specified using e.g. ‘(:version "mydepname" "1.0.11")’. Note that in the wild, we typically see version numbering only on -components of type 'system'. Presumably it is much less useful within a +components of type ‘system’. Presumably it is much less useful within a given system, wherein the library author is responsible to keep the various files in synch. 7.2.1.3 Required features ......................... -Traditionally defsystem users have used '#+' reader conditionals to +Traditionally defsystem users have used ‘#+’ reader conditionals to include or exclude specific per-implementation files. For example, CFFI, the portable C foreign function interface contained lines like: #+sbcl (:file "cffi-sbcl") An unfortunate side effect of this approach is that no single implementation can read the entire system. This causes problems if, for -example, one wished to design an 'archive-op' that would create an +example, one wished to design an ‘archive-op’ that would create an archive file containing all the sources, since for example the file -'cffi-sbcl.lisp' above would be invisible when running the 'archive-op' +‘cffi-sbcl.lisp’ above would be invisible when running the ‘archive-op’ on any implementation other than SBCL. - Starting with ASDF 3, components may therefore have an ':if-feature' + Starting with ASDF 3, components may therefore have an ‘:if-feature’ option. The value of this option should be a feature expression using -the same syntax as '#+' does. If that feature expression evaluates to +the same syntax as ‘#+’ does. If that feature expression evaluates to false, any reference to the component will be ignored during compilation, loading and/or linking. Since the expression is read by -the normal reader, you must explicitly prefix your symbols with ':' so -they be read as keywords; this is as contrasted with the '#+' syntax +the normal reader, you must explicitly prefix your symbols with ‘:’ so +they be read as keywords; this is as contrasted with the ‘#+’ syntax that implicitly reads symbols in the keyword package by default. - For instance, ':if-feature (:and :x86 (:or :sbcl :cmu :scl))' + For instance, ‘:if-feature (:and :x86 (:or :sbcl :cmu :scl))’ specifies that the given component is only to be compiled and loaded when the implementation is SBCL, CMUCL or Scieneer CL on an x86 machine. -You cannot write it as ':if-feature (and x86 (or sbcl cmu scl))' since +You cannot write it as ‘:if-feature (and x86 (or sbcl cmu scl))’ since the symbols would not be read as keywords. - *Note if-feature-option::. + *Note if-feature option::. 7.2.1.4 Dependencies .................... @@ -2437,9 +2544,9 @@ initargs for the component, you can say (load-op (load-op "foo"))) This means the following things: - * before performing compile-op on this component, we must perform + • before performing compile-op on this component, we must perform load-op on A and B, and compile-op on C, - * before performing 'load-op', we have to load FOO + • before performing ‘load-op’, we have to load FOO The syntax is approximately @@ -2461,7 +2568,7 @@ general: it has an implied dependency for all source file x, (load x) depends on (compile x) - and using a ':depends-on' argument to say that B depends on A + and using a ‘:depends-on’ argument to say that B depends on A _actually_ means that (compile b) depends on (load a) @@ -2472,24 +2579,24 @@ all the files are loaded before any of them can be compiled ] End side note In ASDF, the dependency information for a given component and -operation can be queried using '(component-depends-on operation -component)', which returns a list +operation can be queried using ‘(component-depends-on operation +component)’, which returns a list ((load-op "a") (load-op "b") (compile-op "c") ...) - 'component-depends-on' can be subclassed for more specific -component/operation types: these need to '(call-next-method)' and append + ‘component-depends-on’ can be subclassed for more specific +component/operation types: these need to ‘(call-next-method)’ and append the answer to their dependency, unless they have a good reason for completely overriding the default dependencies. - If it weren't for CLISP, we'd be using 'LIST' method combination to + If it weren’t for CLISP, we’d be using ‘LIST’ method combination to do this transparently. But, we need to support CLISP. If you have the -time for some CLISP hacking, I'm sure they'd welcome your fixes. +time for some CLISP hacking, I’m sure they’d welcome your fixes. A minimal version can be specified for a component you depend on -(typically another system), by specifying '(:version "other-system" -"1.2.3")' instead of simply '"other-system"' as the dependency. See the -discussion of the semantics of ':version' in the defsystem grammar. +(typically another system), by specifying ‘(:version "other-system" +"1.2.3")’ instead of simply ‘"other-system"’ as the dependency. See the +discussion of the semantics of ‘:version’ in the defsystem grammar. 7.2.1.5 pathname ................ @@ -2497,10 +2604,10 @@ discussion of the semantics of ':version' in the defsystem grammar. This attribute is optional and if absent (which is the usual case), the component name will be used. - *Note Pathname specifiers: The defsystem grammar, for an explanation -of how this attribute is interpreted. + *Note Pathname specifiers::, for an explanation of how this attribute +is interpreted. - Note that the 'defsystem' macro (used to create a "top-level" system) + Note that the ‘defsystem’ macro (used to create a “top-level†system) does additional processing to set the filesystem location of the top component in that system. This is detailed elsewhere. *Note Defining systems with defsystem::. @@ -2528,15 +2635,15 @@ systems with defsystem::. This attribute is optional. Packaging systems often require information about files or systems in -addition to that specified by ASDF's pre-defined component attributes. +addition to that specified by ASDF’s pre-defined component attributes. Programs that create vendor packages out of ASDF systems therefore have -to create "placeholder" information to satisfy these systems. Sometimes +to create “placeholder†information to satisfy these systems. Sometimes the creator of an ASDF system may know the additional information and wish to provide it directly. - '(component-property component property-name)' and associated 'setf' + ‘(component-property component property-name)’ and associated ‘setf’ method will allow the programmatic update of this information. Property -names are compared as if by 'EQL', so use symbols or keywords or +names are compared as if by ‘EQL’, so use symbols or keywords or something. * Menu: @@ -2555,10 +2662,10 @@ File: asdf.info, Node: Pre-defined subclasses of component, Next: Creating new A source file is any file that the system does not know how to generate from other components of the system. - Note that this is not necessarily the same thing as "a file - containing data that is typically fed to a compiler". If a file is - generated by some pre-processor stage (e.g. a '.h' file from - '.h.in' by autoconf) then it is not, by this definition, a source + Note that this is not necessarily the same thing as “a file + containing data that is typically fed to a compilerâ€. If a file is + generated by some pre-processor stage (e.g. a ‘.h’ file from + ‘.h.in’ by autoconf) then it is not, by this definition, a source file. Conversely, we might have a graphic file that cannot be automatically regenerated, or a proprietary shared library that we received as a binary: these do count as source files for our @@ -2573,38 +2680,38 @@ File: asdf.info, Node: Pre-defined subclasses of component, Next: Creating new A module component has the following extra initargs: - * ':components' the components contained in this module + • ‘:components’ the components contained in this module - * ':default-component-class' All children components which don't + • ‘:default-component-class’ All children components which don’t specify their class explicitly are inferred to be of this type. - * ':if-component-dep-fails' This attribute was removed in ASDF - 3. Do not use it. Use ':if-feature' instead (*note - required-features::, and *note if-feature-option::). + • ‘:if-component-dep-fails’ This attribute was removed in ASDF + 3. Do not use it. Use ‘:if-feature’ instead (*note + required-features::, and *note if-feature option::). - * ':serial' When this attribute is set, each subcomponent of + • ‘:serial’ When this attribute is set, each subcomponent of this component is assumed to depend on all subcomponents - before it in the list given to ':components', i.e. all of + before it in the list given to ‘:components’, i.e. all of them are loaded before a compile or load operation is performed on it. The default operation knows how to traverse a module, so most operations will not need to provide methods specialised on modules. - 'module' may be subclassed to represent components such as + ‘module’ may be subclassed to represent components such as foreign-language linked libraries or archive files. -- Component: system - 'system' is a subclass of 'module'. + ‘system’ is a subclass of ‘module’. A system is a module with a few extra attributes for documentation purposes; these are given elsewhere. *Note The defsystem grammar::. Users can create new classes for their systems: the default - 'defsystem' macro takes a ':class' keyword argument. + ‘defsystem’ macro takes a ‘:class’ keyword argument. File: asdf.info, Node: Creating new component types, Prev: Pre-defined subclasses of component, Up: Components @@ -2618,21 +2725,21 @@ component classes and specializing methods on the new component class. As an example, suppose we have some implementation-dependent functionality that we want to isolate in one subdirectory per Lisp implementation our system supports. We create a subclass of -'cl-source-file': +‘cl-source-file’: (defclass unportable-cl-source-file (cl-source-file) ()) - Function 'asdf:implementation-type' (exported since 2.014.14) gives -us the name of the subdirectory. All that's left is to define how to -calculate the pathname of an 'unportable-cl-source-file'. + Function ‘asdf:implementation-type’ (exported since 2.014.14) gives +us the name of the subdirectory. All that’s left is to define how to +calculate the pathname of an ‘unportable-cl-source-file’. (defmethod component-pathname ((component unportable-cl-source-file)) (merge-pathnames* (parse-unix-namestring (format nil "~(~A~)/" (asdf:implementation-type))) (call-next-method))) - The new component type is used in a 'defsystem' form in this way: + The new component type is used in a ‘defsystem’ form in this way: (defsystem :foo :components @@ -2654,26 +2761,26 @@ If, as a user, extender or implementer of ASDF, you introduce a cycle into the dependency graph, ASDF will fail loudly. To clearly distinguish the direction of dependencies, ASDF 3 uses the words _requiring_ and _required_ as applied to an action depending on the -other: the requiring action 'depends-on' the completion of all required -actions before it may itself be 'perform'ed. +other: the requiring action ‘depends-on’ the completion of all required +actions before it may itself be ‘perform’ed. - Using the 'defsystem' syntax, users may easily express direct + Using the ‘defsystem’ syntax, users may easily express direct dependencies along the graph of the object hierarchy: between a component and its parent, its children, and its siblings. By defining custom CLOS methods, you can express more elaborate dependencies as you -wish. Most common operations, such as 'load-op', 'compile-op' or -'load-source-op' are automatically propagate "downward" the component -hierarchy and are "covariant" with it: to act the operation on the +wish. Most common operations, such as ‘load-op’, ‘compile-op’ or +‘load-source-op’ are automatically propagate “downward†the component +hierarchy and are “covariant†with it: to act the operation on the parent module, you must first act it on all the children components, with the action on the parent being parent of the action on each child. -Other operations, such as 'prepare-op' and 'prepare-source-op' -(introduced in ASDF 3) are automatically propagated "upward" the -component hierarchy and are "contravariant" with it: to perform the +Other operations, such as ‘prepare-op’ and ‘prepare-source-op’ +(introduced in ASDF 3) are automatically propagated “upward†the +component hierarchy and are “contravariant†with it: to perform the operation of preparing for compilation of a child component, you must perform the operation of preparing for compilation of its parent -component, and so on, ensuring that all the parent's dependencies are +component, and so on, ensuring that all the parent’s dependencies are (compiled and) loaded before the child component may be compiled and -loaded. Yet other operations, such as 'test-op' or 'load-bundle-op' +loaded. Yet other operations, such as ‘test-op’ or ‘load-bundle-op’ remain at the system level, and are not propagated along the hierarchy, but instead do something global on the system. @@ -2685,29 +2792,28 @@ File: asdf.info, Node: Functions, Prev: Dependencies, Up: The object model of -- Function: version-satisfies VERSION VERSION-SPEC Does VERSION satisfy the VERSION-SPEC. A generic function. ASDF - provides built-in methods for VERSION being a 'component' or - 'string'. VERSION-SPEC should be a string. If it's a component, + provides built-in methods for VERSION being a ‘component’ or + ‘string’. VERSION-SPEC should be a string. If it’s a component, its version is extracted as a string before further processing. A version string satisfies the version-spec if after parsing, the - former is no older than the latter. Therefore '"1.9.1"', '"1.9.2"' - and '"1.10"' all satisfy '"1.9.1"', but '"1.8.4"' or '"1.9"' do - not. For more information about how 'version-satisfies' parses and - interprets version strings and specifications, *note The defsystem - grammar:: (version specifiers) and *note Common attributes of - components::. + former is no older than the latter. Therefore ‘"1.9.1"’, ‘"1.9.2"’ + and ‘"1.10"’ all satisfy ‘"1.9.1"’, but ‘"1.8.4"’ or ‘"1.9"’ do + not. For more information about how ‘version-satisfies’ parses and + interprets version strings and specifications, *note Version + specifiers:: and *note Common attributes of components::. Note that in versions of ASDF prior to 3.0.1, including the entire - ASDF 1 and ASDF 2 series, 'version-satisfies' would also require + ASDF 1 and ASDF 2 series, ‘version-satisfies’ would also require that the version and the version-spec have the same major version number (the first integer in the list); if the major version differed, the version would be considered as not matching the spec. But that feature was not documented, therefore presumably not relied upon, whereas it was a nuisance to several users. Starting - with ASDF 3.0.1, 'version-satisfies' does not treat the major + with ASDF 3.0.1, ‘version-satisfies’ does not treat the major version number specially, and returns T simply if the first - argument designates a version that isn't older than the one - specified as a second argument. If needs be, the '(:version ...)' + argument designates a version that isn’t older than the one + specified as a second argument. If needs be, the ‘(:version ...)’ syntax for specifying dependencies could be in the future extended to specify an exclusive upper bound for compatible versions as well as an inclusive lower bound. @@ -2758,40 +2864,40 @@ Configurations specify paths where to find system files. file, etc. 3. The source registry will be configured from the environment - variable 'CL_SOURCE_REGISTRY' if it exists. + variable ‘CL_SOURCE_REGISTRY’ if it exists. 4. The source registry will be configured from user configuration file - '$XDG_CONFIG_DIRS/common-lisp/source-registry.conf' (which defaults - to '~/.config/common-lisp/source-registry.conf') if it exists. + ‘$XDG_CONFIG_DIRS/common-lisp/source-registry.conf’ (which defaults + to ‘~/.config/common-lisp/source-registry.conf’) if it exists. 5. The source registry will be configured from user configuration - directory '$XDG_CONFIG_DIRS/common-lisp/source-registry.conf.d/' - (which defaults to '~/.config/common-lisp/source-registry.conf.d/') + directory ‘$XDG_CONFIG_DIRS/common-lisp/source-registry.conf.d/’ + (which defaults to ‘~/.config/common-lisp/source-registry.conf.d/’) if it exists. 6. The source registry will be configured from default user - configuration trees '~/common-lisp/' (since ASDF 3.1.2 only), - '~/.sbcl/systems/' (on SBCL only), - '$XDG_DATA_HOME/common-lisp/systems/' (no recursion, link farm) - '$XDG_DATA_HOME/common-lisp/source/'. The 'XDG_DATA_HOME' - directory defaults to '~/.local/share/'. On Windows, the - 'local-appdata' and 'appdata' directories are used instead. + configuration trees ‘~/common-lisp/’ (since ASDF 3.1.2 only), + ‘~/.sbcl/systems/’ (on SBCL only), + ‘$XDG_DATA_HOME/common-lisp/systems/’ (no recursion, link farm) + ‘$XDG_DATA_HOME/common-lisp/source/’. The ‘XDG_DATA_HOME’ + directory defaults to ‘~/.local/share/’. On Windows, the + ‘local-appdata’ and ‘appdata’ directories are used instead. 7. The source registry will be configured from system configuration - file '/etc/common-lisp/source-registry.conf' if it exists. + file ‘/etc/common-lisp/source-registry.conf’ if it exists. 8. The source registry will be configured from system configuration - directory '/etc/common-lisp/source-registry.conf.d/' if it exists. + directory ‘/etc/common-lisp/source-registry.conf.d/’ if it exists. 9. The source registry will be configured from a default configuration. This configuration may allow for implementation-specific systems to be found, for systems to be found the current directory (at the time that the configuration is - initialized) as well as ':directory' entries for - '$XDG_DATA_DIRS/common-lisp/systems/' and ':tree' entries for - '$XDG_DATA_DIRS/common-lisp/source/', where 'XDG_DATA_DIRS' - defaults to '/usr/local/share' and '/usr/share' on Unix, and the - 'common-appdata' directory on Windows. + initialized) as well as ‘:directory’ entries for + ‘$XDG_DATA_DIRS/common-lisp/systems/’ and ‘:tree’ entries for + ‘$XDG_DATA_DIRS/common-lisp/source/’, where ‘XDG_DATA_DIRS’ + defaults to ‘/usr/local/share’ and ‘/usr/share’ on Unix, and the + ‘common-appdata’ directory on Windows. 10. The source registry may include implementation-dependent directories that correspond to implementation-provided extensions. @@ -2816,7 +2922,7 @@ File: asdf.info, Node: Truenames and other dangers, Next: XDG base directory, =============================== One great innovation of the original ASDF was its ability to leverage -'CL:TRUENAME' to locate where your source code was and where to build +‘CL:TRUENAME’ to locate where your source code was and where to build it, allowing for symlink farms as a simple but effective configuration mechanism that is easy to control programmatically. ASDF 3 still supports this configuration style, and it is enabled by default; however @@ -2828,11 +2934,11 @@ users and implementations. slow on their system, or because they are using content-addressed storage where the truename of a file is related to a digest of its individual contents, and not to other files in the same intended -project. For these people, ASDF 3 allows to eschew the 'TRUENAME' -mechanism, by setting the variable ASDF:*RESOLVE-SYMLINKS* to 'nil'. +project. For these people, ASDF 3 allows to eschew the ‘TRUENAME’ +mechanism, by setting the variable ASDF:*RESOLVE-SYMLINKS* to ‘nil’. - PS: Yes, if you haven't read Vernor Vinge's short but great classic -"True Names... and Other Dangers" then you're in for a treat. + PS: Yes, if you haven’t read Vernor Vinge’s short but great classic +“True Names... and Other Dangers†then you’re in for a treat. File: asdf.info, Node: XDG base directory, Next: Backward Compatibility, Prev: Truenames and other dangers, Up: Controlling where ASDF searches for systems @@ -2852,15 +2958,15 @@ variables to customize how applications behave to his preferences. On Windows platforms, even when not using Cygwin, and starting with ASDF 3.1.5, we still do a best effort at following the XDG base -directory specification, even though it doesn't exactly fit common +directory specification, even though it doesn’t exactly fit common practice for Windows applications. However, we replace the fixed Unix -paths '~/.local', '/usr/local' and '/usr' with their rough Windows -equivalent 'Local AppData', 'AppData', 'Common AppData', etc. Since +paths ‘~/.local’, ‘/usr/local’ and ‘/usr’ with their rough Windows +equivalent ‘Local AppData’, ‘AppData’, ‘Common AppData’, etc. Since support for querying the Windows registry is not possible to do in reasonable amounts of portable Common Lisp code, ASDF 3 relies on the environment variables that Windows usually exports, and are hopefully in synch with the Windows registry. If you care about the details, see -'uiop/configuration.lisp' and don't hesitate to suggest improvements. +‘uiop/configuration.lisp’ and don’t hesitate to suggest improvements. File: asdf.info, Node: Backward Compatibility, Next: Configuration DSL, Prev: XDG base directory, Up: Controlling where ASDF searches for systems @@ -2869,16 +2975,16 @@ File: asdf.info, Node: Backward Compatibility, Next: Configuration DSL, Prev: ========================== For backward compatibility as well as to provide a practical backdoor -for hackers, ASDF will first search for '.asd' files in the directories -specified in 'asdf:*central-registry*' before it searches in the source +for hackers, ASDF will first search for ‘.asd’ files in the directories +specified in ‘asdf:*central-registry*’ before it searches in the source registry above. - *Note Configuring ASDF to find your systems -- old style: Configuring + *Note Configuring ASDF to find your systems — old style: Configuring ASDF. - By default, 'asdf:*central-registry*' will be empty. + By default, ‘asdf:*central-registry*’ will be empty. - This old mechanism will therefore not affect you if you don't use it, + This old mechanism will therefore not affect you if you don’t use it, but will take precedence over the new mechanism if you do use it. @@ -2946,7 +3052,7 @@ configuration: Pathnames are designated using another DSL, shared with the output-translations configuration DSL below. The DSL is resolved by the -function 'asdf::resolve-location', to be documented and exported at some +function ‘asdf::resolve-location’, to be documented and exported at some point in the future. ABSOLUTE-COMPONENT-DESIGNATOR := @@ -2997,7 +3103,7 @@ point in the future. The keywords :UID and :USERNAME are no longer supported. For instance, as a simple case, my -'~/.config/common-lisp/source-registry.conf', which is the default place +‘~/.config/common-lisp/source-registry.conf’, which is the default place ASDF looks for this configuration, once contained: (:source-registry (:tree (:home "cl")) ;; will expand to e.g. "/home/joeluser/cl/" @@ -3010,34 +3116,34 @@ File: asdf.info, Node: Configuration Directories, Next: Shell-friendly syntax ============================= Configuration directories consist in files each containing a list of -directives without any enclosing '(:source-registry ...)' form. The -files will be sorted by namestring as if by 'string<' and the lists of +directives without any enclosing ‘(:source-registry ...)’ form. The +files will be sorted by namestring as if by ‘string<’ and the lists of directives of these files with be concatenated in order. An implicit -':inherit-configuration' will be included at the _end_ of the list. +‘:inherit-configuration’ will be included at the _end_ of the list. System-wide or per-user Common Lisp software distributions such as -Debian packages or some future version of 'clbuild' may then include -files such as '/etc/common-lisp/source-registry.conf.d/10-foo.conf' or -'~/.config/common-lisp/source-registry.conf.d/10-foo.conf' to easily and +Debian packages or some future version of ‘clbuild’ may then include +files such as ‘/etc/common-lisp/source-registry.conf.d/10-foo.conf’ or +‘~/.config/common-lisp/source-registry.conf.d/10-foo.conf’ to easily and modularly register configuration information about software being distributed. The convention is that, for sorting purposes, the names of files in such a directory begin with two digits that determine the order in which these entries will be read. Also, the type of these files must be -'.conf', which not only simplifies the implementation by allowing for +‘.conf’, which not only simplifies the implementation by allowing for more portable techniques in finding those files, but also makes it trivial to disable a file, by renaming it to a different file type. Directories may be included by specifying a directory pathname or -namestring in an ':include' directive, e.g.: +namestring in an ‘:include’ directive, e.g.: (:include "/foo/bar/") Hence, to achieve the same effect as my example -'~/.config/common-lisp/source-registry.conf' above, I could simply +‘~/.config/common-lisp/source-registry.conf’ above, I could simply create a file -'~/.config/common-lisp/source-registry.conf.d/33-home-fare-cl.conf' +‘~/.config/common-lisp/source-registry.conf.d/33-home-fare-cl.conf’ alone in its directory with the following contents: (:tree "/home/fare/cl/") @@ -3051,28 +3157,28 @@ File: asdf.info, Node: The here directive, Prev: Configuration Directories, U 8.6.1 The :here directive ------------------------- -The ':here' directive is an absolute pathname designator that refers to +The ‘:here’ directive is an absolute pathname designator that refers to the directory containing the configuration file currently being processed. - The ':here' directive is intended to simplify the delivery of complex + The ‘:here’ directive is intended to simplify the delivery of complex CL systems, and for easy configuration of projects shared through revision control systems, in accordance with our design principle that each participant should be able to provide all and only the information available to him or her. Consider a person X who has set up the source code repository for a -complex project with a master directory 'dir/'. Ordinarily, one might +complex project with a master directory ‘dir/’. Ordinarily, one might simply have the user add a directive that would look something like this: (:tree "path/to/dir") But what if X knows that there are very large subtrees under dir that are filled with, e.g., Java source code, image files for icons, etc.? All of the asdf system definitions are contained in the subdirectories -'dir/src/lisp/' and 'dir/extlib/lisp/', and these are the only +‘dir/src/lisp/’ and ‘dir/extlib/lisp/’, and these are the only directories that should be searched. - In this case, X can put into 'dir/' a file 'asdf.conf' that contains + In this case, X can put into ‘dir/’ a file ‘asdf.conf’ that contains the following: (:source-registry (:tree (:here "src/lisp/")) @@ -3083,10 +3189,10 @@ the following: repository, she need only add (:include "/path/to/my/checkout/directory/asdf.conf") to one of her previously-existing asdf source location configuration -files, or invoke 'initialize-source-registry' with a configuration form +files, or invoke ‘initialize-source-registry’ with a configuration form containing that s-expression. ASDF will find the .conf file that X has provided, and then set up source locations within the working directory -according to X's (relative) instructions. +according to X’s (relative) instructions. File: asdf.info, Node: Shell-friendly syntax for configuration, Next: Search Algorithm, Prev: Configuration Directories, Up: Controlling where ASDF searches for systems @@ -3094,21 +3200,22 @@ File: asdf.info, Node: Shell-friendly syntax for configuration, Next: Search A 8.7 Shell-friendly syntax for configuration =========================================== -When considering environment variable 'CL_SOURCE_REGISTRY' ASDF will -skip to next configuration if it's an empty string. It will 'READ' the -string as a SEXP in the DSL if it begins with a paren '(', otherwise it -will be interpreted much like 'TEXINPUTS', as a list of paths, where +When considering environment variable ‘CL_SOURCE_REGISTRY’ ASDF will +skip to next configuration if it’s an empty string. It will ‘READ’ the +string as a SEXP in the DSL if it begins with a paren ‘(’, otherwise it +will be interpreted much like ‘TEXINPUTS’, as a list of paths, where - * paths are separated by a ':' (colon) on Unix platforms (including -cygwin), by a ';' (semicolon) on other platforms (mainly, Windows). + • paths are separated by a ‘:’ (colon) on Unix platforms (including + cygwin), by a ‘;’ (semicolon) on other platforms (mainly, Windows). - * each entry is a directory to add to the search path. + • each entry is a directory to add to the search path. - * if the entry ends with a double slash '//' then it instead -indicates a tree in the subdirectories of which to recurse. + • if the entry ends with a double slash ‘//’ then it instead + indicates a tree in the subdirectories of which to recurse. - * if the entry is the empty string (which may only appear once), then -it indicates that the inherited configuration should be spliced there. + • if the entry is the empty string (which may only appear once), then + it indicates that the inherited configuration should be spliced + there. File: asdf.info, Node: Search Algorithm, Next: Caching Results, Prev: Shell-friendly syntax for configuration, Up: Controlling where ASDF searches for systems @@ -3116,7 +3223,7 @@ File: asdf.info, Node: Search Algorithm, Next: Caching Results, Prev: Shell-f 8.8 Search Algorithm ==================== -In case that isn't clear, the semantics of the configuration is that +In case that isn’t clear, the semantics of the configuration is that when searching for a system of a given name, directives are processed in order. @@ -3128,20 +3235,20 @@ If multiple systems are found, the consequences are unspecified: the search may succeed with any of the found systems, or an error may be raised. ASDF 3.2.1 or later returns the pathname whose normalized directory component has the shortest length (as a list), and breaks ties -by choosing the system with the smallest 'unix-namestring' when compared -with 'string<'. Earlier versions of ASDF return ASDF return the first +by choosing the system with the smallest ‘unix-namestring’ when compared +with ‘string<’. Earlier versions of ASDF return ASDF return the first system found, which is implementation-dependent, and may or may not be -the pathname with the smallest 'unix-namestring' when compared with -'string<'. XCVB raises an error. If none is found, the search +the pathname with the smallest ‘unix-namestring’ when compared with +‘string<’. XCVB raises an error. If none is found, the search continues. Exclude statements specify patterns of subdirectories the systems -from which to ignore. Typically you don't want to use copies of files +from which to ignore. Typically you don’t want to use copies of files kept by such version control systems as Darcs. Exclude statements are not propagated to further included or inherited configuration files or expressions; instead the defaults are reset around every configuration statement to the default defaults from -'asdf::*default-source-registry-exclusions*'. +‘asdf::*default-source-registry-exclusions*’. Include statements cause the search to recurse with the path specifications from the file specified. @@ -3159,47 +3266,47 @@ File: asdf.info, Node: Caching Results, Next: Configuration API, Prev: Search The implementation is allowed to either eagerly compute the information from the configurations and file system, or to lazily re-compute it every time, or to cache any part of it as it goes. In practice, the -recommended 'source-registry' eagerly collects and caches results and +recommended ‘source-registry’ eagerly collects and caches results and you need to explicitly flush the cache for change to be taken into -account, whereas the old-style '*central-registry*' mechanism queries +account, whereas the old-style ‘*central-registry*’ mechanism queries the filesystem every time. To explicitly flush any information cached by the system after a change was made in the filesystem, *Note Configuration API::, and e.g. -call 'asdf:clear-source-registry'. +call ‘asdf:clear-source-registry’. Starting with ASDF 3.1.4, you can also explicitly build a persistent -cache of the '.asd' files found under a tree: when recursing into a -directory declared by ':tree' and its transitive subdirectories, if a -file '.cl-source-registry.cache' exists containing a form that is a list -starting with ':source-registry-cache' followed by a list of strings, as -in '(:source-registry-cache _"foo/bar.asd" "path/to/more.asd" ..._)', -then the strings are assumed to be 'unix-namestring's designating the +cache of the ‘.asd’ files found under a tree: when recursing into a +directory declared by ‘:tree’ and its transitive subdirectories, if a +file ‘.cl-source-registry.cache’ exists containing a form that is a list +starting with ‘:source-registry-cache’ followed by a list of strings, as +in ‘(:source-registry-cache _"foo/bar.asd" "path/to/more.asd" ..._)’, +then the strings are assumed to be ‘unix-namestring’s designating the available asd files under that tree, and the recursion otherwise stops. The list can also be empty, allowing to stop a costly recursion in a huge directory tree. To update such a cache after you install, update or remove source repositories, you can run a script distributed with ASDF: -'tools/cl-source-registry-cache.lisp _/path/to/directory_'. To wholly +‘tools/cl-source-registry-cache.lisp _/path/to/directory_’. To wholly invalidate the cache, you can delete the file -'.cl-source-registry.cache' in that directory. In either case, for an +‘.cl-source-registry.cache’ in that directory. In either case, for an existing Lisp process to see this change, it needs to clear its own -cache with e.g. '(asdf:clear-source-registry)'. +cache with e.g. ‘(asdf:clear-source-registry)’. Developers may safely create a cache in their development tree, and we recommend they do it at the top of their source tree if it contains more than a small number of files and directories; they only need update -it when they create, remove or move '.asd' files. Software distribution +it when they create, remove or move ‘.asd’ files. Software distribution managers may also safely create such a cache, but they must be careful to update it every time they install, update or remove a software source repository or installation package. Finally, advanced developers who -juggle with a lot of code in their 'source-registry' may manually manage +juggle with a lot of code in their ‘source-registry’ may manually manage such a cache, to allow for faster startup of Lisp programs. This persistence cache can help you reduce startup latency. For instance, on one machine with hundreds of source repositories, such a -cache shaves half a second at the startup of every '#!/usr/bin/cl' +cache shaves half a second at the startup of every ‘#!/usr/bin/cl’ script using SBCL, more on other implementations; this makes a notable difference as to their subjective interactivity and usability. The speedup will only happen if the implementation-provided ASDF is recent @@ -3215,14 +3322,14 @@ File: asdf.info, Node: Configuration API, Next: Introspection, Prev: Caching 8.10 Configuration API ====================== -The specified functions are exported from your build system's package. +The specified functions are exported from your build system’s package. Thus for ASDF the corresponding functions are in package ASDF, and for XCVB the corresponding functions are in package XCVB. -- Function: initialize-source-registry &optional PARAMETER will read the configuration and initialize all internal variables. You may extend or override configuration from the environment and - configuration files with the given PARAMETER, which can be 'nil' + configuration files with the given PARAMETER, which can be ‘nil’ (no configuration override), or a SEXP (in the SEXP DSL), a string (as in the string DSL), a pathname (of a file or directory with configuration), or a symbol (fbound to function that when called @@ -3231,7 +3338,7 @@ XCVB the corresponding functions are in package XCVB. -- Function: clear-source-registry undoes any source registry configuration and clears any cache for the search algorithm. You might want to call this function (or - better, 'clear-configuration') before you dump an image that would + better, ‘clear-configuration’) before you dump an image that would be resumed with a different configuration, and return an empty configuration. Note that this does not include clearing information about systems defined in the current image, only about @@ -3241,12 +3348,12 @@ XCVB the corresponding functions are in package XCVB. checks whether a source registry has been initialized. If not, initialize it with the given PARAMETER. - Every time you use ASDF's 'find-system', or anything that uses it -(such as 'operate', 'load-system', etc.), 'ensure-source-registry' is -called with parameter 'nil', which the first time around causes your + Every time you use ASDF’s ‘find-system’, or anything that uses it +(such as ‘operate’, ‘load-system’, etc.), ‘ensure-source-registry’ is +called with parameter ‘nil’, which the first time around causes your configuration to be read. If you change a configuration file, you need -to explicitly 'initialize-source-registry' again, or maybe simply to -'clear-source-registry' (or 'clear-configuration') which will cause the +to explicitly ‘initialize-source-registry’ again, or maybe simply to +‘clear-source-registry’ (or ‘clear-configuration’) which will cause the initialization to happen next time around. @@ -3266,11 +3373,11 @@ File: asdf.info, Node: *source-registry-parameter* variable, Next: Information 8.11.1 *source-registry-parameter* variable ------------------------------------------- -We have made available the variable '*source-registry-parameter*' that +We have made available the variable ‘*source-registry-parameter*’ that can be used by code that wishes to introspect about the (past) -configuration of ASDF's source registry. *This variable should never be +configuration of ASDF’s source registry. *This variable should never be set!* It will be set as a side-effect of calling -'initialize-source-registry'; user code should treat it as read-only. +‘initialize-source-registry’; user code should treat it as read-only. File: asdf.info, Node: Information about system dependencies, Prev: *source-registry-parameter* variable, Up: Introspection @@ -3292,7 +3399,7 @@ analyses. ASDF can find them; failure to find such systems does _not_ cause an error in loading. - Note that the return value for 'system-weakly-depends-on' is + Note that the return value for ‘system-weakly-depends-on’ is simpler than the return values of the other two system dependency introspection functions. @@ -3303,9 +3410,9 @@ File: asdf.info, Node: Status, Next: Rejected ideas, Prev: Introspection, Up =========== This mechanism is vastly successful, and we have declared that -'asdf:*central-registry*' is not recommended anymore, though we will +‘asdf:*central-registry*’ is not recommended anymore, though we will continue to support it. All hooks into implementation-specific search -mechanisms have been integrated in the 'wrapping-source-registry' that +mechanisms have been integrated in the ‘wrapping-source-registry’ that everyone uses implicitly. @@ -3317,49 +3424,49 @@ File: asdf.info, Node: Rejected ideas, Next: TODO, Prev: Status, Up: Control Alternatives I (FRR) considered and rejected while developing ASDF 2 included: - 1. Keep 'asdf:*central-registry*' as the master with its current + 1. Keep ‘asdf:*central-registry*’ as the master with its current semantics, and somehow the configuration parser expands the new configuration language into a expanded series of directories of subdirectories to lookup, pre-recursing through specified hierarchies. This is kludgy, and leaves little space of future cleanups and extensions. - 2. Keep 'asdf:*central-registry*' as the master but extend its + 2. Keep ‘asdf:*central-registry*’ as the master but extend its semantics in completely new ways, so that new kinds of entries may be implemented as a recursive search, etc. This seems somewhat backwards. - 3. Completely remove 'asdf:*central-registry*' and break backwards + 3. Completely remove ‘asdf:*central-registry*’ and break backwards compatibility. Hopefully this will happen in a few years after everyone migrate to a better ASDF and/or to XCVB, but it would be very bad to do it now. - 4. Replace 'asdf:*central-registry*' by a symbol-macro with + 4. Replace ‘asdf:*central-registry*’ by a symbol-macro with appropriate magic when you dereference it or setf it. Only the new variable with new semantics is handled by the new search procedure. Complex and still introduces subtle semantic issues. - I've been suggested the below features, but have rejected them, for + I’ve been suggested the below features, but have rejected them, for the sake of keeping ASDF no more complex than strictly necessary. - * More syntactic sugar: synonyms for the configuration directives, - such as '(:add-directory X)' for '(:directory X)', or - '(:add-directory-hierarchy X)' or '(:add-directory X :recurse t)' - for '(:tree X)'. + • More syntactic sugar: synonyms for the configuration directives, + such as ‘(:add-directory X)’ for ‘(:directory X)’, or + ‘(:add-directory-hierarchy X)’ or ‘(:add-directory X :recurse t)’ + for ‘(:tree X)’. - * The possibility to register individual files instead of + • The possibility to register individual files instead of directories. - * Integrate Xach Beane's tilde expander into the parser, or something - similar that is shell-friendly or shell-compatible. I'd rather + • Integrate Xach Beane’s tilde expander into the parser, or something + similar that is shell-friendly or shell-compatible. I’d rather keep ASDF minimal. But maybe this precisely keeps it minimal by removing the need for evaluated entries that ASDF has? i.e. uses - of 'USER-HOMEDIR-PATHNAME' and '$SBCL_HOME' Hopefully, these are - already superseded by the ':default-registry' + of ‘USER-HOMEDIR-PATHNAME’ and ‘$SBCL_HOME’ Hopefully, these are + already superseded by the ‘:default-registry’ - * Using the shell-unfriendly syntax '/**' instead of TEXINPUTS-like - '//' to specify recursion down a filesystem tree in the environment - variable. It isn't that Lisp friendly either. + • Using the shell-unfriendly syntax ‘/**’ instead of TEXINPUTS-like + ‘//’ to specify recursion down a filesystem tree in the environment + variable. It isn’t that Lisp friendly either. File: asdf.info, Node: TODO, Next: Credits for the source-registry, Prev: Rejected ideas, Up: Controlling where ASDF searches for systems @@ -3367,7 +3474,7 @@ File: asdf.info, Node: TODO, Next: Credits for the source-registry, Prev: Rej 8.14 TODO ========= - * Add examples + • Add examples File: asdf.info, Node: Credits for the source-registry, Prev: TODO, Up: Controlling where ASDF searches for systems @@ -3382,7 +3489,7 @@ Thanks a lot to Stelian Ionescu for the initial idea. All bad design ideas and implementation bugs are mine, not theirs. But so are good design ideas and elegant implementation tricks. - -- Francois-Rene Rideau <fare@tunes.org>, Mon, 22 Feb 2010 00:07:33 + — Francois-Rene Rideau <fare@tunes.org>, Mon, 22 Feb 2010 00:07:33 -0500 @@ -3393,8 +3500,8 @@ File: asdf.info, Node: Controlling where ASDF saves compiled files, Next: Erro Each Common Lisp implementation has its own format for compiled files or fasls.(1) If you use multiple implementations (or multiple versions of -the same implementation), you'll soon find your source directories -littered with various 'fasl's, 'dfsl's, 'cfsl's and so on. Worse yet, +the same implementation), you’ll soon find your source directories +littered with various ‘fasl’s, ‘dfsl’s, ‘cfsl’s and so on. Worse yet, multiple implementations use the same file extension and some implementations maintain the same file extension while changing formats from version to version (or platform to platform). This can lead to @@ -3403,7 +3510,7 @@ the next. Finally, this requires write access to the source directory, and therefore precludes sharing of a same source code directory between multiple users. - Since ASDF 2, ASDF includes the 'asdf-output-translations' facility + Since ASDF 2, ASDF includes the ‘asdf-output-translations’ facility to mitigate the problem. * Menu: @@ -3420,7 +3527,7 @@ to mitigate the problem. ---------- Footnotes ---------- - (1) "FASL" is short for "FASt Loading." + (1) “FASL†is short for “FASt Loading.†File: asdf.info, Node: Output Configurations, Next: Output Backward Compatibility, Prev: Controlling where ASDF saves compiled files, Up: Controlling where ASDF saves compiled files @@ -3445,25 +3552,25 @@ searches for systems. command-line, from a script, from its own configuration file, etc. 3. The source registry will be configured from the environment - variable 'ASDF_OUTPUT_TRANSLATIONS' if it exists. + variable ‘ASDF_OUTPUT_TRANSLATIONS’ if it exists. 4. The source registry will be configured from user configuration file - '$XDG_CONFIG_DIRS/common-lisp/asdf-output-translations.conf' (which - defaults to '~/.config/common-lisp/asdf-output-translations.conf') + ‘$XDG_CONFIG_DIRS/common-lisp/asdf-output-translations.conf’ (which + defaults to ‘~/.config/common-lisp/asdf-output-translations.conf’) if it exists. 5. The source registry will be configured from user configuration directory - '$XDG_CONFIG_DIRS/common-lisp/asdf-output-translations.conf.d/' + ‘$XDG_CONFIG_DIRS/common-lisp/asdf-output-translations.conf.d/’ (which defaults to - '~/.config/common-lisp/asdf-output-translations.conf.d/') if it + ‘~/.config/common-lisp/asdf-output-translations.conf.d/’) if it exists. 6. The source registry will be configured from system configuration - file '/etc/common-lisp/asdf-output-translations.conf' if it exists. + file ‘/etc/common-lisp/asdf-output-translations.conf’ if it exists. 7. The source registry will be configured from system configuration - directory '/etc/common-lisp/asdf-output-translations.conf.d/' if it + directory ‘/etc/common-lisp/asdf-output-translations.conf.d/’ if it exists. Each of these configurations is specified as a SEXP in a trivial @@ -3484,7 +3591,7 @@ familiar with output-translations first.(1) ---------- Footnotes ---------- - (1) A 'CLEAN-OP' would be a partial solution to this problem. + (1) A ‘CLEAN-OP’ would be a partial solution to this problem. File: asdf.info, Node: Output Backward Compatibility, Next: Output Configuration DSL, Prev: Output Configurations, Up: Controlling where ASDF saves compiled files @@ -3493,50 +3600,50 @@ File: asdf.info, Node: Output Backward Compatibility, Next: Output Configurati ========================== We purposely do _not_ provide backward compatibility with earlier -versions of 'ASDF-Binary-Locations' (8 Sept 2009), -'common-lisp-controller' (7.0) or 'cl-launch' (2.35), each of which had +versions of ‘ASDF-Binary-Locations’ (8 Sept 2009), +‘common-lisp-controller’ (7.0) or ‘cl-launch’ (2.35), each of which had similar general capabilities. The APIs of these programs were not designed for easy user configuration through configuration files. -Recent versions of 'common-lisp-controller' (7.2) and 'cl-launch' -(3.000) use the new 'asdf-output-translations' API as defined below. -'ASDF-Binary-Locations' is fully superseded and not to be used anymore. +Recent versions of ‘common-lisp-controller’ (7.2) and ‘cl-launch’ +(3.000) use the new ‘asdf-output-translations’ API as defined below. +‘ASDF-Binary-Locations’ is fully superseded and not to be used anymore. - This incompatibility shouldn't inconvenience many people. Indeed, + This incompatibility shouldn’t inconvenience many people. Indeed, few people use and customize these packages; these few people are experts who can trivially adapt to the new configuration. Most people are not experts, could not properly configure these features (except -inasmuch as the default configuration of 'common-lisp-controller' and/or -'cl-launch' might have been doing the right thing for some users), and -yet will experience software that "just works", as configured by the +inasmuch as the default configuration of ‘common-lisp-controller’ and/or +‘cl-launch’ might have been doing the right thing for some users), and +yet will experience software that “just worksâ€, as configured by the system distributor, or by default. - Nevertheless, if you are a fan of 'ASDF-Binary-Locations', we provide + Nevertheless, if you are a fan of ‘ASDF-Binary-Locations’, we provide a limited emulation mode: -- Function: enable-asdf-binary-locations-compatibility &key centralize-lisp-binaries default-toplevel-directory include-per-user-information map-all-source-files source-to-target-mappings - This function will initialize the new 'asdf-output-translations' + This function will initialize the new ‘asdf-output-translations’ facility in a way that emulates the behaviour of the old - 'ASDF-Binary-Locations' facility. Where you would previously set + ‘ASDF-Binary-Locations’ facility. Where you would previously set global variables *CENTRALIZE-LISP-BINARIES*, *DEFAULT-TOPLEVEL-DIRECTORY*, *INCLUDE-PER-USER-INFORMATION*, *MAP-ALL-SOURCE-FILES* or *SOURCE-TO-TARGET-MAPPINGS* you will now have to pass the same values as keyword arguments to this function. - Note however that as an extension the ':source-to-target-mappings' + Note however that as an extension the ‘:source-to-target-mappings’ keyword argument will accept any valid pathname designator for - 'asdf-output-translations' instead of just strings and pathnames. + ‘asdf-output-translations’ instead of just strings and pathnames. If you insist, you can also keep using the old -'ASDF-Binary-Locations' (the one available as an extension to load of +‘ASDF-Binary-Locations’ (the one available as an extension to load of top of ASDF, not the one built into a few old versions of ASDF), but -first you must disable 'asdf-output-translations' with -'(asdf:disable-output-translations)', or you might experience -"interesting" issues. +first you must disable ‘asdf-output-translations’ with +‘(asdf:disable-output-translations)’, or you might experience +“interesting†issues. Also, note that output translation is enabled by default. To disable -it, use '(asdf:disable-output-translations)'. +it, use ‘(asdf:disable-output-translations)’. File: asdf.info, Node: Output Configuration DSL, Next: Output Configuration Directories, Prev: Output Backward Compatibility, Up: Controlling where ASDF saves compiled files @@ -3544,7 +3651,7 @@ File: asdf.info, Node: Output Configuration DSL, Next: Output Configuration Di 9.3 Configuration DSL ===================== -Here is the grammar of the SEXP DSL for 'asdf-output-translations' +Here is the grammar of the SEXP DSL for ‘asdf-output-translations’ configuration: ;; A configuration is single SEXP starting with keyword :source-registry @@ -3601,32 +3708,32 @@ TRANSLATION-FUNCTION := the path before them, or bust. The last component, if not a pathname, is notionally completed by -'/**/*.*'. You can specify more fine-grained patterns by using a +‘/**/*.*’. You can specify more fine-grained patterns by using a pathname object as the last component e.g. -'#p"some/path/**/foo*/bar-*.fasl"' +‘#p"some/path/**/foo*/bar-*.fasl"’ - You may use '#+features' to customize the configuration file. + You may use ‘#+features’ to customize the configuration file. - The second designator of a mapping may be 'nil', indicating that + The second designator of a mapping may be ‘nil’, indicating that files are not mapped to anything but themselves (same as if the second designator was the same as the first). - When the first designator is 't', the mapping always matches. When -the first designator starts with ':root', the mapping matches any host -and device. In either of these cases, if the second designator isn't -'t' and doesn't start with ':root', then strings indicating the host and + When the first designator is ‘t’, the mapping always matches. When +the first designator starts with ‘:root’, the mapping matches any host +and device. In either of these cases, if the second designator isn’t +‘t’ and doesn’t start with ‘:root’, then strings indicating the host and pathname are somehow copied in the beginning of the directory component of the source pathname before it is translated. - When the second designator is 't', the mapping is the identity. When -the second designator starts with ':root', the mapping preserves the + When the second designator is ‘t’, the mapping is the identity. When +the second designator starts with ‘:root’, the mapping preserves the host and device of the original pathname. Notably, this allows you to map files to a subdirectory of the whichever directory the file is in. -Though the syntax is not quite as easy to use as we'd like, you can have +Though the syntax is not quite as easy to use as we’d like, you can have an (source destination) mapping entry such as follows in your configuration file, or you may use -'enable-asdf-binary-locations-compatibility' with -':centralize-lisp-binaries nil' which will do the same thing internally +‘enable-asdf-binary-locations-compatibility’ with +‘:centralize-lisp-binaries nil’ which will do the same thing internally for you: #.(let ((wild-subdir (make-pathname :directory '(:relative :wild-inferiors))) @@ -3634,33 +3741,33 @@ for you: (make-pathname :name :wild :version :wild :type :wild))) `((:root ,wild-subdir ,wild-file) (:root ,wild-subdir :implementation ,wild-file))) - Starting with ASDF 2.011.4, you can use the simpler: '`(:root (:root -:**/ :implementation :*.*.*))' + Starting with ASDF 2.011.4, you can use the simpler: ‘`(:root (:root +:**/ :implementation :*.*.*))’ - ':include' statements cause the search to recurse with the path + ‘:include’ statements cause the search to recurse with the path specifications from the file specified. - If the 'translate-pathname' mechanism cannot achieve a desired + If the ‘translate-pathname’ mechanism cannot achieve a desired translation, the user may provide a function which provides the required algorithm. Such a translation function is specified by supplying a list -as the second 'directory-designator' the first element of which is the -keyword ':function', and the second element of which is either a symbol +as the second ‘directory-designator’ the first element of which is the +keyword ‘:function’, and the second element of which is either a symbol which designates a function or a lambda expression. The function designated by the second argument must take two arguments, the first being the pathname of the source file, the second being the wildcard that was matched. When invoked, the function should return the translated pathname. - An ':inherit-configuration' statement causes the search to recurse + An ‘:inherit-configuration’ statement causes the search to recurse with the path specifications from the next configuration in the bulleted list. *Note Configurations: Controlling where ASDF saves compiled files, above. - * ':enable-user-cache' is the same as '(t :user-cache)'. - * ':disable-cache' is the same as '(t t)'. - * ':user-cache' uses the contents of variable 'asdf::*user-cache*' - which by default is the same as using '(:home ".cache" - "common-lisp" :implementation)'. + • ‘:enable-user-cache’ is the same as ‘(t :user-cache)’. + • ‘:disable-cache’ is the same as ‘(t t)’. + • ‘:user-cache’ uses the contents of variable ‘asdf::*user-cache*’ + which by default is the same as using ‘(:home ".cache" + "common-lisp" :implementation)’. File: asdf.info, Node: Output Configuration Directories, Next: Output Shell-friendly syntax for configuration, Prev: Output Configuration DSL, Up: Controlling where ASDF saves compiled files @@ -3669,29 +3776,29 @@ File: asdf.info, Node: Output Configuration Directories, Next: Output Shell-fr ============================= Configuration directories consist of files, each of which contains a -list of directives without any enclosing '(:output-translations ...)' -form. The files will be sorted by namestring as if by 'string<' and the +list of directives without any enclosing ‘(:output-translations ...)’ +form. The files will be sorted by namestring as if by ‘string<’ and the lists of directives of these files with be concatenated in order. An -implicit ':inherit-configuration' will be included at the _end_ of the +implicit ‘:inherit-configuration’ will be included at the _end_ of the list. System-wide or per-user Common Lisp software distributions such as -Debian packages or some future version of 'clbuild' may then include +Debian packages or some future version of ‘clbuild’ may then include files such as -'/etc/common-lisp/asdf-output-translations.conf.d/10-foo.conf' or -'~/.config/common-lisp/asdf-output-translations.conf.d/10-foo.conf' to +‘/etc/common-lisp/asdf-output-translations.conf.d/10-foo.conf’ or +‘~/.config/common-lisp/asdf-output-translations.conf.d/10-foo.conf’ to easily and modularly register configuration information about software being distributed. The convention is that, for sorting purposes, the names of files in such a directory begin with two digits that determine the order in which these entries will be read. Also, the type of these files must be -'.conf', which not only simplifies the implementation by allowing for +‘.conf’, which not only simplifies the implementation by allowing for more portable techniques in finding those files, but also makes it trivial to disable a file, by renaming it to a different file type. Directories may be included by specifying a directory pathname or -namestring in an ':include' directive, e.g.: +namestring in an ‘:include’ directive, e.g.: (:include "/foo/bar/") @@ -3701,16 +3808,16 @@ File: asdf.info, Node: Output Shell-friendly syntax for configuration, Next: S 9.5 Shell-friendly syntax for configuration =========================================== -When processing the environment variable 'ASDF_OUTPUT_TRANSLATIONS': - * ASDF will skip to the next configuration if it's an empty string. - * ASDF will 'READ' the string as an SEXP in the DSL, if it begins - with a parenthesis '('. - * Otherwise ASDF will interpret the value as a list of directories +When processing the environment variable ‘ASDF_OUTPUT_TRANSLATIONS’: + • ASDF will skip to the next configuration if it’s an empty string. + • ASDF will ‘READ’ the string as an SEXP in the DSL, if it begins + with a parenthesis ‘(’. + • Otherwise ASDF will interpret the value as a list of directories (see below). In the directory list format, directories should come in pairs, each -pair indicating a mapping directive. Entries are separated by a ':' -(colon) on Unix platforms (including Mac and cygwin), and by a ';' +pair indicating a mapping directive. Entries are separated by a ‘:’ +(colon) on Unix platforms (including Mac and cygwin), and by a ‘;’ (semicolon) on other platforms (mainly, Windows). The magic empty entry, if it comes in what would otherwise be the @@ -3720,10 +3827,10 @@ second entry in a pair is empty, it indicates that the directory in the first entry is to be left untranslated (which has the same effect as if the directory had been repeated). - For example, '"/foo:/bar::/baz:"' means: specify that outputs for -things under directory '/foo/' are translated to be under '/bar/'; then + For example, ‘"/foo:/bar::/baz:"’ means: specify that outputs for +things under directory ‘/foo/’ are translated to be under ‘/bar/’; then include the inherited configuration; then specify that outputs for -things under directory '/baz/' are not translated. +things under directory ‘/baz/’ are not translated. File: asdf.info, Node: Semantics of Output Translations, Next: Output Caching Results, Prev: Output Shell-friendly syntax for configuration, Up: Controlling where ASDF saves compiled files @@ -3777,7 +3884,7 @@ The specified functions are exported from package ASDF. -- Function: initialize-output-translations &optional PARAMETER will read the configuration and initialize all internal variables. You may extend or override configuration from the environment and - configuration files with the given PARAMETER, which can be 'nil' + configuration files with the given PARAMETER, which can be ‘nil’ (no configuration override), or a SEXP (in the SEXP DSL), a string (as in the string DSL), a pathname (of a file or directory with configuration), or a symbol (fbound to function that when called @@ -3791,7 +3898,7 @@ The specified functions are exported from package ASDF. -- Function: clear-output-translations undoes any output translation configuration and clears any cache for the mapping algorithm. You might want to call this function - (or better, 'clear-configuration') before you dump an image that + (or better, ‘clear-configuration’) before you dump an image that would be resumed with a different configuration, and return an empty configuration. Note that this does not include clearing information about systems defined in the current image, only about @@ -3804,15 +3911,15 @@ The specified functions are exported from package ASDF. -- Function: apply-output-translations PATHNAME Applies the configured output location translations to PATHNAME - (calls 'ensure-output-translations' for the translations). + (calls ‘ensure-output-translations’ for the translations). - Every time you use ASDF's 'output-files', or anything that uses it -(that may compile, such as 'operate', 'perform', etc.), -'ensure-output-translations' is called with parameter 'nil', which the + Every time you use ASDF’s ‘output-files’, or anything that uses it +(that may compile, such as ‘operate’, ‘perform’, etc.), +‘ensure-output-translations’ is called with parameter ‘nil’, which the first time around causes your configuration to be read. If you change a configuration file, you need to explicitly -'initialize-output-translations' again, or maybe -'clear-output-translations' (or 'clear-configuration'), which will cause +‘initialize-output-translations’ again, or maybe +‘clear-output-translations’ (or ‘clear-configuration’), which will cause the initialization to happen next time around. @@ -3821,13 +3928,13 @@ File: asdf.info, Node: Credits for output translations, Prev: Output location 9.9 Credits for output translations =================================== -Thanks a lot to Peter van Eynde for 'Common Lisp Controller' and to -Bjorn Lindberg and Gary King for 'ASDF-Binary-Locations'. +Thanks a lot to Peter van Eynde for ‘Common Lisp Controller’ and to +Bjorn Lindberg and Gary King for ‘ASDF-Binary-Locations’. All bad design ideas and implementation bugs are to mine, not theirs. But so are good design ideas and elegant implementation tricks. - -- Francois-Rene Rideau <fare@tunes.org> + — Francois-Rene Rideau <fare@tunes.org> File: asdf.info, Node: Error handling, Next: Miscellaneous additional functionality, Prev: Controlling where ASDF saves compiled files, Up: Top @@ -3839,11 +3946,11 @@ File: asdf.info, Node: Error handling, Next: Miscellaneous additional function ================ If ASDF detects an incorrect system definition, it will signal a -generalised instance of 'SYSTEM-DEFINITION-ERROR'. +generalised instance of ‘system-definition-error’. Operations may go wrong (for example when source files contain errors). These are signalled using generalised instances of -'OPERATION-ERROR'. +‘operation-error’. 10.2 Compilation error and warning handling =========================================== @@ -3851,8 +3958,8 @@ errors). These are signalled using generalised instances of ASDF checks for warnings and errors when a file is compiled. The variables *COMPILE-FILE-WARNINGS-BEHAVIOUR* and *COMPILE-FILE-FAILURE-BEHAVIOUR* control the handling of any such -events. The valid values for these variables are ':error', ':warn', and -':ignore'. +events. The valid values for these variables are ‘:error’, ‘:warn’, and +‘:ignore’. File: asdf.info, Node: Miscellaneous additional functionality, Next: Getting the latest version, Prev: Error handling, Up: Top @@ -3877,37 +3984,37 @@ File: asdf.info, Node: Controlling file compilation, Next: Controlling source ================================= When declaring a component (system, module, file), you can specify a -keyword argument ':around-compile function'. If left unspecified (and +keyword argument ‘:around-compile function’. If left unspecified (and therefore unbound), the value will be inherited from the parent -component if any, or with a default of 'nil' if no value is specified in +component if any, or with a default of ‘nil’ if no value is specified in any transitive parent. - The argument must be either 'nil', an fbound symbol, a -lambda-expression (e.g. '(lambda (thunk) ...(funcall thunk ...) ...)') -a function object (e.g. using '#.#'' but that's discouraged because it + The argument must be either ‘nil’, an fbound symbol, a +lambda-expression (e.g. ‘(lambda (thunk) ...(funcall thunk ...) ...)’) +a function object (e.g. using ‘#.#'’ but that’s discouraged because it prevents the introspection done by e.g. asdf-dependency-grovel), or a -string that when 'read' yields a symbol or a lambda-expression. 'nil' +string that when ‘read’ yields a symbol or a lambda-expression. ‘nil’ means the normal compile-file function will be called. A non-nil value designates a function of one argument that will be called with a -function that will invoke 'compile-file*' with various arguments; the +function that will invoke ‘compile-file*’ with various arguments; the around-compile hook may supply additional keyword arguments to pass to -that call to 'compile-file*'. +that call to ‘compile-file*’. - One notable argument that is heeded by 'compile-file*' is -':compile-check', a function called when the compilation was otherwise a -success, with the same arguments as 'compile-file'; the function shall + One notable argument that is heeded by ‘compile-file*’ is +‘:compile-check’, a function called when the compilation was otherwise a +success, with the same arguments as ‘compile-file’; the function shall return true if the compilation and its resulting compiled file respected -all system-specific invariants, and false ('nil') if it broke any of +all system-specific invariants, and false (‘nil’) if it broke any of those invariants; it may issue warnings or errors before it returns -'nil'. (NB: The ability to pass such extra flags is only available +‘nil’. (NB: The ability to pass such extra flags is only available starting with ASDF 2.22.3.) This feature is notably exercised by asdf-finalizers. By using a string, you may reference a function, symbol and/or -package that will only be created later during the build, but isn't yet +package that will only be created later during the build, but isn’t yet present at the time the defsystem form is evaluated. However, if your entire system is using such a hook, you may have to explicitly override -the hook with 'nil' for all the modules and files that are compiled +the hook with ‘nil’ for all the modules and files that are compiled before the hook is defined. Using this hook, you may achieve such effects as: locally renaming @@ -3922,12 +4029,12 @@ compile-time side-effects were properly balanced, etc. Note that there is no around-load hook. This is on purpose. Some implementations such as ECL, GCL or MKCL link object files, which allows for no such hook. Other implementations allow for concatenating FASL -files, which doesn't allow for such a hook either. We aim to discourage -something that's not portable, and has some dubious impact on +files, which doesn’t allow for such a hook either. We aim to discourage +something that’s not portable, and has some dubious impact on performance and semantics even when it is possible. Things you might want to do with an around-load hook are better done around-compile, though it may at times require some creativity (see e.g. the -'package-renaming' system). +‘package-renaming’ system). File: asdf.info, Node: Controlling source file character encoding, Next: Miscellaneous Functions, Prev: Controlling file compilation, Up: Miscellaneous additional functionality @@ -3935,116 +4042,116 @@ File: asdf.info, Node: Controlling source file character encoding, Next: Misce 11.2 Controlling source file character encoding =============================================== -Starting with ASDF 2.21, components accept a ':encoding' option so +Starting with ASDF 2.21, components accept a ‘:encoding’ option so authors may specify which character encoding should be used to read and evaluate their source code. When left unspecified, the encoding is inherited from the parent module or system; if no encoding is specified -at any point, or if 'nil' is explicitly specified, an extensible +at any point, or if ‘nil’ is explicitly specified, an extensible protocol described below is followed, that ultimately defaults to -':utf-8' since ASDF 3. +‘:utf-8’ since ASDF 3. The protocol to determine the encoding is to call the function -'detect-encoding', which itself, if provided a valid file, calls the +‘detect-encoding’, which itself, if provided a valid file, calls the function specified by *ENCODING-DETECTION-HOOK*, or else defaults to the *DEFAULT-ENCODING*. The *ENCODING-DETECTION-HOOK* is by default bound -to function 'always-default-encoding', that always returns the contents -of *DEFAULT-ENCODING*. *DEFAULT-ENCODING* is bound to ':utf-8' by -default (before ASDF 3, the default was ':default'). +to function ‘always-default-encoding’, that always returns the contents +of *DEFAULT-ENCODING*. *DEFAULT-ENCODING* is bound to ‘:utf-8’ by +default (before ASDF 3, the default was ‘:default’). Whichever encoding is returned must be a portable keyword, that will be translated to an implementation-specific external-format designator -by function 'encoding-external-format', which itself simply calls the +by function ‘encoding-external-format’, which itself simply calls the function specified *ENCODING-EXTERNAL-FORMAT-HOOK*; that function by -default is 'default-encoding-external-format', that only recognizes -':utf-8' and ':default', and translates the former to the +default is ‘default-encoding-external-format’, that only recognizes +‘:utf-8’ and ‘:default’, and translates the former to the implementation-dependent *UTF-8-EXTERNAL-FORMAT*, and the latter to itself (that itself is portable but has an implementation-dependent meaning). In other words, there now are plenty of extension hooks, but by default ASDF enforces the previous _de facto_ standard behaviour of -using ':utf-8', independently from whatever configuration the user may -be using. Thus, system authors can now rely on ':utf-8' being used +using ‘:utf-8’, independently from whatever configuration the user may +be using. Thus, system authors can now rely on ‘:utf-8’ being used while compiling their files, even if the user is currently using -':koi8-r' or ':euc-jp' as their interactive encoding. (Before ASDF 3, -there was no such guarantee, ':default' was used, and only plain ASCII +‘:koi8-r’ or ‘:euc-jp’ as their interactive encoding. (Before ASDF 3, +there was no such guarantee, ‘:default’ was used, and only plain ASCII was safe to include in source code.) Some legacy implementations only support 8-bit characters, and some implementations provide 8-bit only variants. On these implementations, -the *UTF-8-EXTERNAL-FORMAT* gracefully falls back to ':default', and +the *UTF-8-EXTERNAL-FORMAT* gracefully falls back to ‘:default’, and Unicode characters will be read as multi-character mojibake. To detect -such situations, UIOP will push the ':asdf-unicode' feature on +such situations, UIOP will push the ‘:asdf-unicode’ feature on implementations that support Unicode, and you can use -reader-conditionalization to protect any ':encoding _encoding_' -statement, as in '#+asdf-unicode :encoding #+asdf-unicode :utf-8'. We -recommend that you avoid using unprotected ':encoding' specifications +reader-conditionalization to protect any ‘:encoding _encoding_’ +statement, as in ‘#+asdf-unicode :encoding #+asdf-unicode :utf-8’. We +recommend that you avoid using unprotected ‘:encoding’ specifications until after ASDF 2.21 or later becomes widespread. As of May 2016, all maintained implementations provide ASDF 3.1, so you may prudently start using this and other features without such protection. While it offers plenty of hooks for extension, and one such extension -is available (see 'asdf-encodings' below), ASDF itself only recognizes -one encoding beside ':default', and that is ':utf-8', which is the _de +is available (see ‘asdf-encodings’ below), ASDF itself only recognizes +one encoding beside ‘:default’, and that is ‘:utf-8’, which is the _de facto_ standard, already used by the vast majority of libraries that use more than ASCII. On implementations that do not support unicode, the -feature ':asdf-unicode' is absent, and the ':default' external-format is -used to read even source files declared as ':utf-8'. On these +feature ‘:asdf-unicode’ is absent, and the ‘:default’ external-format is +used to read even source files declared as ‘:utf-8’. On these implementations, non-ASCII characters intended to be read as one CL character may thus end up being read as multiple CL characters. In most -cases, this shouldn't affect the software's semantics: comments will be +cases, this shouldn’t affect the software’s semantics: comments will be skipped just the same, strings with be read and printed with slightly different lengths, symbol names will be accordingly longer, but none of it should matter. But a few systems that actually depend on unicode characters may fail to work properly, or may work in a subtly different -way. See for instance 'lambda-reader'. +way. See for instance ‘lambda-reader’. We invite you to embrace UTF-8 as the encoding for non-ASCII characters starting today, even without any explicit specification in -your '.asd' files. Indeed, on some implementations and configurations, -UTF-8 is already the ':default', and loading your code may cause errors +your ‘.asd’ files. Indeed, on some implementations and configurations, +UTF-8 is already the ‘:default’, and loading your code may cause errors if it is encoded in anything but UTF-8. Therefore, even with the legacy behaviour, non-UTF-8 is guaranteed to break for some users, whereas UTF-8 is pretty much guaranteed not to break anywhere (provided you do _not_ use a BOM), although it might be read incorrectly on some -implementations. ':utf-8' has been the default value of -'*default-encoding*' since ASDF 3. +implementations. ‘:utf-8’ has been the default value of +‘*default-encoding*’ since ASDF 3. If you need non-standard character encodings for your source code, -use the extension system 'asdf-encodings', by specifying -':defsystem-depends-on ("asdf-encodings")' in your 'defsystem'. This +use the extension system ‘asdf-encodings’, by specifying +‘:defsystem-depends-on ("asdf-encodings")’ in your ‘defsystem’. This extension system will register support for more encodings using the -'*encoding-external-format-hook*' facility, so you can explicitly -specify ':encoding :latin1' in your '.asd' file. Using the -'*encoding-detection-hook*' it will also eventually implement some -autodetection of a file's encoding from an emacs-style '-*- mode: lisp ; -coding: latin1 -*-' declaration, or otherwise based on an analysis of -octet patterns in the file. At this point, 'asdf-encoding' only +‘*encoding-external-format-hook*’ facility, so you can explicitly +specify ‘:encoding :latin1’ in your ‘.asd’ file. Using the +‘*encoding-detection-hook*’ it will also eventually implement some +autodetection of a file’s encoding from an emacs-style ‘-*- mode: lisp ; +coding: latin1 -*-’ declaration, or otherwise based on an analysis of +octet patterns in the file. At this point, ‘asdf-encoding’ only supports the encodings that are supported as part of your implementation. Since the list varies depending on implementations, we -still recommend you use ':utf-8' everywhere, which is the most portable -(next to it is ':latin1'). +still recommend you use ‘:utf-8’ everywhere, which is the most portable +(next to it is ‘:latin1’). - Recent versions of Quicklisp include 'asdf-encodings'; if you're not -using it, you may get this extension using git: 'git clone -https://gitlab.common-lisp.net/asdf/asdf-encodings.git' or 'git clone -git@gitlab.common-lisp.net:asdf/asdf-encodings.git'. You can also + Recent versions of Quicklisp include ‘asdf-encodings’; if you’re not +using it, you may get this extension using git: ‘git clone +https://gitlab.common-lisp.net/asdf/asdf-encodings.git’ or ‘git clone +git@gitlab.common-lisp.net:asdf/asdf-encodings.git’. You can also browse the repository on <https://gitlab.common-lisp.net/asdf/asdf-encodings>. - When you use 'asdf-encodings', any '.asd' file loaded will use the + When you use ‘asdf-encodings’, any ‘.asd’ file loaded will use the autodetection algorithm to determine its encoding. If you depend on -this detection happening, you should explicitly load 'asdf-encodings' -early in your build. Note that ':defsystem-depends-on' cannot be used -here: by the time the ':defsystem-depends-on' is loaded, the enclosing -'defsystem' form has already been read. +this detection happening, you should explicitly load ‘asdf-encodings’ +early in your build. Note that ‘:defsystem-depends-on’ cannot be used +here: by the time the ‘:defsystem-depends-on’ is loaded, the enclosing +‘defsystem’ form has already been read. - In practice, this means that the '*default-encoding*' is usually used -for '.asd' files. Currently, this defaults to ':utf-8', and you should + In practice, this means that the ‘*default-encoding*’ is usually used +for ‘.asd’ files. Currently, this defaults to ‘:utf-8’, and you should be safe using Unicode characters in those files. This might matter, for -instance, in meta-data about author's names. Otherwise, the main data -in these files is component (path)names, and we don't recommend using -non-ASCII characters for these, for the result probably isn't very +instance, in meta-data about author’s names. Otherwise, the main data +in these files is component (path)names, and we don’t recommend using +non-ASCII characters for these, for the result probably isn’t very portable. @@ -4057,16 +4164,16 @@ These functions are exported by ASDF for your convenience. -- Function: system-relative-pathname system name &key type - It's often handy to locate a file relative to some system. The - 'system-relative-pathname' function meets this need. + It’s often handy to locate a file relative to some system. The + ‘system-relative-pathname’ function meets this need. It takes two mandatory arguments SYSTEM and NAME and a keyword argument TYPE: SYSTEM is name of a system, whereas NAME and optionally TYPE specify a relative pathname, interpreted like a - component pathname specifier by 'coerce-pathname'. *Note Pathname - specifiers: The defsystem grammar. + component pathname specifier by ‘coerce-pathname’. *Note Pathname + specifiers::. - It returns a pathname built from the location of the system's + It returns a pathname built from the location of the system’s source directory and the relative pathname. For example: > (asdf:system-relative-pathname 'cl-ppcre "regex.data") @@ -4077,17 +4184,17 @@ These functions are exported by ASDF for your convenience. ASDF does not provide a turnkey solution for locating data (or other miscellaneous) files that are distributed together with the source code of a system. Programmers can use - 'system-source-directory' to find such files. Returns a pathname + ‘system-source-directory’ to find such files. Returns a pathname object. The SYSTEM-DESIGNATOR may be a string, symbol, or ASDF system object. -- Function: clear-system system-designator It is sometimes useful to force recompilation of a previously - loaded system. For these cases, '(asdf:clear-system :foo)' will + loaded system. For these cases, ‘(asdf:clear-system :foo)’ will remove the system from the table of currently loaded systems: the - next time the system 'foo' or one that depends on it is re-loaded, - 'foo' will be loaded again.(1) + next time the system ‘foo’ or one that depends on it is re-loaded, + ‘foo’ will be loaded again.(1) Note that this does not and cannot undo the previous loading of the system. Common Lisp has no provision for such an operation, and @@ -4100,52 +4207,52 @@ These functions are exported by ASDF for your convenience. It is up to the user to make sure that reloading is possible and has the desired effect. In some cases, extreme measures such as recursively deleting packages, unregistering symbols, defining - methods on 'update-instance-for-redefined-class' and much more are + methods on ‘update-instance-for-redefined-class’ and much more are necessary for reloading to happen smoothly. ASDF itself goes to extensive effort to make a hot upgrade possible with respect to its own code. If you want, you can reuse some of its utilities such as - 'uiop:define-package' and 'uiop:with-upgradability', and get - inspiration (or disinspiration) from what it does in 'header.lisp' - and 'upgrade.lisp'. + ‘uiop:define-package’ and ‘uiop:with-upgradability’, and get + inspiration (or disinspiration) from what it does in ‘header.lisp’ + and ‘upgrade.lisp’. -- Function: register-preloaded-system name &rest keys &key version &allow-other-keys - A system with name NAME, created by 'make-instance' with extra keys - KEYS (e.g. ':version'), is registered as _preloaded_. If VERSION - is 't' (default), then the version is copied from the defined - system of the same name (if registered) or else is 'nil' (this + A system with name NAME, created by ‘make-instance’ with extra keys + KEYS (e.g. ‘:version’), is registered as _preloaded_. If VERSION + is ‘t’ (default), then the version is copied from the defined + system of the same name (if registered) or else is ‘nil’ (this automatic copy of version is only available starting since ASDF 3.1.8). A preloaded system is considered as having already been loaded into the current image, and if at some point some other system - ':depends-on' it yet no source code is found, it is considered as - already provided, and ASDF will not raise a 'missing-component' + ‘:depends-on’ it yet no source code is found, it is considered as + already provided, and ASDF will not raise a ‘missing-component’ error. This function is particularly useful if you distribute your code as - fasls with either 'compile-bundle-op' or - 'monolithic-compile-bundle-op', and want to register systems so - that dependencies will work uniformly whether you're using your + fasls with either ‘compile-bundle-op’ or + ‘monolithic-compile-bundle-op’, and want to register systems so + that dependencies will work uniformly whether you’re using your software from source or from fasl. Note that if the system was already defined or loaded from source code, its build information will remain active until you call - 'clear-system' on it, at which point a system without build + ‘clear-system’ on it, at which point a system without build information will be registered in its place. -- Function: register-immutable-system name &rest keys A system with name NAME is registered as preloaded, and additionally is marked as _immutable_: that is, attempts to compile or load it will be succeed without actually reading, creating or - loading any file, as if the system was passed as a 'force-not' - argument to all calls to 'plan' or 'operate'. There will be no - search for an updated '.asd' file to override the loaded version, + loading any file, as if the system was passed as a ‘force-not’ + argument to all calls to ‘plan’ or ‘operate’. There will be no + search for an updated ‘.asd’ file to override the loaded version, whether from the source-register or any other method. - If a VERSION keyword argument is specified as 't' or left + If a VERSION keyword argument is specified as ‘t’ or left unspecified, then the version is copied from the defined system of - the same name (if registered) or else is 'nil'. This automatic + the same name (if registered) or else is ‘nil’. This automatic copy of version is available starting since immutable systems have been available in ASDF 3.1.5. @@ -4154,24 +4261,24 @@ These functions are exported by ASDF for your convenience. want to allow users to extend the image with further extension systems, but without making thousands of filesystem requests looking for inexistent (or worse, out of date) source code for all - the systems that came bundled with the image but aren't distributed + the systems that came bundled with the image but aren’t distributed as source code to regular users. -- Function: run-shell-command control-string &rest args This function is obsolete and present only for the sake of - backwards-compatibility: "If it's not backwards, it's not - compatible". We _strongly_ discourage its use. Its current + backwards-compatibility: “If it’s not backwards, it’s not + compatibleâ€. We _strongly_ discourage its use. Its current behaviour is only well-defined on Unix platforms (which include MacOS X and cygwin). On Windows, anything goes. The following documentation is only for the purpose of your migrating away from it in a way that preserves semantics. - Instead we recommend the use 'run-program', described in the next + Instead we recommend the use ‘run-program’, described in the next section, and available as part of ASDF since ASDF 3. - 'run-shell-command' takes as arguments a format 'control-string' - and arguments to be passed to 'format' after this control-string to + ‘run-shell-command’ takes as arguments a format ‘control-string’ + and arguments to be passed to ‘format’ after this control-string to produce a string. This string is a command that will be evaluated with a POSIX shell if possible; yet, on Windows, some implementations will use CMD.EXE, while others (like SBCL) will @@ -4180,7 +4287,7 @@ These functions are exported by ASDF for your convenience. ---------- Footnotes ---------- - (1) Alternatively, you could touch 'foo.asd' or remove the + (1) Alternatively, you could touch ‘foo.asd’ or remove the corresponding fasls from the output file cache. @@ -4193,7 +4300,7 @@ The below functions are not exported by ASDF itself, but by UIOP, available since ASDF 3. Some of them have precursors in ASDF 2, but we recommend that for active developments, you should rely on the package UIOP as included in ASDF 3. UIOP provides many, many more utility -functions, and we recommend you read its 'README.md' and sources for +functions, and we recommend you read its ‘README.md’ and sources for more information. -- Function: parse-unix-namestring name &key type defaults dot-dot @@ -4204,51 +4311,51 @@ more information. on non-Unix systems it is only usable for relative pathnames. In order to manipulate relative pathnames portably, it is crucial to possess a portable pathname syntax independent of the underlying - OS. This is what 'parse-unix-namestring' provides, and why we use + OS. This is what ‘parse-unix-namestring’ provides, and why we use it in ASDF. - When given a 'pathname' object, just return it untouched. When - given 'nil', just return 'nil'. When given a non-null 'symbol', + When given a ‘pathname’ object, just return it untouched. When + given ‘nil’, just return ‘nil’. When given a non-null ‘symbol’, first downcase its name and treat it as a string. When given a - 'string', portably decompose it into a pathname as below. - - '#\/' separates directory components. - - The last '#\/'-separated substring is interpreted as follows: 1- If - TYPE is ':directory' or ENSURE-DIRECTORY is true, the string is - made the last directory component, and its 'name' and 'type' are - 'nil'. if the string is empty, it's the empty pathname with all - slots 'nil'. 2- If TYPE is 'nil', the substring is a - file-namestring, and its 'name' and 'type' are separated by - 'split-name-type'. 3- If TYPE is a string, it is the given 'type', - and the whole string is the 'name'. - - Directory components with an empty name the name '.' are removed. - Any directory named '..' is read as DOT-DOT, which must be one of - ':back' or ':up' and defaults to ':back'. - - 'host', 'device' and 'version' components are taken from DEFAULTS, - which itself defaults to '*nil-pathname*'. '*nil-pathname*' is - also used if DEFAULTS is 'nil'. No host or device can be specified + ‘string’, portably decompose it into a pathname as below. + + ‘#\/’ separates directory components. + + The last ‘#\/’-separated substring is interpreted as follows: 1- If + TYPE is ‘:directory’ or ENSURE-DIRECTORY is true, the string is + made the last directory component, and its ‘name’ and ‘type’ are + ‘nil’. if the string is empty, it’s the empty pathname with all + slots ‘nil’. 2- If TYPE is ‘nil’, the substring is a + file-namestring, and its ‘name’ and ‘type’ are separated by + ‘split-name-type’. 3- If TYPE is a string, it is the given ‘type’, + and the whole string is the ‘name’. + + Directory components with an empty name the name ‘.’ are removed. + Any directory named ‘..’ is read as DOT-DOT, which must be one of + ‘:back’ or ‘:up’ and defaults to ‘:back’. + + ‘host’, ‘device’ and ‘version’ components are taken from DEFAULTS, + which itself defaults to ‘*nil-pathname*’. ‘*nil-pathname*’ is + also used if DEFAULTS is ‘nil’. No host or device can be specified in the string itself, which makes it unsuitable for absolute pathnames outside Unix. For relative pathnames, these components (and hence the defaults) - won't matter if you use 'merge-pathnames*' but will matter if you - use 'merge-pathnames', which is an important reason to always use - 'merge-pathnames*'. + won’t matter if you use ‘merge-pathnames*’ but will matter if you + use ‘merge-pathnames’, which is an important reason to always use + ‘merge-pathnames*’. Arbitrary keys are accepted, and the parse result is passed to - 'ensure-pathname' with those keys, removing TYPE, DEFAULTS and - DOT-DOT. When you're manipulating pathnames that are supposed to + ‘ensure-pathname’ with those keys, removing TYPE, DEFAULTS and + DOT-DOT. When you’re manipulating pathnames that are supposed to make sense portably even though the OS may not be Unixish, we - recommend you use ':want-relative t' so that - 'parse-unix-namestring' will throw an error if the pathname is + recommend you use ‘:want-relative t’ so that + ‘parse-unix-namestring’ will throw an error if the pathname is absolute. -- Function: merge-pathnames* specified &optional defaults - This function is a replacement for 'merge-pathnames' that uses the + This function is a replacement for ‘merge-pathnames’ that uses the host and device from the DEFAULTS rather than the SPECIFIED pathname when the latter is a relative pathname. This allows ASDF and its users to create and use relative pathnames without having @@ -4258,70 +4365,70 @@ more information. -- Function: subpathname pathname subpath &key type This function takes a PATHNAME and a SUBPATH and a TYPE. If - SUBPATH is already a 'pathname' object (not namestring), and is an + SUBPATH is already a ‘pathname’ object (not namestring), and is an absolute pathname at that, it is returned unchanged; otherwise, SUBPATH is turned into a relative pathname with given TYPE as per - 'parse-unix-namestring' with ':want-relative t :type 'TYPE, then it - is merged with the 'pathname-directory-pathname' of PATHNAME, as - per 'merge-pathnames*'. + ‘parse-unix-namestring’ with ‘:want-relative t :type ’TYPE, then it + is merged with the ‘pathname-directory-pathname’ of PATHNAME, as + per ‘merge-pathnames*’. We strongly encourage the use of this function for portably resolving relative pathnames in your code base. -- Function: subpathname* pathname subpath &key type - This function returns 'nil' if the base PATHNAME is 'nil', - otherwise acts like 'subpathname'. + This function returns ‘nil’ if the base PATHNAME is ‘nil’, + otherwise acts like ‘subpathname’. -- Function: run-program command &key ignore-error-status force-shell input output error-output if-input-does-not-exist if-output-exists if-error-output-exists element-type external-format &allow-other-keys - 'run-program' takes a COMMAND argument that is either a list of a + ‘run-program’ takes a COMMAND argument that is either a list of a program name or path and its arguments, or a string to be executed by a shell. It spawns the command, waits for it to return, verifies that it exited cleanly (unless told not too below), and optionally captures and processes its output. It accepts many keyword arguments to configure its behaviour. - 'run-program' returns three values: the first for the output, the + ‘run-program’ returns three values: the first for the output, the second for the error-output, and the third for the return value. - (Beware that before ASDF 3.0.2.11, it didn't handle input or + (Beware that before ASDF 3.0.2.11, it didn’t handle input or error-output, and returned only one value, the one for the output if any handler was specified, or else the exit code; please upgrade ASDF, or at least UIOP, to rely on the new enhanced behaviour.) OUTPUT is its most important argument; it specifies how the output - is captured and processed. If it is 'nil', then the output is + is captured and processed. If it is ‘nil’, then the output is redirected to the null device, that will discard it. If it is - ':interactive', then it is inherited from the current process + ‘:interactive’, then it is inherited from the current process (beware: this may be different from your *STANDARD-OUTPUT*, and - under SLIME will be on your '*inferior-lisp*' buffer). If it is - 't', output goes to your current *STANDARD-OUTPUT* stream. + under SLIME will be on your ‘*inferior-lisp*’ buffer). If it is + ‘t’, output goes to your current *STANDARD-OUTPUT* stream. Otherwise, OUTPUT should be a value that is a suitable first - argument to 'slurp-input-stream' (see below), or a list of such a - value and keyword arguments. In this case, 'run-program' will + argument to ‘slurp-input-stream’ (see below), or a list of such a + value and keyword arguments. In this case, ‘run-program’ will create a temporary stream for the program output; the program output, in that stream, will be processed by a call to - 'slurp-input-stream', using OUTPUT as the first argument (or if - it's a list the first element of OUTPUT and the rest as keywords). - The primary value resulting from that call (or 'nil' if no call was - needed) will be the first value returned by 'run-program'. E.g., - using ':output :string' will have it return the entire output - stream as a string. And using ':output '(:string :stripped t)' + ‘slurp-input-stream’, using OUTPUT as the first argument (or if + it’s a list the first element of OUTPUT and the rest as keywords). + The primary value resulting from that call (or ‘nil’ if no call was + needed) will be the first value returned by ‘run-program’. E.g., + using ‘:output :string’ will have it return the entire output + stream as a string. And using ‘:output '(:string :stripped t)’ will have it return the same string stripped of any ending newline. ERROR-OUTPUT is similar to OUTPUT, except that the resulting value - is returned as the second value of 'run-program'. 't' designates - the *ERROR-OUTPUT*. Also ':output' means redirecting the error - output to the output stream, in which case 'nil' is returned. + is returned as the second value of ‘run-program’. ‘t’ designates + the *ERROR-OUTPUT*. Also ‘:output’ means redirecting the error + output to the output stream, in which case ‘nil’ is returned. - INPUT is similar to OUTPUT, except that 'vomit-output-stream' is - used, no value is returned, and 't' designates the + INPUT is similar to OUTPUT, except that ‘vomit-output-stream’ is + used, no value is returned, and ‘t’ designates the *STANDARD-INPUT*. - 'element-type' and 'external-format' are passed on to your Lisp + ‘element-type’ and ‘external-format’ are passed on to your Lisp implementation, when applicable, for creation of the output stream. One and only one of the stream slurping or vomiting may or may not @@ -4330,68 +4437,68 @@ more information. processing. Other streams are completely produced or consumed before or after the subprocess is spawned, using temporary files. - 'force-shell' forces evaluation of the command through a shell, + ‘force-shell’ forces evaluation of the command through a shell, even if it was passed as a list rather than a string. If a shell - is used, it is '/bin/sh' on Unix or 'CMD.EXE' on Windows, except on + is used, it is ‘/bin/sh’ on Unix or ‘CMD.EXE’ on Windows, except on implementations that (erroneously, IMNSHO) insist on consulting - '$SHELL' like clisp. + ‘$SHELL’ like clisp. - 'ignore-error-status' causes 'run-program' to not raise an error if + ‘ignore-error-status’ causes ‘run-program’ to not raise an error if the spawned program exits in error. Following POSIX convention, an error is anything but a normal exit with status code zero. By - default, an error of type 'subprocess-error' is raised in this + default, an error of type ‘subprocess-error’ is raised in this case. - 'run-program' works on all platforms supported by ASDF, except + ‘run-program’ works on all platforms supported by ASDF, except Genera. See the source code for more documentation. -- Function: slurp-input-stream processor input-stream &key - 'slurp-input-stream' is a generic function of two arguments, a + ‘slurp-input-stream’ is a generic function of two arguments, a target object and an input stream, and accepting keyword arguments. Predefined methods based on the target object are as follows: - * If the object is a function, the function is called with the + • If the object is a function, the function is called with the stream as argument. - * If the object is a cons, its first element is applied to its + • If the object is a cons, its first element is applied to its rest appended by a list of the input stream. - * If the object is an output stream, the contents of the input + • If the object is an output stream, the contents of the input stream are copied to it. If the LINEWISE keyword argument is provided, copying happens line by line, and an optional PREFIX is printed before each line. Otherwise, copying happen based on a buffer of size BUFFER-SIZE, using the specified ELEMENT-TYPE. - * If the object is ''string' or ':string', the content is + • If the object is ‘'string’ or ‘:string’, the content is captured into a string. Accepted keywords include the ELEMENT-TYPE and a flag STRIPPED, which when true causes any - single line ending to be removed as per 'uiop:stripln'. + single line ending to be removed as per ‘uiop:stripln’. - * If the object is ':lines', the content is captured as a list + • If the object is ‘:lines’, the content is captured as a list of strings, one per line, without line ending. If the COUNT keyword argument is provided, it is a maximum count of lines to be read. - * If the object is ':line', the content is captured as with - ':lines' above, and then its sub-object is extracted with the - AT argument, which defaults to '0', extracting the first line. + • If the object is ‘:line’, the content is captured as with + ‘:lines’ above, and then its sub-object is extracted with the + AT argument, which defaults to ‘0’, extracting the first line. A number will extract the corresponding line. See the - documentation for 'uiop:access-at'. + documentation for ‘uiop:access-at’. - * If the object is ':forms', the content is captured as a list + • If the object is ‘:forms’, the content is captured as a list of s-expressions, as read by the Lisp reader. If the COUNT argument is provided, it is a maximum count of lines to be read. We recommend you control the syntax with such macro as - 'uiop:with-safe-io-syntax'. + ‘uiop:with-safe-io-syntax’. - * If the object is ':form', the content is captured as with - ':forms' above, and then its sub-object is extracted with the - AT argument, which defaults to '0', extracting the first form. + • If the object is ‘:form’, the content is captured as with + ‘:forms’ above, and then its sub-object is extracted with the + AT argument, which defaults to ‘0’, extracting the first form. A number will extract the corresponding form. See the - documentation for 'uiop:access-at'. We recommend you control - the syntax with such macro as 'uiop:with-safe-io-syntax'. + documentation for ‘uiop:access-at’. We recommend you control + the syntax with such macro as ‘uiop:with-safe-io-syntax’. File: asdf.info, Node: Getting the latest version, Next: FAQ, Prev: Miscellaneous additional functionality, Up: Top @@ -4399,17 +4506,17 @@ File: asdf.info, Node: Getting the latest version, Next: FAQ, Prev: Miscellan 12 Getting the latest version ***************************** -Decide which version you want. The 'master' branch is where development -happens; its 'HEAD' is usually OK, including the latest fixes and +Decide which version you want. The ‘master’ branch is where development +happens; its ‘HEAD’ is usually OK, including the latest fixes and portability tweaks, but an occasional regression may happen despite our (limited) test suite. - The 'release' branch is what cautious people should be using; it has + The ‘release’ branch is what cautious people should be using; it has usually been tested more, and releases are cut at a point where there -isn't any known unresolved issue. +isn’t any known unresolved issue. - You may get the ASDF source repository using git: 'git clone -https://gitlab.common-lisp.net/asdf/asdf.git' + You may get the ASDF source repository using git: ‘git clone +https://gitlab.common-lisp.net/asdf/asdf.git’ You will find the above referenced tags in this repository. You can also browse the repository on @@ -4437,12 +4544,12 @@ File: asdf.info, Node: FAQ, Next: Ongoing Work, Prev: Getting the latest vers File: asdf.info, Node: Where do I report a bug?, Next: Mailing list, Prev: FAQ, Up: FAQ -13.1 "Where do I report a bug?" +13.1 “Where do I report a bug?†=============================== ASDF bugs are tracked on launchpad: <https://launchpad.net/asdf>. - If you're unsure about whether something is a bug, or for general + If you’re unsure about whether something is a bug, or for general discussion, use the asdf-devel mailing list (*note Mailing list::). @@ -4452,13 +4559,13 @@ File: asdf.info, Node: Mailing list, Next: What has changed between ASDF 1 ASD ================= Discussion of ASDF development is conducted on the mailing list -'asdf-devel@common-lisp.net'. +‘asdf-devel@common-lisp.net’. <http://common-lisp.net/cgi-bin/mailman/listinfo/asdf-devel> File: asdf.info, Node: What has changed between ASDF 1 ASDF 2 and ASDF 3?, Next: Issues with installing the proper version of ASDF, Prev: Mailing list, Up: FAQ -13.3 "What has changed between ASDF 1, ASDF 2, and ASDF 3?" +13.3 “What has changed between ASDF 1, ASDF 2, and ASDF 3?†=========================================================== We released ASDF 2.000 on May 31st 2010, ASDF 3.0.0 on May 15th 2013, @@ -4474,17 +4581,17 @@ maintained. or replacing its ASDF module). For this reason, we have stopped supporting ASDF 1 and ASDF 2. If you are using ASDF 1 or ASDF 2 and are experiencing any kind of issues or limitations, we recommend you upgrade -to ASDF 3 -- and we explain how to do that. *Note Loading ASDF::. +to ASDF 3 — and we explain how to do that. *Note Loading ASDF::. Note that in the context of compatibility requirements, ASDF 2.27, released on Feb 1st 2013, and further releases up to 2.33, count as -pre-releases of ASDF 3, and define the ':asdf3' feature, though the +pre-releases of ASDF 3, and define the ‘:asdf3’ feature, though the first stable release of ASDF 3 was release 3.0.1. Significant new or -improved functionality were added in ASDF 3.1; the ':asdf3.1' feature is +improved functionality were added in ASDF 3.1; the ‘:asdf3.1’ feature is present in recent enough versions to detect this functionality; the -first stable release since then was ASDF 3.1.2. New '*features*' are +first stable release since then was ASDF 3.1.2. New ‘*features*’ are only added at major milestones, and the next one will probably be -':asdf3.2'. +‘:asdf3.2’. * Menu: @@ -4510,8 +4617,8 @@ File: asdf.info, Node: What are ASDF 1 2 3?, Next: How do I detect the ASDF ve ASDF 1 refers to any release earlier than 1.369 or so (from August 2001 to October 2009), and to any development revision earlier than 2.000 -(May 2010). If your copy of ASDF doesn't even contain version -information, it's an old ASDF 1. Revisions between 1.656 and 1.728 may +(May 2010). If your copy of ASDF doesn’t even contain version +information, it’s an old ASDF 1. Revisions between 1.656 and 1.728 may count as development releases for ASDF 2. ASDF 2 refers to releases from 2.000 (May 31st 2010) to 2.26 (Oct @@ -4530,20 +4637,20 @@ File: asdf.info, Node: How do I detect the ASDF version?, Next: ASDF can porta 13.3.2 How do I detect the ASDF version? ---------------------------------------- -All releases of ASDF push ':asdf' onto '*features*'. Releases starting -with ASDF 2 push ':asdf2' onto '*features*'. Releases starting with -ASDF 3 (including 2.27 and later pre-releases) push ':asdf3' onto -'*features*'. Furthermore, releases starting with ASDF 3.1.2 (May +All releases of ASDF push ‘:asdf’ onto ‘*features*’. Releases starting +with ASDF 2 push ‘:asdf2’ onto ‘*features*’. Releases starting with +ASDF 3 (including 2.27 and later pre-releases) push ‘:asdf3’ onto +‘*features*’. Furthermore, releases starting with ASDF 3.1.2 (May 2014), though they count as ASDF 3, include enough progress that they -also push ':asdf3.1' onto '*features*'. You may depend on the presence +also push ‘:asdf3.1’ onto ‘*features*’. You may depend on the presence or absence of these features to write code that takes advantage of recent ASDF functionality but still works on older versions, or at least detects the old version and signals an error. Additionally, all releases starting with ASDF 2 define a function -'(asdf:asdf-version)' you may use to query the version. All releases +‘(asdf:asdf-version)’ you may use to query the version. All releases starting with 2.013 display the version number prominently on the second -line of the 'asdf.lisp' source file. +line of the ‘asdf.lisp’ source file. If you are experiencing problems or limitations of any sort with ASDF 1 or ASDF 2, we recommend that you should upgrade to the latest release, @@ -4565,10 +4672,10 @@ very old ones: (when m (princ "." s))))) (null "1.0")))) - If it returns 'nil' then ASDF is not installed. Otherwise it should -return a string. If it returns '"1.0"', then it can actually be any + If it returns ‘nil’ then ASDF is not installed. Otherwise it should +return a string. If it returns ‘"1.0"’, then it can actually be any version before 1.77 or so, or some buggy variant of 1.x. If it returns -anything older than '"3.0.1"', you really need to upgrade your +anything older than ‘"3.0.1"’, you really need to upgrade your implementation or at least upgrade its ASDF. *Note Replacing your implementation's ASDF::. @@ -4583,24 +4690,24 @@ pathname namestrings, that themselves have various limitations and require a lot of setup that is itself ultimately non-portable. In ASDF 1, the only portable ways to refer to pathnames inside -systems and components were very awkward, using '#.(make-pathname ...)' -and '#.(merge-pathnames ...)'. Even the above were themselves were +systems and components were very awkward, using ‘#.(make-pathname ...)’ +and ‘#.(merge-pathnames ...)’. Even the above were themselves were inadequate in the general case due to host and device issues, unless horribly complex patterns were used. Plenty of simple cases that looked -portable actually weren't, leading to much confusion and greavance. +portable actually weren’t, leading to much confusion and greavance. ASDF 2 implements its own portable syntax for strings as pathname specifiers. Naming files within a system definition becomes easy and portable again. *Note system-relative-pathname: Miscellaneous -additional functionality, 'merge-pathnames*', 'coerce-pathname'. +additional functionality, ‘merge-pathnames*’, ‘coerce-pathname’. On the other hand, there are places where systems used to accept namestrings where you must now use an explicit pathname object: -'(defsystem ... :pathname "LOGICAL-HOST:PATH;TO;SYSTEM;" ...)' must now -be written with the '#p' syntax: '(defsystem ... :pathname -#p"LOGICAL-HOST:PATH;TO;SYSTEM;" ...)' +‘(defsystem ... :pathname "LOGICAL-HOST:PATH;TO;SYSTEM;" ...)’ must now +be written with the ‘#p’ syntax: ‘(defsystem ... :pathname +#p"LOGICAL-HOST:PATH;TO;SYSTEM;" ...)’ - *Note Pathname specifiers: The defsystem grammar. + *Note Pathname specifiers::. File: asdf.info, Node: Output translations, Next: Source Registry Configuration, Prev: ASDF can portably name files in subdirectories, Up: What has changed between ASDF 1 ASDF 2 and ASDF 3? @@ -4609,7 +4716,7 @@ File: asdf.info, Node: Output translations, Next: Source Registry Configuratio -------------------------- A popular feature added to ASDF was output pathname translation: -'asdf-binary-locations', 'common-lisp-controller', 'cl-launch' and other +‘asdf-binary-locations’, ‘common-lisp-controller’, ‘cl-launch’ and other hacks were all implementing it in ways both mutually incompatible and difficult to configure. @@ -4619,7 +4726,7 @@ or source directories of shared installations of systems across multiple users, or combinations of the above. In ASDF 2, a standard mechanism is provided for that, -'asdf-output-translations', with sensible defaults, adequate +‘asdf-output-translations’, with sensible defaults, adequate configuration languages, a coherent set of configuration files and hooks, and support for non-Unix platforms. @@ -4644,7 +4751,7 @@ by distributions. sensible defaults, adequate configuration languages, and a coherent set of configuration files and hooks. - We believe it's a vast improvement because it decouples application + We believe it’s a vast improvement because it decouples application distribution from library distribution. The application writer can avoid thinking where the libraries are, and the library distributor (dpkg, clbuild, advanced user, etc.) can configure them once and for @@ -4652,8 +4759,8 @@ every application. Yet settings can be easily overridden where needed, so whoever needs control has exactly as much as required. At the same time, ASDF 2 remains compatible with the old magic you -may have in your build scripts (using '*central-registry*' and -'*system-definition-search-functions*') to tailor the ASDF configuration +may have in your build scripts (using ‘*central-registry*’ and +‘*system-definition-search-functions*’) to tailor the ASDF configuration to your build automation needs, and also allows for new magic, simpler and more powerful magic. @@ -4665,12 +4772,12 @@ File: asdf.info, Node: Usual operations are made easier to the user, Next: Man 13.3.6 Usual operations are made easier to the user --------------------------------------------------- -In ASDF 1, you had to use the awkward syntax '(asdf:oos 'asdf:load-op -:foo)' to load a system, and similarly for 'compile-op', 'test-op'. +In ASDF 1, you had to use the awkward syntax ‘(asdf:oos 'asdf:load-op +:foo)’ to load a system, and similarly for ‘compile-op’, ‘test-op’. In ASDF 2, you can use shortcuts for the usual operations: -'(asdf:load-system :foo)', and similarly for 'compile-system', -'test-system'. +‘(asdf:load-system :foo)’, and similarly for ‘compile-system’, +‘test-system’. File: asdf.info, Node: Many bugs have been fixed, Next: ASDF itself is versioned, Prev: Usual operations are made easier to the user, Up: What has changed between ASDF 1 ASDF 2 and ASDF 3? @@ -4680,35 +4787,35 @@ File: asdf.info, Node: Many bugs have been fixed, Next: ASDF itself is version The following issues and many others have been fixed: - * The infamous TRAVERSE function has been revamped completely between + • The infamous TRAVERSE function has been revamped completely between ASDF 1 and ASDF 2, with many bugs squashed. In particular, dependencies were not correctly propagated across modules but now are. It has been completely rewritten many times over between ASDF 2.000 and ASDF 3, with fundamental issues in the original model being fixed. Timestamps were not propagated at all, and now are. The internal model of how actions depend on each other is now both - consistent and complete. The ':version' and the ':force (system1 - .. systemN)' feature have been fixed. + consistent and complete. The ‘:version’ and the ‘:force (system1 + .. systemN)’ feature have been fixed. - * Performance has been notably improved for large systems (say with + • Performance has been notably improved for large systems (say with thousands of components) by using hash-tables instead of linear search, and linear-time list accumulation instead of cubic time recursive append, for an overall _O(n)_ complexity vs _O(n^4)_. - * Many features used to not be portable, especially where pathnames + • Many features used to not be portable, especially where pathnames were involved. Windows support was notably quirky because of such non-portability. - * The internal test suite used to massively fail on many + • The internal test suite used to massively fail on many implementations. While still incomplete, it now fully passes on all implementations supported by the test suite, though some tests are commented out on a few implementations. - * Support was lacking for some implementations. ABCL and GCL were + • Support was lacking for some implementations. ABCL and GCL were notably wholly broken. ECL extensions were not integrated with ASDF release. - * The documentation was grossly out of date. + • The documentation was grossly out of date. File: asdf.info, Node: ASDF itself is versioned, Next: ASDF can be upgraded, Prev: Many bugs have been fixed, Up: What has changed between ASDF 1 ASDF 2 and ASDF 3? @@ -4724,8 +4831,8 @@ available and worked, or take great pains to have the correct version of ASDF installed. With ASDF 2, we provide a new stable set of working features that -everyone can rely on from now on. Use '#+asdf2' to detect presence of -ASDF 2, '(asdf:version-satisfies (asdf:asdf-version) "2.345.67")' to +everyone can rely on from now on. Use ‘#+asdf2’ to detect presence of +ASDF 2, ‘(asdf:version-satisfies (asdf:asdf-version) "2.345.67")’ to check the availability of a version no earlier than required. @@ -4737,7 +4844,7 @@ File: asdf.info, Node: ASDF can be upgraded, Next: Decoupled release cycle, P When an old version of ASDF was loaded, it was very hard to upgrade ASDF in your current image without breaking everything. Instead you had to exit the Lisp process and somehow arrange to start a new one from a -simpler image. Something that can't be done from within Lisp, making +simpler image. Something that can’t be done from within Lisp, making automation of it difficult, which compounded with difficulty in configuration, made the task quite hard. Yet as we saw before, the task would have been required to not have to live with the worst case or @@ -4763,7 +4870,7 @@ obvious upgrade path was visible and recommendable. With ASDF 2, upgrade is possible, easy and can be recommended. This means that vendors can safely ship a recent version of ASDF, confident -that if a user isn't fully satisfied, he can easily upgrade ASDF and +that if a user isn’t fully satisfied, he can easily upgrade ASDF and deal with a supported recent version of it. This means that release cycles will be causally decoupled, the practical consequence of which will mean faster convergence towards the latest version for everyone. @@ -4777,73 +4884,73 @@ File: asdf.info, Node: Pitfalls of the transition to ASDF 2, Next: Pitfalls of The main pitfalls in upgrading to ASDF 2 seem to be related to the output translation mechanism. - * Output translations is enabled by default. This may surprise some + • Output translations is enabled by default. This may surprise some users, most of them in pleasant way (we hope), a few of them in an unpleasant way. It is trivial to disable output translations. - *Note "How can I wholly disable the compiler output cache?": FAQ. + *Note “How can I wholly disable the compiler output cache?â€: FAQ. - * Some systems in the large have been known not to play well with + • Some systems in the large have been known not to play well with output translations. They were relatively easy to fix. Once again, it is also easy to disable output translations, or to override its configuration. - * The new ASDF output translations are incompatible with + • The new ASDF output translations are incompatible with ASDF-Binary-Locations. They replace A-B-L, and there is compatibility mode to emulate your previous A-B-L configuration. - See 'enable-asdf-binary-locations-compatibility' in *note Backward + See ‘enable-asdf-binary-locations-compatibility’ in *note Backward Compatibility: Controlling where ASDF saves compiled files. But thou shalt not load ABL on top of ASDF 2. Other issues include the following: - * ASDF pathname designators are now specified in places where they + • ASDF pathname designators are now specified in places where they were unspecified, and a few small adjustments have to be made to - some non-portable defsystems. Notably, in the ':pathname' argument - to a 'defsystem' and its components, a logical pathname (or + some non-portable defsystems. Notably, in the ‘:pathname’ argument + to a ‘defsystem’ and its components, a logical pathname (or implementation-dependent hierarchical pathname) must now be - specified with '#p' syntax where the namestring might have - previously sufficed; moreover when evaluation is desired '#.' must - be used, where it wasn't necessary in the toplevel ':pathname' - argument (but necessary in other ':pathname' arguments). - - * There is a slight performance bug, notably on SBCL, when initially - searching for 'asd' files, the implicit '(directory - "/configured/path/**/*.asd")' for every configured path '(:tree - "/configured/path/")' in your 'source-registry' configuration can - cause a slight pause. Try to '(time - (asdf:initialize-source-registry))' to see how bad it is or isn't + specified with ‘#p’ syntax where the namestring might have + previously sufficed; moreover when evaluation is desired ‘#.’ must + be used, where it wasn’t necessary in the toplevel ‘:pathname’ + argument (but necessary in other ‘:pathname’ arguments). + + • There is a slight performance bug, notably on SBCL, when initially + searching for ‘asd’ files, the implicit ‘(directory + "/configured/path/**/*.asd")’ for every configured path ‘(:tree + "/configured/path/")’ in your ‘source-registry’ configuration can + cause a slight pause. Try to ‘(time + (asdf:initialize-source-registry))’ to see how bad it is or isn’t on your system. If you insist on not having this pause, you can avoid the pause by overriding the default source-registry - configuration and not use any deep ':tree' entry but only - ':directory' entries or shallow ':tree' entries. Or you can fix + configuration and not use any deep ‘:tree’ entry but only + ‘:directory’ entries or shallow ‘:tree’ entries. Or you can fix your implementation to not be quite that slow when recursing through directories. _Update_: This performance bug fixed the hard way in 2.010. - * On Windows, only LispWorks supports proper default configuration + • On Windows, only LispWorks supports proper default configuration pathnames based on the Windows registry. Other implementations make do with environment variables, that you may have to define - yourself if you're using an older version of Windows. Windows + yourself if you’re using an older version of Windows. Windows support is somewhat less tested than Unix support. Please help report and fix bugs. _Update_: As of ASDF 2.21, all implementations should now use the same proper default configuration pathnames and they should actually work, though they - haven't all been tested. + haven’t all been tested. - * The mechanism by which one customizes a system so that Lisp files - may use a different extension from the default '.lisp' has changed. + • The mechanism by which one customizes a system so that Lisp files + may use a different extension from the default ‘.lisp’ has changed. Previously, the pathname for a component was lazily computed when - operating on a system, and you would '(defmethod source-file-type + operating on a system, and you would ‘(defmethod source-file-type ((component cl-source-file) (system (eql (find-system 'foo)))) - (declare (ignorable component system)) "lis")'. Now, the pathname + (declare (ignorable component system)) "lis")’. Now, the pathname for a component is eagerly computed when defining the system, and - instead you will '(defclass cl-source-file.lis (cl-source-file) - ((type :initform "lis")))' and use ':default-component-class - cl-source-file.lis' as argument to 'defsystem', as detailed in a + instead you will ‘(defclass cl-source-file.lis (cl-source-file) + ((type :initform "lis")))’ and use ‘:default-component-class + cl-source-file.lis’ as argument to ‘defsystem’, as detailed in a *note How do I create a system definition where all the source - files have a .cl extension?: FAQ. below. 'source-file-type' is - deprecated. To access a component's file-type, use 'file-type', - instead. 'source-file-type' will be removed. + files have a .cl extension?: FAQ. below. ‘source-file-type’ is + deprecated. To access a component’s file-type, use ‘file-type’, + instead. ‘source-file-type’ will be removed. File: asdf.info, Node: Pitfalls of the upgrade to ASDF 3, Next: What happened to the bundle operations, Prev: Pitfalls of the transition to ASDF 2, Up: What has changed between ASDF 1 ASDF 2 and ASDF 3? @@ -4854,53 +4961,53 @@ File: asdf.info, Node: Pitfalls of the upgrade to ASDF 3, Next: What happened While ASDF 3 is largely compatible with ASDF 2, there are a few pitfalls when upgrading from ASDF 2, due to limitations in ASDF 2. - * ASDF 2 was designed so it could be upgraded; but upgrading it + • ASDF 2 was designed so it could be upgraded; but upgrading it required a special setup at the beginning of your build files. Failure to upgrade it early could result in catastrophic attempt to self-upgrade in mid-build. - * Starting with ASDF 3 (2.27 or later), ASDF will automatically + • Starting with ASDF 3 (2.27 or later), ASDF will automatically attempt to upgrade itself as the first step before any system operation, to avoid any possibility of such catastrophic mid-build - self-upgrade. But that doesn't help if your old implementation + self-upgrade. But that doesn’t help if your old implementation still provides ASDF 2. - * It was unsafe in ASDF 2 for a system definition to declare a + • It was unsafe in ASDF 2 for a system definition to declare a dependency on ASDF, since it could trigger such catastrophe for users who were not carefully configured. If you declare a dependency on a recent enough ASDF, yet want to be nice with these potentially misconfigured users, we recommend that you not only - specify a recent ASDF in your dependencies with ':depends-on - ((:version "asdf" "3.1.2"))', but that you _also_ check that ASDF 3 + specify a recent ASDF in your dependencies with ‘:depends-on + ((:version "asdf" "3.1.2"))’, but that you _also_ check that ASDF 3 is installed, or else the upgrade catastrophe might happen before - that specification is checked, by starting your '.asd' file with a + that specification is checked, by starting your ‘.asd’ file with a version check as follows: #-asdf3 (error "MY-SYSTEM requires ASDF 3.1.2") - * When you upgrade from too old a version of ASDF, previously loaded + • When you upgrade from too old a version of ASDF, previously loaded ASDF extensions become invalid, and will need to be reloaded. Example extensions include CFFI-Grovel, hacks used by ironclad, - etc. Since it isn't possible to automatically detect what + etc. Since it isn’t possible to automatically detect what extensions need to be invalidated and what systems use them, ASDF will invalidate _all_ previously loaded systems when it is loaded on top of a forward-incompatible ASDF version. (1) - * To write a portable build script, you need to rely on a recent + • To write a portable build script, you need to rely on a recent version of UIOP, but until you have ensured a recent ASDF is - loaded, you can't rely on UIOP being present, and thus must + loaded, you can’t rely on UIOP being present, and thus must manually avoid all the pathname pitfalls when loading ASDF itself. - * Bugs in CMUCL and XCL prevent upgrade of ASDF from an old + • Bugs in CMUCL and XCL prevent upgrade of ASDF from an old forward-incompatible version. Happily, CMUCL comes with a recent - ASDF, and XCL is more of a working demo than something you'd use + ASDF, and XCL is more of a working demo than something you’d use seriously anyway. - * For the above reasons, your build and startup scripts should load + • For the above reasons, your build and startup scripts should load ASDF 3, configure it, and upgrade it, among the very first things they do. They should ensure that only ASDF 3 or later is used indeed, and error out if ASDF 2 or earlier was used. - * Now that (since May 2016) all maintained implementations (i.e. + • Now that (since May 2016) all maintained implementations (i.e. having had at least one release since 2014, or a commit on their public source code repository) provide ASDF 3.1 or later, the simple solution is just to use code as below in your setup, and @@ -4909,19 +5016,19 @@ when upgrading from ASDF 2, due to limitations in ASDF 2. (require "asdf") #-asdf3.1 (error "ASDF 3.1 or bust") - * For scripts that try to use ASDF simply via 'require' at first, and - make heroic attempts to load it the hard way if at first they don't - succeed, see 'tools/load-asdf.lisp' distributed with the ASDF - source repository, or the code of 'cl-launch' + • For scripts that try to use ASDF simply via ‘require’ at first, and + make heroic attempts to load it the hard way if at first they don’t + succeed, see ‘tools/load-asdf.lisp’ distributed with the ASDF + source repository, or the code of ‘cl-launch’ (https://cliki.net/cl-launch). - * Note that in addition to the pitfalls and constraints above, these + • Note that in addition to the pitfalls and constraints above, these heroic scripts (should you wish to write or modify one), must take care to configure ASDF _twice_. A first time, right after you load the old ASDF 2 (or 1!) and before you upgrade to the new ASDF 3, so it may find where you put ASDF 3. A second time, because most - implementations can't handle a smooth upgrade from ASDF 2 to ASDF - 3, so ASDF 3 doesn't try (anymore) and loses any configuration from + implementations can’t handle a smooth upgrade from ASDF 2 to ASDF + 3, so ASDF 3 doesn’t try (anymore) and loses any configuration from ASDF 2. (ignore-errors (funcall 'require "asdf")) ;; <--- try real hard ;; <--- insert heroics here, if that failed to provide ASDF 2 or 3 @@ -4932,7 +5039,7 @@ when upgrading from ASDF 2, due to limitations in ASDF 2. ---------- Footnotes ---------- (1) Forward incompatibility can be determined using the variable -'asdf/upgrade::*oldest-forward-compatible-asdf-version*', which is 2.33 +‘asdf/upgrade::*oldest-forward-compatible-asdf-version*’, which is 2.33 at the time of this writing. @@ -4941,23 +5048,23 @@ File: asdf.info, Node: What happened to the bundle operations, Prev: Pitfalls 13.3.13 What happened to the bundle operations? ----------------------------------------------- -'asdf-ecl' and its short-lived successor 'asdf-bundle' are no more, +‘asdf-ecl’ and its short-lived successor ‘asdf-bundle’ are no more, having been replaced by code now built into ASDF 3. Moreover, the name of the bundle operations has changed since ASDF 3.1.3. Starting with -ASDF 3.2.0, 'load-system' will once again use 'load-bundle-op' instead -of 'load-op' on ECL, as originally intended by 'asdf-ecl' authors, but +ASDF 3.2.0, ‘load-system’ will once again use ‘load-bundle-op’ instead +of ‘load-op’ on ECL, as originally intended by ‘asdf-ecl’ authors, but disabled for a long time due to bugs in both ECL and ASDF. Note that some of the bundle operations were renamed after ASDF 3.1.3, and the old names have been removed. Old bundle operations, and their modern equivalents are: - * 'fasl-op' is now 'compile-bundle-op' - * 'load-fasl-op' is now 'load-bundle-op' - * 'binary-op' is now 'deliver-asd-op' - * 'monolithic-fasl-op' is now 'monolithic-compile-bundle-op' - * 'monolithic-load-fasl-op' is now 'monolithic-load-bundle-op' - * 'monolithic-binary-op' is now 'monolithic-deliver-asd-op' + • ‘fasl-op’ is now ‘compile-bundle-op’ + • ‘load-fasl-op’ is now ‘load-bundle-op’ + • ‘binary-op’ is now ‘deliver-asd-op’ + • ‘monolithic-fasl-op’ is now ‘monolithic-compile-bundle-op’ + • ‘monolithic-load-fasl-op’ is now ‘monolithic-load-bundle-op’ + • ‘monolithic-binary-op’ is now ‘monolithic-deliver-asd-op’ File: asdf.info, Node: Issues with installing the proper version of ASDF, Next: Issues with configuring ASDF, Prev: What has changed between ASDF 1 ASDF 2 and ASDF 3?, Up: FAQ @@ -4969,12 +5076,12 @@ File: asdf.info, Node: Issues with installing the proper version of ASDF, Next * My Common Lisp implementation comes with an outdated version of ASDF. What to do?:: * I'm a Common Lisp implementation vendor. When and how should I upgrade ASDF?:: -* After upgrading ASDF, ASDF (and Quicklisp) can't find my systems: After upgrading ASDF. +* After upgrading ASDF, ASDF (and Quicklisp) can’t find my systems: After upgrading ASDF. File: asdf.info, Node: My Common Lisp implementation comes with an outdated version of ASDF. What to do?, Next: I'm a Common Lisp implementation vendor. When and how should I upgrade ASDF?, Prev: Issues with installing the proper version of ASDF, Up: Issues with installing the proper version of ASDF -13.4.1 "My Common Lisp implementation comes with an outdated version of ASDF. What to do?" +13.4.1 “My Common Lisp implementation comes with an outdated version of ASDF. What to do?†------------------------------------------------------------------------------------------ If you have a recent implementation, it should already come with ASDF 3 @@ -4983,89 +5090,89 @@ recommend you simply upgrade ASDF by installing a recent version in a path configured in your source-registry. *Note Upgrading ASDF::. If you have an old implementation that does not provide ASDF 3, we -recommend you replace your implementation's ASDF. *Note Replacing your +recommend you replace your implementation’s ASDF. *Note Replacing your implementation's ASDF::. File: asdf.info, Node: I'm a Common Lisp implementation vendor. When and how should I upgrade ASDF?, Next: After upgrading ASDF, Prev: My Common Lisp implementation comes with an outdated version of ASDF. What to do?, Up: Issues with installing the proper version of ASDF -13.4.2 "I'm a Common Lisp implementation vendor. When and how should I upgrade ASDF?" +13.4.2 “I’m a Common Lisp implementation vendor. When and how should I upgrade ASDF?†------------------------------------------------------------------------------------- Since ASDF 2, it should always be a good time to upgrade to a recent version of ASDF. You may consult with the maintainer for which specific -version they recommend, but the latest 'release' should be correct. +version they recommend, but the latest ‘release’ should be correct. Though we do try to test ASDF releases against all implementations that we can, we may not be testing against all variants of your implementation, and we may not be running enough tests; we trust you to thoroughly test it with your own implementation before you release it. -If there are any issues with the current release, it's a bug that you +If there are any issues with the current release, it’s a bug that you should report upstream and that we will fix ASAP. As to how to include ASDF, we recommend the following: - * If ASDF isn't loaded yet, then '(require "asdf")' should load the + • If ASDF isn’t loaded yet, then ‘(require "asdf")’ should load the version of ASDF that is bundled with your system. If possible so - should '(require "ASDF")'. You may have it load some other version + should ‘(require "ASDF")’. You may have it load some other version configured by the user, if you allow such configuration. - * If your system provides a mechanism to hook into 'cl:require', then + • If your system provides a mechanism to hook into ‘cl:require’, then it would be nice to add ASDF to this hook the same way that ABCL, CCL, CLISP, CMUCL, ECL, SBCL and SCL do it. Please send us appropriate code to this end. - * You may, like SBCL since 1.1.13 or MKCL since 1.1.9, have ASDF + • You may, like SBCL since 1.1.13 or MKCL since 1.1.9, have ASDF create bundle FASLs that are provided as modules by your Lisp - distribution. You may also, but we don't recommend that anymore, + distribution. You may also, but we don’t recommend that anymore, as in SBCL up until 1.1.12, have ASDF be implicitly used to - 'cl:require' these modules that are provided by your Lisp + ‘cl:require’ these modules that are provided by your Lisp distribution; if you do, you should add these modules in the - beginning of both 'wrapping-source-registry' and - 'wrapping-output-translations'. + beginning of both ‘wrapping-source-registry’ and + ‘wrapping-output-translations’. - * If you have magic systems as above, like SBCL used to do, then we - explicitly ask you to _NOT_ distribute 'asdf.asd' as part of those - magic systems. You should still include the file 'asdf.lisp' in + • If you have magic systems as above, like SBCL used to do, then we + explicitly ask you to _NOT_ distribute ‘asdf.asd’ as part of those + magic systems. You should still include the file ‘asdf.lisp’ in your source distribution and precompile it in your binary - distribution, but 'asdf.asd' if included at all, should be secluded + distribution, but ‘asdf.asd’ if included at all, should be secluded from the magic systems, in a separate file hierarchy. Alternatively, you may provide the system after renaming it and its - '.asd' file to e.g. 'asdf-ecl' and 'asdf-ecl.asd', or 'sb-asdf' - and 'sb-asdf.asd'. Indeed, if you made 'asdf.asd' a magic system, + ‘.asd’ file to e.g. ‘asdf-ecl’ and ‘asdf-ecl.asd’, or ‘sb-asdf’ + and ‘sb-asdf.asd’. Indeed, if you made ‘asdf.asd’ a magic system, then users would no longer be able to upgrade ASDF using ASDF itself to some version of their preference that they maintain independently from your Lisp distribution. - * If you do not have any such magic systems, or have other non-magic + • If you do not have any such magic systems, or have other non-magic systems that you want to bundle with your implementation, then you - may add them to the 'wrapping-source-registry', and you are welcome - to include 'asdf.asd' amongst them. Non-magic systems should be at - the back of the 'wrapping-source-registry' while magic systems are + may add them to the ‘wrapping-source-registry’, and you are welcome + to include ‘asdf.asd’ amongst them. Non-magic systems should be at + the back of the ‘wrapping-source-registry’ while magic systems are at the front. If they are precompiled, they should also be in the - 'wrapping-output-translations'. + ‘wrapping-output-translations’. - * Since ASDF 3, the library UIOP comes transcluded in ASDF. But if + • Since ASDF 3, the library UIOP comes transcluded in ASDF. But if you want to be nice to users who care for UIOP but not for ASDF, - you may package UIOP separately, so that one may '(require "uiop")' - and not load ASDF, or one may '(require "asdf")' which would + you may package UIOP separately, so that one may ‘(require "uiop")’ + and not load ASDF, or one may ‘(require "asdf")’ which would implicitly require and load the former. - * Please send us upstream any patches you make to ASDF itself, so we + • Please send us upstream any patches you make to ASDF itself, so we can merge them back in for the benefit of your users when they upgrade to the upstream version. File: asdf.info, Node: After upgrading ASDF, Prev: I'm a Common Lisp implementation vendor. When and how should I upgrade ASDF?, Up: Issues with installing the proper version of ASDF -13.4.3 After upgrading ASDF, ASDF (and Quicklisp) can't find my systems +13.4.3 After upgrading ASDF, ASDF (and Quicklisp) can’t find my systems ----------------------------------------------------------------------- When you upgrade the ASDF running in your Lisp image from an ancient ASDF 2 or older to ASDF 3 or newer, then you may have to re-configure ASDF. If your configuration only consists in using the source-registry and output-translations (as it should), and if you are not explicitly -calling 'asdf:initialize-source-registry' or -'asdf:initialize-output-translations' with a non-nil argument, then ASDF +calling ‘asdf:initialize-source-registry’ or +‘asdf:initialize-output-translations’ with a non-nil argument, then ASDF will reconfigure itself. Otherwise, you will have to configure ASDF 2 (or older) to find ASDF 3, then configure ASDF 3. Notably, *CENTRAL-REGISTRY* is not maintained across upgrades from ASDF 2. *Note @@ -5098,29 +5205,29 @@ File: asdf.info, Node: Issues with configuring ASDF, Next: Issues with using a File: asdf.info, Node: How can I customize where fasl files are stored?, Next: How can I wholly disable the compiler output cache?, Prev: Issues with configuring ASDF, Up: Issues with configuring ASDF -13.5.1 "How can I customize where fasl files are stored?" +13.5.1 “How can I customize where fasl files are stored?†--------------------------------------------------------- *Note Controlling where ASDF saves compiled files::. Note that in the past there was an add-on to ASDF called -'ASDF-binary-locations', developed by Gary King. That add-on has been +‘ASDF-binary-locations’, developed by Gary King. That add-on has been merged into ASDF proper, then superseded by the -'asdf-output-translations' facility. +‘asdf-output-translations’ facility. - Note that use of 'asdf-output-translations' can interfere with one -aspect of your systems -- if your system uses '*load-truename*' to find + Note that use of ‘asdf-output-translations’ can interfere with one +aspect of your systems — if your system uses ‘*load-truename*’ to find files (e.g., if you have some data files stored with your program), then the relocation that this ASDF customization performs is likely to -interfere. Use 'asdf:system-relative-pathname' to locate a file in the +interfere. Use ‘asdf:system-relative-pathname’ to locate a file in the source directory of some system, and use -'asdf:apply-output-translations' to locate a file whose pathname has +‘asdf:apply-output-translations’ to locate a file whose pathname has been translated by the facility. File: asdf.info, Node: How can I wholly disable the compiler output cache?, Prev: How can I customize where fasl files are stored?, Up: Issues with configuring ASDF -13.5.2 "How can I wholly disable the compiler output cache?" +13.5.2 “How can I wholly disable the compiler output cache?†------------------------------------------------------------ To permanently disable the compiler output cache for all future runs of @@ -5130,13 +5237,13 @@ ASDF, you can: echo ':disable-cache' > \ ~/.config/common-lisp/asdf-output-translations.conf.d/99-disable-cache.conf - This assumes that you didn't otherwise configure the ASDF files (if -you did, edit them again), and don't somehow override the configuration + This assumes that you didn’t otherwise configure the ASDF files (if +you did, edit them again), and don’t somehow override the configuration at runtime with a shell variable (see below) or some other runtime -command (e.g. some call to 'asdf:initialize-output-translations'). +command (e.g. some call to ‘asdf:initialize-output-translations’). To disable the compiler output cache in Lisp processes run by your -current shell, try (assuming 'bash' or 'zsh') (on Unix and cygwin only): +current shell, try (assuming ‘bash’ or ‘zsh’) (on Unix and cygwin only): export ASDF_OUTPUT_TRANSLATIONS=/: @@ -5145,8 +5252,8 @@ process, use (after loading ASDF but before using it): (asdf:disable-output-translations) - Note that this does _NOT_ belong in a '.asd' file. Please do not -tamper with ASDF configuration from a '.asd' file, and only do this from + Note that this does _NOT_ belong in a ‘.asd’ file. Please do not +tamper with ASDF configuration from a ‘.asd’ file, and only do this from your personal configuration or build scripts. @@ -5170,44 +5277,44 @@ File: asdf.info, Node: Issues with using and extending ASDF to define systems, File: asdf.info, Node: How can I cater for unit-testing in my system?, Next: How can I cater for documentation generation in my system?, Prev: Issues with using and extending ASDF to define systems, Up: Issues with using and extending ASDF to define systems -13.6.1 "How can I cater for unit-testing in my system?" +13.6.1 “How can I cater for unit-testing in my system?†------------------------------------------------------- -ASDF provides a predefined test operation, 'test-op'. *Note test-op: +ASDF provides a predefined test operation, ‘test-op’. *Note test-op: Predefined operations of ASDF. The test operation, however, is largely -left to the system definer to specify. 'test-op' has been a topic of +left to the system definer to specify. ‘test-op’ has been a topic of considerable discussion on the asdf-devel mailing list (http://common-lisp.net/cgi-bin/mailman/listinfo/asdf-devel) (*note Mailing list::), and on the launchpad bug-tracker (https://launchpad.net/asdf) (*note Where do I report a bug?::). We -provide some guidelines in the discussion of 'test-op'. +provide some guidelines in the discussion of ‘test-op’. File: asdf.info, Node: How can I cater for documentation generation in my system?, Next: How can I maintain non-Lisp (e.g. C) source files?, Prev: How can I cater for unit-testing in my system?, Up: Issues with using and extending ASDF to define systems -13.6.2 "How can I cater for documentation generation in my system?" +13.6.2 “How can I cater for documentation generation in my system?†------------------------------------------------------------------- -Various ASDF extensions provide some kind of 'doc-op' operation. See +Various ASDF extensions provide some kind of ‘doc-op’ operation. See also <https://bugs.launchpad.net/asdf/+bug/479470>. File: asdf.info, Node: How can I maintain non-Lisp (e.g. C) source files?, Next: I want to put my module's files at the top level. How do I do this?, Prev: How can I cater for documentation generation in my system?, Up: Issues with using and extending ASDF to define systems -13.6.3 "How can I maintain non-Lisp (e.g. C) source files?" +13.6.3 “How can I maintain non-Lisp (e.g. C) source files?†----------------------------------------------------------- -See 'cffi''s 'cffi-grovel'. +See ‘cffi’’s ‘cffi-grovel’. File: asdf.info, Node: I want to put my module's files at the top level. How do I do this?, Next: How do I create a system definition where all the source files have a .cl extension?, Prev: How can I maintain non-Lisp (e.g. C) source files?, Up: Issues with using and extending ASDF to define systems -13.6.4 "I want to put my module's files at the top level. How do I do this?" +13.6.4 “I want to put my module’s files at the top level. How do I do this?†---------------------------------------------------------------------------- By default, the files contained in an asdf module go in a subdirectory with the same name as the module. However, this can be overridden by -adding a ':pathname ""' argument to the module description. For +adding a ‘:pathname ""’ argument to the module description. For example, here is how it could be done in the spatial-trees ASDF system definition for ASDF 2 or later: @@ -5241,25 +5348,25 @@ definition for ASDF 2 or later: (:static-file "LICENCE") (:static-file "TODO"))) - All of the files in the 'tree-impls' module are at the top level, -instead of in a 'tree-impls/' subdirectory. + All of the files in the ‘tree-impls’ module are at the top level, +instead of in a ‘tree-impls/’ subdirectory. - Note that the argument to ':pathname' can be either a pathname object + Note that the argument to ‘:pathname’ can be either a pathname object or a string. A pathname object can be constructed with the -'#p"foo/bar/"' syntax, but this is discouraged because the results of +‘#p"foo/bar/"’ syntax, but this is discouraged because the results of parsing a namestring are not portable. A pathname can only be portably -constructed with such syntax as '#.(make-pathname :directory '(:relative -"foo" "bar"))', and similarly the current directory can only be portably -specified as '#.(make-pathname :directory '(:relative))'. However, as +constructed with such syntax as ‘#.(make-pathname :directory '(:relative +"foo" "bar"))’, and similarly the current directory can only be portably +specified as ‘#.(make-pathname :directory '(:relative))’. However, as of ASDF 2, you can portably use a string to denote a pathname. The -string will be parsed as a '/'-separated path from the current -directory, such that the empty string '""' denotes the current -directory, and '"foo/bar"' (no trailing '/' required in the case of +string will be parsed as a ‘/’-separated path from the current +directory, such that the empty string ‘""’ denotes the current +directory, and ‘"foo/bar"’ (no trailing ‘/’ required in the case of modules) portably denotes the same subdirectory as above. When files -are specified, the last '/'-separated component is interpreted either as +are specified, the last ‘/’-separated component is interpreted either as the name component of a pathname (if the component class specifies a pathname type), or as a name component plus optional dot-separated type -component (if the component class doesn't specifies a pathname type). +component (if the component class doesn’t specifies a pathname type). File: asdf.info, Node: How do I create a system definition where all the source files have a .cl extension?, Next: How do I mark a source file to be loaded only and not compiled?, Prev: I want to put my module's files at the top level. How do I do this?, Up: Issues with using and extending ASDF to define systems @@ -5268,17 +5375,17 @@ File: asdf.info, Node: How do I create a system definition where all the source ------------------------------------------------------------------------------------------- Starting with ASDF 2.014.14, you may just pass the builtin class -'cl-source-file.cl' as the ':default-component-class' argument to -'defsystem': +‘cl-source-file.cl’ as the ‘:default-component-class’ argument to +‘defsystem’: (defsystem my-cl-system :default-component-class cl-source-file.cl ...) - Another builtin class 'cl-source-file.lsp' is offered for files -ending in '.lsp'. + Another builtin class ‘cl-source-file.lsp’ is offered for files +ending in ‘.lsp’. - If you want to use a different extension for which ASDF doesn't + If you want to use a different extension for which ASDF doesn’t provide builtin support, or want to support versions of ASDF earlier than 2.014.14 (but later than 2.000), you can define a class as follows: @@ -5296,9 +5403,9 @@ than 2.014.14 (but later than 2.000), you can define a class as follows: :default-component-class my-asdf-extension:cl-source-file.lis ...) - Of course, if you're in the same package, e.g. in the same file, you -won't need to use the package qualifier before 'cl-source-file.lis'. -Actually, if all you're doing is defining this class and using it in the + Of course, if you’re in the same package, e.g. in the same file, you +won’t need to use the package qualifier before ‘cl-source-file.lis’. +Actually, if all you’re doing is defining this class and using it in the same file without other fancy definitions, you might skip package complications: @@ -5317,10 +5424,10 @@ File: asdf.info, Node: How do I mark a source file to be loaded only and not co There is no provision in ASDF for ensuring that some components are always loaded as source, while others are always compiled. There is -'load-source-op' (*note load-source-op: Predefined operations of ASDF.), +‘load-source-op’ (*note load-source-op: Predefined operations of ASDF.), but that is an operation to be applied to a system as a whole, not to one or another specific source files. While this idea often comes up in -discussions, it doesn't play well with either the linking model of ECL +discussions, it doesn’t play well with either the linking model of ECL or with various bundle operations. In addition, the dependency model of ASDF would have to be modified incompatibly to allow for such a trick. @@ -5332,28 +5439,28 @@ File: asdf.info, Node: How do I work with readtables?, Next: How can I capture It is possible to configure the lisp syntax by modifying the currently-active readtable. However, this same readtable is shared -globally by all software being compiled by ASDF, especially since 'load' -and 'compile-file' both bind *READTABLE*, so that its value is the same +globally by all software being compiled by ASDF, especially since ‘load’ +and ‘compile-file’ both bind *READTABLE*, so that its value is the same across the build at the start of every file (unless overridden by some -'perform :around' method), even if a file locally binds it to a +‘perform :around’ method), even if a file locally binds it to a different readtable during the build. - Therefore, the following hygiene restrictions apply. If you don't + Therefore, the following hygiene restrictions apply. If you don’t abide by these restrictions, there will be situations where your output files will be corrupted during an incremental build. We are not trying to prescribe new restrictions for the sake of good style: these restrictions have always applied implicitly, and we are simply describing what they have always been. - * It is forbidden to modifying any standard character or standard + • It is forbidden to modifying any standard character or standard macro dispatch defined in the CLHS. - * No two dependencies may assign different meanings to the same + • No two dependencies may assign different meanings to the same non-standard character. - * Using any non-standard character while expecting the implementation + • Using any non-standard character while expecting the implementation to treat some way counts as such an assignment of meaning. - * libraries need to document these assignments of meaning to + • libraries need to document these assignments of meaning to non-standard characters. - * free software libraries will register these changes on: + • free software libraries will register these changes on: <http://www.cliki.net/Macro%20Characters> If you want to use readtable modifications that cannot abide by those @@ -5361,52 +5468,52 @@ restrictions, you _must_ create a different readtable object and set *READTABLE* to temporarily bind it to your new readtable (which will be undone after processing the file). - For that, we recommend you use system 'named-readtables' to define or -combine such readtables using 'named-readtables:defreadtable' and use -them using 'named-readtables:in-readtable'. Equivalently, you can use -system 'cl-syntax', that itself uses 'named-readtables', but may someday + For that, we recommend you use system ‘named-readtables’ to define or +combine such readtables using ‘named-readtables:defreadtable’ and use +them using ‘named-readtables:in-readtable’. Equivalently, you can use +system ‘cl-syntax’, that itself uses ‘named-readtables’, but may someday do more with, e.g. *PRINT-PPRINT-DISPATCH*. For even more advanced syntax modification beyond what a readtable can express, you may consider either: - * a 'perform' method that compiles a constant file that contains a - single form '#.*code-read-with-alternate-reader*' in an environment + • a ‘perform’ method that compiles a constant file that contains a + single form ‘#.*code-read-with-alternate-reader*’ in an environment where this special variable was bound to the code read by your alternate reader, or - * using the system 'reader-interception'. + • using the system ‘reader-interception’. Beware that it is unsafe to use ASDF from the REPL to compile or load -systems while the readtable isn't the shared readtable previously used +systems while the readtable isn’t the shared readtable previously used to build software. You _must_ manually undo any binding of *READTABLE* -at the REPL and restore its initial value whenever you call 'operate' -(via e.g. 'load-system', 'test-system' or 'require') from a REPL that +at the REPL and restore its initial value whenever you call ‘operate’ +(via e.g. ‘load-system’, ‘test-system’ or ‘require’) from a REPL that is using a different readtable. 13.6.7.1 How should my system use a readtable exported by another system? ......................................................................... -Use from the 'named-readtables' system the macro -'named-readtables:in-readtable'. +Use from the ‘named-readtables’ system the macro +‘named-readtables:in-readtable’. - If the other system fails to use 'named-readtables', fix it and send + If the other system fails to use ‘named-readtables’, fix it and send a patch upstream. In the day and age of Quicklisp and clbuild, there is little reason to eschew using such an important library anymore. 13.6.7.2 How should my library make a readtable available to other systems? ........................................................................... -Use from the 'named-readtables' system the macro -'named-readtables:defreadtable'. +Use from the ‘named-readtables’ system the macro +‘named-readtables:defreadtable’. File: asdf.info, Node: How can I capture ASDF's output?, Next: LOAD-PATHNAME has a weird value, Prev: How do I work with readtables?, Up: Issues with using and extending ASDF to define systems -13.6.8 How can I capture ASDF's output? +13.6.8 How can I capture ASDF’s output? --------------------------------------- Output from ASDF and ASDF extensions are sent to the CL stream -'*standard-output*', so rebinding that stream around calls to -'asdf:operate' should redirect all output from ASDF operations. +‘*standard-output*’, so rebinding that stream around calls to +‘asdf:operate’ should redirect all output from ASDF operations. File: asdf.info, Node: LOAD-PATHNAME has a weird value, Prev: How can I capture ASDF's output?, Up: Issues with using and extending ASDF to define systems @@ -5414,24 +5521,24 @@ File: asdf.info, Node: LOAD-PATHNAME has a weird value, Prev: How can I captur 13.6.9 *LOAD-PATHNAME* and *LOAD-TRUENAME* have weird values, help! ------------------------------------------------------------------- -Conventional Common Lisp code may use '*LOAD-TRUENAME*' or -'*LOAD-PATHNAME*' to find files adjacent to source files. This will +Conventional Common Lisp code may use ‘*LOAD-TRUENAME*’ or +‘*LOAD-PATHNAME*’ to find files adjacent to source files. This will generally _not_ work in ASDF-loaded systems. Recall that ASDF relocates the FASL files it builds, typically to a special cache directory. Thus -the value of '*LOAD-PATHNAME*' and '*LOAD-TRUENAME*' at load time, when +the value of ‘*LOAD-PATHNAME*’ and ‘*LOAD-TRUENAME*’ at load time, when ASDF is loading your system, will typically be a pathname in that cache directory, and useless to you for finding other system components. There are two ways to work around this problem: - 1. Use the 'system-relative-pathname' function. This can readily be + 1. Use the ‘system-relative-pathname’ function. This can readily be used from outside the system, but it is probably not good software engineering to require a source file _of_ a system to know what system it is going to be part of. Contained objects should not have to know their containers. 2. Store the pathname at compile time, so that you get the pathname of the source file, which is presumably what you want. To do this, - you can capture the value of '(or *compile-file-pathname* - *load-truename*)' (or '*LOAD-PATHNAME*', if you prefer) in a macro + you can capture the value of ‘(or *compile-file-pathname* + *load-truename*)’ (or ‘*LOAD-PATHNAME*’, if you prefer) in a macro expansion or other compile-time evaluated context. @@ -5454,7 +5561,7 @@ This not-so-frequently asked question is primarily for ASDF developers, but those who encounter an unexpected error in some test may be interested, too. - Here's the procedure for experimenting with tests in a REPL: + Here’s the procedure for experimenting with tests in a REPL: ;; BEWARE! Some tests expect you to be in the .../asdf/test directory ;; If your REPL is not there yet, change your current directory: ;; under SLIME, you may: ,change-directory ~/common-lisp/asdf/test/ @@ -5484,7 +5591,7 @@ File: asdf.info, Node: Ongoing Work, Next: Bibliography, Prev: FAQ, Up: Top Ongoing Work ************ -For an active list of things to be done, see the 'TODO' file in the +For an active list of things to be done, see the ‘TODO’ file in the source repository. Also, bugs are currently tracked on launchpad: @@ -5496,62 +5603,87 @@ File: asdf.info, Node: Bibliography, Next: Concept Index, Prev: Ongoing Work, Bibliography ************ - * Francois-Rene Rideau: "ASDF 3, or Why Lisp is Now an Acceptable - Scripting Language", 2014. This article describes the innovations + • Andrey Mokhov, Neil Mitchell and Simon Peyton Jones: “Build Systems + à la Carteâ€, 2018. + <https://www.microsoft.com/en-us/research/uploads/prod/2018/03/build-systems-final.pdf> + This article provides axes along which to describe build systems in + general; ASDF, in addition to being in-image (an axis not + considered by these authors), has the following characteristics: + ASDF’s persistent build information is file modification times (the + way ASDF is written, it should be easy enough to write an extension + that modifies it to use a “cloud cache†à la Bazel, but that would + involve using some database, network and cryptographic libraries, + which cannot reasonably be included in the base ASDF, that must + remain a minimal bootstrappable system with no external + dependencies). The object model of ASDF was initially designed for + “static†dependencies with a “topological†scheduler, but its + ‘defsystem-depends-on’ mechanism (and more generally, the ability + to call ASDF from within an ‘.asd’ file) allows for multiple + _phases_ of execution resulting in “dynamic†dependencies with a + “suspending†scheduler. The rebuilder essentially uses a “dirty + bitâ€, except that the in-image model and the multiple phase support + mean that’s actually more than a bit: instead three bits, the + timestamp and a phase depth level. The build is guaranteed + “minimal†in number of steps computed. It is local; it assumes but + does not enforce determinism; it does not assume early cutoff of + the build when rebuild dependencies didn’t change. + • Francois-Rene Rideau: “ASDF 3, or Why Lisp is Now an Acceptable + Scripting Languageâ€, 2014. This article describes the innovations in ASDF 3 and 3.1, as well as historical information on previous versions. <https://github.com/fare/asdf3-2013> - * Alastair Bridgewater: "Quick-build" (private communication), 2012. - 'quick-build' is a simple and robust one file, one package build - system, similar to 'faslpath', in 182 lines of code (117 of which + • Alastair Bridgewater: “Quick-build†(private communication), 2012. + ‘quick-build’ is a simple and robust one file, one package build + system, similar to ‘faslpath’, in 182 lines of code (117 of which are not blank, not comments, not docstrings). Unhappily, it remains unpublished and its IP status is unclear as of April 2014. - 'asdf/package-system' is mostly compatible with it, modulo a + ‘asdf/package-system’ is mostly compatible with it, modulo a different setup for toplevel hierarchies. - * Zach Beane: "Quicklisp", 2011. The Quicklisp blog and Xach's - livejournal contain information on Quicklisp. - <http://blog.quicklisp.org/> <http://xach.livejournal.com/> - * Francois-Rene Rideau and Robert Goldman: "Evolving ASDF: More - Cooperation, Less Coordination", 2010. This article describes the + • Zach Beane: “Quicklispâ€, 2011. The Quicklisp blog and Xach’s + personal blogs contain information on Quicklisp. + <http://blog.quicklisp.org/> <http://lispblog.xach.com/> (new) + <http://xach.livejournal.com/> (old) + • Francois-Rene Rideau and Robert Goldman: “Evolving ASDF: More + Cooperation, Less Coordinationâ€, 2010. This article describes the main issues solved by ASDF 2, and exposes its design principles. - <https://common-lisp.net/project/asdf/doc/ilc2010draft.pdf> - <https://gitlab.common-lisp.org/asdf/ilc2010> - * Francois-Rene Rideau and Spencer Brody: "XCVB: an eXtensible - Component Verifier and Builder for Common Lisp", 2009. This + <https://common-lisp.net/project/asdf/ilc2010draft.pdf> + <http://rpgoldman.goldman-tribe.org/papers/ilc2010-asdf.pdf> + • Francois-Rene Rideau and Spencer Brody: “XCVB: an eXtensible + Component Verifier and Builder for Common Lispâ€, 2009. This article describes XCVB, a proposed competitor for ASDF; many of its ideas have been incorporated into ASDF 2 and 3, though many other - ideas still haven't. <https://common-lisp.net/project/xcvb/> - * Peter von Etter: "faslpath", 2009. 'faslpath' is similar to the - latter 'quick-build' and our yet latter 'asdf/package-system' - extension, except that it uses dot '.' rather than slash '/' as a + ideas still haven’t. <https://common-lisp.net/project/xcvb/> + • Peter von Etter: “faslpathâ€, 2009. ‘faslpath’ is similar to the + latter ‘quick-build’ and our yet latter ‘asdf/package-system’ + extension, except that it uses dot ‘.’ rather than slash ‘/’ as a separator. <https://code.google.com/p/faslpath/> - * Drew McDermott: "A Framework for Maintaining the Coherence of a - Running Lisp," International Lisp Conference, 2005, available in + • Drew McDermott: “A Framework for Maintaining the Coherence of a + Running Lisp,†International Lisp Conference, 2005, available in pre-print form at <http://www.cs.yale.edu/homes/dvm/papers/lisp05.pdf> - * Dan Barlow: "ASDF Manual", 2004. Older versions of this document + • Dan Barlow: “ASDF Manualâ€, 2004. Older versions of this document from the days of ASDF 1; they include ideas laid down by Dan - Barlow, and comparisons with older defsystems ('mk-defsystem') and - defsystem ('defsystem-4', kmp's Memo 801). - * Marco Antoniotti and Peter Van Eynde: "'DEFSYSTEM': A 'make' for - Common Lisp, A Thoughtful Re-Implementation of an Old Idea", 2002. - The 'defsystem-4' proposal available in the CLOCC repository. - * Mark Kantrovitz: "Defsystem: A Portable Make Facility for Common - Lisp", 1990. The classic 'mk-defsystem', later variants of which - are available in the CLOCC repository as 'defsystem-3.x'. - * Richard Elliot Robbins: "BUILD: A Tool for Maintaining Consistency - in Modular Systems", MIT AI TR 874, 1985. - <ftp://publications.ai.mit.edu/ai-publications/pdf/AITR-874.pdf> - * Kent M. Pitman (kmp): "The Description of Large Systems", MIT AI + Barlow, and comparisons with older defsystems (‘mk-defsystem’) and + defsystem (‘defsystem-4’, kmp’s Memo 801). + • Marco Antoniotti and Peter Van Eynde: “‘DEFSYSTEM’: A ‘make’ for + Common Lisp, A Thoughtful Re-Implementation of an Old Ideaâ€, 2002. + The ‘defsystem-4’ proposal available in the CLOCC repository. + • Mark Kantrovitz: “Defsystem: A Portable Make Facility for Common + Lispâ€, 1990. The classic ‘mk-defsystem’, later variants of which + are available in the CLOCC repository as ‘defsystem-3.x’. + • Richard Elliot Robbins: “BUILD: A Tool for Maintaining Consistency + in Modular Systemsâ€, MIT AI TR 874, 1985. + <http://www.dtic.mil/dtic/tr/fulltext/u2/a162744.pdf> + • Kent M. Pitman (kmp): “The Description of Large Systemsâ€, MIT AI Memo 801, 1984. Available in updated-for-CL form on the web at <http://nhplace.com/kent/Papers/Large-Systems.html> - * Dan Weinreb and David Moon: "Lisp Machine Manual", 3rd Edition MIT, + • Dan Weinreb and David Moon: “Lisp Machine Manualâ€, 3rd Edition MIT, March 1981. The famous CHINE NUAL describes one of the earliest variants of DEFSYSTEM. (NB: Not present in the second preliminary version of January 1979) <http://bitsavers.org/pdf/mit/cadr/chinual_3rdEd_Mar81.pdf> -File: asdf.info, Node: Concept Index, Next: Function and Class Index, Prev: Bibliography, Up: Top +File: asdf.info, Node: Concept Index, Next: Function and Macro Index, Prev: Bibliography, Up: Top Concept Index ************* @@ -5568,34 +5700,36 @@ Concept Index * :asdf2: Introduction. (line 6) * :asdf3: Introduction. (line 6) * :build-operation: The defsystem grammar. - (line 134) + (line 190) * :compile-check: Controlling file compilation. (line 6) * :default-registry source config directive: Configuration DSL. (line 6) * :defsystem-depends-on: The defsystem grammar. - (line 126) + (line 182) * :directory source config directive: Configuration DSL. (line 6) +* :entry-point: The defsystem grammar. + (line 479) * :exclude source config directive: Configuration DSL. (line 6) * :feature dependencies: The defsystem grammar. - (line 279) + (line 337) * :if-feature component option: The defsystem grammar. - (line 399) + (line 456) * :ignore-invalid-entries source config directive: Configuration DSL. (line 6) * :include source config directive: Configuration DSL. (line 6) * :inherit-configuration source config directive: Configuration DSL. (line 6) * :require dependencies: The defsystem grammar. - (line 269) + (line 327) * :tree source config directive: Configuration DSL. (line 6) * :version: The defsystem form. (line 68) * :version <1>: The defsystem grammar. - (line 235) + (line 293) * :version <2>: Common attributes of components. (line 23) * :weakly-depends-on: The defsystem grammar. - (line 146) + (line 202) * also-exclude source config directive: Configuration DSL. (line 6) * around-compile keyword: Controlling file compilation. (line 6) @@ -5612,7 +5746,7 @@ Concept Index * bug tracker: Where do I report a bug?. (line 6) * build-operation: Convenience Functions. - (line 64) + (line 61) * Capturing ASDF output: How can I capture ASDF's output?. (line 6) * compile-check keyword: Controlling file compilation. @@ -5636,30 +5770,36 @@ Concept Index * launchpad: Where do I report a bug?. (line 6) * logical pathnames: The defsystem grammar. - (line 298) + (line 355) * mailing list: Mailing list. (line 6) +* One package per file systems: The package-inferred-system extension. + (line 6) * operation: Operations. (line 6) +* Package inferred systems: The package-inferred-system extension. + (line 6) +* Packages, inferring dependencies from: The package-inferred-system extension. + (line 6) * pathname specifiers: The defsystem grammar. - (line 168) + (line 224) * Primary system name: Components. (line 70) * Quicklisp: After upgrading ASDF. (line 6) * readtables: How do I work with readtables?. (line 6) * serial dependencies: The defsystem grammar. - (line 344) + (line 401) * system: Components. (line 6) * system designator: Components. (line 6) * System names: Components. (line 70) * Testing for ASDF: Introduction. (line 6) * tree source config directive: Configuration DSL. (line 6) * version specifiers: The defsystem grammar. - (line 235) + (line 293) -File: asdf.info, Node: Function and Class Index, Next: Variable Index, Prev: Concept Index, Up: Top +File: asdf.info, Node: Function and Macro Index, Next: Variable Index, Prev: Concept Index, Up: Top -Function and Class Index +Function and Macro Index ************************ �[index�] @@ -5670,8 +5810,6 @@ Function and Class Index * apply-output-translations: Output location API. (line 36) * asdf-version: How do I detect the ASDF version?. (line 6) -* binary-op (obsolete): What happened to the bundle operations. - (line 6) * clear-configuration: Resetting the ASDF configuration. (line 10) * clear-output-translations: Configuring where ASDF stores object files. @@ -5685,38 +5823,26 @@ Function and Class Index * coerce-name <1>: Components. (line 140) * coerce-name <2>: Common attributes of components. (line 12) -* compile-bundle-op: What happened to the bundle operations. - (line 6) -* compile-bundle-op,: Predefined operations of ASDF. - (line 93) * compile-file*: Controlling file compilation. (line 6) -* compile-op: Predefined operations of ASDF. - (line 11) * compile-system: Convenience Functions. - (line 38) -* component: The object model of ASDF. - (line 6) + (line 35) * component-depends-on: Creating new operations. (line 45) * component-pathname: Common attributes of components. - (line 155) -* concatenate-source-op,: Predefined operations of ASDF. - (line 178) + (line 154) +* define-package: The package-inferred-system extension. + (line 64) * defsystem: The defsystem form. (line 6) * defsystem <1>: A more involved example. (line 6) * defsystem <2>: The defsystem grammar. (line 6) -* deliver-asd-op: What happened to the bundle operations. - (line 6) * disable-output-translations: Output location API. (line 17) * enable-asdf-binary-locations-compatibility: Output Backward Compatibility. (line 27) * ensure-output-translations: Output location API. (line 31) * ensure-source-registry: Configuration API. (line 28) -* fasl-op (obsolete): What happened to the bundle operations. - (line 6) * file-type: Pitfalls of the transition to ASDF 2. (line 77) * find-component: Creating new operations. @@ -5730,55 +5856,30 @@ Function and Class Index * input-files <1>: Creating new operations. (line 88) * load-asd: The defsystem form. (line 6) -* load-bundle-op: What happened to the bundle operations. - (line 6) -* load-fasl-op (obsolete): What happened to the bundle operations. - (line 6) -* load-op: Predefined operations of ASDF. - (line 25) -* load-source-op,: Predefined operations of ASDF. - (line 45) * load-system: Convenience Functions. (line 29) * locate-system: Components. (line 97) * make: Convenience Functions. - (line 54) + (line 51) * make-operation: Operations. (line 78) * merge-pathnames*: Some Utility Functions. (line 63) -* module: Pre-defined subclasses of component. - (line 23) -* monolithic-binary-op (obsolete): What happened to the bundle operations. - (line 6) -* monolithic-compile-bundle-op: What happened to the bundle operations. - (line 6) -* monolithic-deliver-asd-op: What happened to the bundle operations. - (line 6) -* monolithic-fasl-op (obsolete): What happened to the bundle operations. - (line 6) -* monolithic-load-bundle-op: What happened to the bundle operations. - (line 6) -* monolithic-load-fasl-op (obsolete): What happened to the bundle operations. - (line 6) * oos: Convenience Functions. (line 21) * oos <1>: Operations. (line 33) * operate: Convenience Functions. (line 21) * operate <1>: Operations. (line 31) -* operation: The object model of ASDF. - (line 6) * operation-done-p: Creating new operations. (line 92) -* OPERATION-ERROR: Error handling. (line 5) * output-files: Creating new operations. (line 33) +* package-inferred-system: The package-inferred-system extension. + (line 6) * parse-unix-namestring: Some Utility Functions. (line 13) * perform: Creating new operations. (line 19) -* prepare-op: Predefined operations of ASDF. - (line 38) * primary-system-name: Components. (line 70) * primary-system-name <1>: Components. (line 91) * register-immutable-system: Operations. (line 67) @@ -5786,25 +5887,22 @@ Function and Class Index (line 87) * register-preloaded-system: Miscellaneous Functions. (line 61) +* register-system-packages: The package-inferred-system extension. + (line 58) * require-system: Convenience Functions. - (line 65) + (line 62) * run-program: Some Utility Functions. (line 90) * run-shell-command: Miscellaneous Functions. (line 110) * slurp-input-stream: Some Utility Functions. (line 162) -* source-file: Pre-defined subclasses of component. - (line 6) * source-file-type: Pitfalls of the transition to ASDF 2. (line 77) * subpathname: Some Utility Functions. (line 72) * subpathname*: Some Utility Functions. (line 85) -* system: Pre-defined subclasses of component. - (line 51) -* SYSTEM-DEFINITION-ERROR: Error handling. (line 6) * system-defsystem-depends-on: Information about system dependencies. (line 10) * system-depends-on: Information about system dependencies. @@ -5817,17 +5915,17 @@ Function and Class Index (line 25) * system-weakly-depends-on: Information about system dependencies. (line 14) -* test-op: Predefined operations of ASDF. - (line 52) * test-system: Convenience Functions. - (line 49) + (line 46) * traverse: Operations. (line 75) +* uiop:define-package: The package-inferred-system extension. + (line 64) * version-satisfies: Common attributes of components. (line 23) * version-satisfies <1>: Functions. (line 6) -File: asdf.info, Node: Variable Index, Prev: Function and Class Index, Up: Top +File: asdf.info, Node: Variable Index, Next: Class and Type Index, Prev: Function and Macro Index, Up: Top Variable Index ************** @@ -5845,8 +5943,6 @@ Variable Index (line 14) * *LOAD-PATHNAME*: LOAD-PATHNAME has a weird value. (line 6) -* *load-system-operation*: Convenience Functions. - (line 29) * *LOAD-TRUENAME*: LOAD-PATHNAME has a weird value. (line 6) * *nil-pathname*: Some Utility Functions. @@ -5863,145 +5959,258 @@ Variable Index * ASDF_OUTPUT_TRANSLATIONS: Controlling where ASDF saves compiled files. (line 6) + +File: asdf.info, Node: Class and Type Index, Prev: Variable Index, Up: Top + +Class and Type Index +******************** + +�[index�] +* Menu: + +* binary-op (obsolete): What happened to the bundle operations. + (line 6) +* compile-bundle-op: Predefined operations of ASDF. + (line 94) +* compile-bundle-op <1>: What happened to the bundle operations. + (line 6) +* compile-concatenated-source-op: Predefined operations of ASDF. + (line 189) +* compile-op: Predefined operations of ASDF. + (line 11) +* component: The object model of ASDF. + (line 6) +* concatenate-source-op: Predefined operations of ASDF. + (line 186) +* deliver-asd-op: Predefined operations of ASDF. + (line 98) +* deliver-asd-op <1>: What happened to the bundle operations. + (line 6) +* dll-op: Predefined operations of ASDF. + (line 102) +* fasl-op (obsolete): What happened to the bundle operations. + (line 6) +* image-op: Predefined operations of ASDF. + (line 104) +* lib-op: Predefined operations of ASDF. + (line 100) +* load-bundle-op: Predefined operations of ASDF. + (line 96) +* load-bundle-op <1>: What happened to the bundle operations. + (line 6) +* load-compiled-concatenated-source-op: Predefined operations of ASDF. + (line 190) +* load-concatenated-source-op: Predefined operations of ASDF. + (line 188) +* load-fasl-op (obsolete): What happened to the bundle operations. + (line 6) +* load-op: Predefined operations of ASDF. + (line 25) +* load-source-op: Predefined operations of ASDF. + (line 45) +* module: Pre-defined subclasses of component. + (line 23) +* monolithic-binary-op (obsolete): What happened to the bundle operations. + (line 6) +* monolithic-compile-bundle-op: Predefined operations of ASDF. + (line 95) +* monolithic-compile-bundle-op <1>: What happened to the bundle operations. + (line 6) +* monolithic-compile-concatenated-source-op: Predefined operations of ASDF. + (line 192) +* monolithic-concatenate-source-op: Predefined operations of ASDF. + (line 187) +* monolithic-deliver-asd-op: Predefined operations of ASDF. + (line 99) +* monolithic-deliver-asd-op <1>: What happened to the bundle operations. + (line 6) +* monolithic-dll-op: Predefined operations of ASDF. + (line 103) +* monolithic-fasl-op (obsolete): What happened to the bundle operations. + (line 6) +* monolithic-lib-op: Predefined operations of ASDF. + (line 101) +* monolithic-load-bundle-op: Predefined operations of ASDF. + (line 97) +* monolithic-load-bundle-op <1>: What happened to the bundle operations. + (line 6) +* monolithic-load-compiled-concatenated-source-op: Predefined operations of ASDF. + (line 193) +* monolithic-load-concatenated-source-op: Predefined operations of ASDF. + (line 191) +* monolithic-load-fasl-op (obsolete): What happened to the bundle operations. + (line 6) +* operation: The object model of ASDF. + (line 6) +* operation-error: Error handling. (line 5) +* prepare-op: Predefined operations of ASDF. + (line 38) +* prepare-source-op: Predefined operations of ASDF. + (line 46) +* program-op: Predefined operations of ASDF. + (line 105) +* source-file: Pre-defined subclasses of component. + (line 6) +* system: Pre-defined subclasses of component. + (line 51) +* system-definition-error: Error handling. (line 6) +* test-op: Predefined operations of ASDF. + (line 53) + Tag Table: -Node: Top1684 -Node: Introduction7796 -Node: Quick start summary10155 -Node: Loading ASDF11862 -Node: Loading a pre-installed ASDF12164 -Ref: Loading a pre-installed ASDF-Footnote-113977 -Node: Checking whether ASDF is loaded14159 -Node: Upgrading ASDF15073 -Node: Replacing your implementation's ASDF16061 -Node: Loading ASDF from source17485 -Node: Configuring ASDF18586 -Node: Configuring ASDF to find your systems19359 -Ref: Configuring ASDF to find your systems-Footnote-122664 -Ref: Configuring ASDF to find your systems-Footnote-222911 -Ref: Configuring ASDF to find your systems-Footnote-323193 -Node: Configuring ASDF to find your systems --- old style23654 -Ref: Configuring ASDF to find your systems --- old style-Footnote-127258 -Ref: Configuring ASDF to find your systems --- old style-Footnote-227490 -Ref: Configuring ASDF to find your systems --- old style-Footnote-328257 -Node: Configuring where ASDF stores object files28413 -Node: Resetting the ASDF configuration29816 -Node: Using ASDF30873 -Node: Loading a system31084 -Node: Convenience Functions32101 -Ref: Convenience Functions-Footnote-137461 -Node: Moving on37539 -Node: Defining systems with defsystem37910 -Node: The defsystem form38338 -Node: A more involved example41744 -Ref: A more involved example-Footnote-148726 -Node: The defsystem grammar49408 -Ref: if-feature-option67366 -Node: Other code in .asd files68909 -Node: The package-inferred-system extension70045 -Node: The object model of ASDF74312 -Ref: The object model of ASDF-Footnote-176643 -Ref: The object model of ASDF-Footnote-276995 -Node: Operations77322 -Ref: operate78427 -Ref: make-operation81163 -Node: Predefined operations of ASDF81584 -Ref: test-op83698 -Node: Creating new operations91587 -Node: Components96800 -Ref: System names100284 -Ref: Components-Footnote-1104956 -Ref: Components-Footnote-2105252 -Node: Common attributes of components105574 -Ref: required-features107136 -Node: Pre-defined subclasses of component112983 -Node: Creating new component types115417 -Node: Dependencies116707 -Node: Functions118578 -Node: Controlling where ASDF searches for systems120412 -Node: Configurations121034 -Node: Truenames and other dangers124509 -Node: XDG base directory125795 -Node: Backward Compatibility127209 -Node: Configuration DSL127925 -Node: Configuration Directories133480 -Node: The here directive135307 -Node: Shell-friendly syntax for configuration137200 -Node: Search Algorithm138217 -Node: Caching Results140087 -Node: Configuration API143335 -Node: Introspection145374 -Node: *source-registry-parameter* variable145638 -Node: Information about system dependencies146207 -Node: Status147123 -Node: Rejected ideas147578 -Node: TODO149959 -Node: Credits for the source-registry150144 -Node: Controlling where ASDF saves compiled files150679 -Ref: Controlling where ASDF saves compiled files-Footnote-1152091 -Node: Output Configurations152135 -Ref: Output Configurations-Footnote-1154996 -Node: Output Backward Compatibility155062 -Node: Output Configuration DSL157788 -Node: Output Configuration Directories163243 -Node: Output Shell-friendly syntax for configuration164800 -Node: Semantics of Output Translations166319 -Node: Output Caching Results167888 -Node: Output location API168368 -Node: Credits for output translations170790 -Node: Error handling171310 -Node: Miscellaneous additional functionality172151 -Node: Controlling file compilation172623 -Node: Controlling source file character encoding175889 -Node: Miscellaneous Functions182706 -Ref: system-relative-pathname183003 -Ref: Miscellaneous Functions-Footnote-1189450 -Node: Some Utility Functions189561 -Node: Getting the latest version200339 -Node: FAQ201284 -Node: Where do I report a bug?201679 -Node: Mailing list202044 -Node: What has changed between ASDF 1 ASDF 2 and ASDF 3?202379 -Node: What are ASDF 1 2 3?204553 -Node: How do I detect the ASDF version?205594 -Node: ASDF can portably name files in subdirectories207901 -Node: Output translations209451 -Node: Source Registry Configuration210478 -Node: Usual operations are made easier to the user212105 -Node: Many bugs have been fixed212691 -Node: ASDF itself is versioned214523 -Node: ASDF can be upgraded215398 -Node: Decoupled release cycle216550 -Node: Pitfalls of the transition to ASDF 2217479 -Node: Pitfalls of the upgrade to ASDF 3221749 -Ref: reinitializeASDFAfterUpgrade225451 -Ref: Pitfalls of the upgrade to ASDF 3-Footnote-1226323 -Node: What happened to the bundle operations226493 -Node: Issues with installing the proper version of ASDF227658 -Node: My Common Lisp implementation comes with an outdated version of ASDF. What to do?228219 -Node: I'm a Common Lisp implementation vendor. When and how should I upgrade ASDF?229152 -Node: After upgrading ASDF233064 -Node: Issues with configuring ASDF234715 -Node: How can I customize where fasl files are stored?235090 -Node: How can I wholly disable the compiler output cache?236183 -Node: Issues with using and extending ASDF to define systems237562 -Node: How can I cater for unit-testing in my system?238359 -Node: How can I cater for documentation generation in my system?239247 -Node: How can I maintain non-Lisp (e.g. C) source files?239768 -Ref: report-bugs240200 -Node: I want to put my module's files at the top level. How do I do this?240200 -Node: How do I create a system definition where all the source files have a .cl extension?243350 -Node: How do I mark a source file to be loaded only and not compiled?245323 -Node: How do I work with readtables?246319 -Node: How can I capture ASDF's output?250046 -Node: LOAD-PATHNAME has a weird value250517 -Node: ASDF development FAQs252003 -Node: How do I run the tests interactively in a REPL?252242 -Node: Ongoing Work253809 -Node: Bibliography254088 -Node: Concept Index257635 -Node: Function and Class Index264630 -Node: Variable Index276404 +Node: Top1689 +Node: Introduction7825 +Node: Quick start summary10254 +Node: Loading ASDF12017 +Node: Loading a pre-installed ASDF12319 +Ref: Loading a pre-installed ASDF-Footnote-114154 +Node: Checking whether ASDF is loaded14354 +Node: Upgrading ASDF15268 +Node: Replacing your implementation's ASDF16266 +Node: Loading ASDF from source17718 +Node: Configuring ASDF18841 +Node: Configuring ASDF to find your systems19614 +Ref: Configuring ASDF to find your systems-Footnote-123015 +Ref: Configuring ASDF to find your systems-Footnote-223266 +Ref: Configuring ASDF to find your systems-Footnote-323568 +Node: Configuring ASDF to find your systems --- old style24041 +Ref: Configuring ASDF to find your systems --- old style-Footnote-127717 +Ref: Configuring ASDF to find your systems --- old style-Footnote-227955 +Ref: Configuring ASDF to find your systems --- old style-Footnote-328758 +Node: Configuring where ASDF stores object files28914 +Node: Resetting the ASDF configuration30323 +Node: Using ASDF31416 +Node: Loading a system31627 +Node: Convenience Functions32702 +Ref: Convenience Functions-Footnote-138049 +Node: Moving on38131 +Node: Defining systems with defsystem38504 +Node: The defsystem form38932 +Node: A more involved example42467 +Ref: A more involved example-Footnote-149720 +Node: The defsystem grammar50428 +Ref: Component types56203 +Ref: System class names56685 +Ref: Build-operation57894 +Ref: Pathname specifiers59480 +Ref: Version specifiers63516 +Ref: Feature dependencies65765 +Ref: Using logical pathnames66636 +Ref: if-feature option71277 +Ref: Entry point72414 +Ref: feature requirement73144 +Node: Other code in .asd files73562 +Node: The package-inferred-system extension74734 +Node: The object model of ASDF80499 +Ref: The object model of ASDF-Footnote-182886 +Ref: The object model of ASDF-Footnote-283250 +Node: Operations83585 +Ref: operate84712 +Ref: make-operation87510 +Node: Predefined operations of ASDF87955 +Ref: test-op90187 +Node: Creating new operations98428 +Node: Components103833 +Ref: System names107455 +Ref: Components-Footnote-1112273 +Ref: Components-Footnote-2112585 +Node: Common attributes of components112915 +Ref: required-features114437 +Node: Pre-defined subclasses of component120377 +Node: Creating new component types122877 +Node: Dependencies124185 +Node: Functions126114 +Node: Controlling where ASDF searches for systems127971 +Node: Configurations128593 +Node: Truenames and other dangers132160 +Node: XDG base directory133468 +Node: Backward Compatibility134914 +Node: Configuration DSL135645 +Node: Configuration Directories141208 +Node: The here directive143075 +Node: Shell-friendly syntax for configuration145002 +Node: Search Algorithm146077 +Node: Caching Results147971 +Node: Configuration API151279 +Node: Introspection153362 +Node: *source-registry-parameter* variable153626 +Node: Information about system dependencies154205 +Node: Status155125 +Node: Rejected ideas155588 +Node: TODO158041 +Node: Credits for the source-registry158228 +Node: Controlling where ASDF saves compiled files158764 +Ref: Controlling where ASDF saves compiled files-Footnote-1160194 +Node: Output Configurations160246 +Ref: Output Configurations-Footnote-1163135 +Node: Output Backward Compatibility163205 +Node: Output Configuration DSL166013 +Node: Output Configuration Directories171584 +Node: Output Shell-friendly syntax for configuration173173 +Node: Semantics of Output Translations174736 +Node: Output Caching Results176305 +Node: Output location API176785 +Node: Credits for output translations179253 +Node: Error handling179782 +Node: Miscellaneous additional functionality180643 +Node: Controlling file compilation181115 +Node: Controlling source file character encoding184453 +Node: Miscellaneous Functions191504 +Ref: system-relative-pathname191801 +Ref: Miscellaneous Functions-Footnote-1198363 +Node: Some Utility Functions198478 +Node: Getting the latest version209646 +Node: FAQ210609 +Node: Where do I report a bug?211004 +Node: Mailing list211375 +Node: What has changed between ASDF 1 ASDF 2 and ASDF 3?211714 +Node: What are ASDF 1 2 3?213909 +Node: How do I detect the ASDF version?214954 +Node: ASDF can portably name files in subdirectories217313 +Node: Output translations218872 +Node: Source Registry Configuration219915 +Node: Usual operations are made easier to the user221552 +Node: Many bugs have been fixed222162 +Node: ASDF itself is versioned224014 +Node: ASDF can be upgraded224897 +Node: Decoupled release cycle226051 +Node: Pitfalls of the transition to ASDF 2226982 +Node: Pitfalls of the upgrade to ASDF 3231372 +Ref: reinitializeASDFAfterUpgrade235124 +Ref: Pitfalls of the upgrade to ASDF 3-Footnote-1236000 +Node: What happened to the bundle operations236174 +Node: Issues with installing the proper version of ASDF237423 +Node: My Common Lisp implementation comes with an outdated version of ASDF. What to do?237986 +Node: I'm a Common Lisp implementation vendor. When and how should I upgrade ASDF?238925 +Node: After upgrading ASDF242951 +Node: Issues with configuring ASDF244612 +Node: How can I customize where fasl files are stored?244987 +Node: How can I wholly disable the compiler output cache?246109 +Node: Issues with using and extending ASDF to define systems247516 +Node: How can I cater for unit-testing in my system?248313 +Node: How can I cater for documentation generation in my system?249217 +Node: How can I maintain non-Lisp (e.g. C) source files?249746 +Ref: report-bugs250192 +Node: I want to put my module's files at the top level. How do I do this?250192 +Node: How do I create a system definition where all the source files have a .cl extension?253398 +Node: How do I mark a source file to be loaded only and not compiled?255403 +Node: How do I work with readtables?256405 +Node: How can I capture ASDF's output?260230 +Node: LOAD-PATHNAME has a weird value260711 +Node: ASDF development FAQs262225 +Node: How do I run the tests interactively in a REPL?262464 +Node: Ongoing Work264033 +Node: Bibliography264316 +Node: Concept Index269741 +Node: Function and Macro Index277332 +Node: Variable Index285976 +Node: Class and Type Index287975 End Tag Table + + +Local Variables: +coding: utf-8 +End: diff --git a/src/contrib/asdf/doc/asdf.pdf b/src/contrib/asdf/doc/asdf.pdf index feb3ee18885189ac7b8b034082187bae0cbdc8a6..8dc866affd88d9f323422948c83ed0c186a0a1e3 100644 Binary files a/src/contrib/asdf/doc/asdf.pdf and b/src/contrib/asdf/doc/asdf.pdf differ