diff --git a/doc/asdf.texinfo b/doc/asdf.texinfo index 0ad7e509861e52963cfaeaaa341d74ebe706b47d..f83a1efc6187bbd1ab7d655b0b6f1f3c5a6a92b7 100644 --- a/doc/asdf.texinfo +++ b/doc/asdf.texinfo @@ -258,7 +258,7 @@ Issues with using and extending ASDF to define systems ASDF development FAQs -* How do run the tests interactively in a REPL?:: +* How do I run the tests interactively in a REPL?:: @end detailmenu @end menu @@ -1112,7 +1112,10 @@ Only period-separated non-negative integers are accepted at present. See below Version specifiers in @ref{The defsystem grammar}. @item -This file contains a single @code{defsystem} declaration. +This file contains a single form, the @code{defsystem} declaration. +No @code{in-package} form, no @code{asdf:} package prefix, no nothing. +Just the one naked @code{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 future-proof. @@ -4959,7 +4962,6 @@ plus many implementations that previously did not. ASDF has been made to work with all actively maintained CL implementations and even a few implementations that are @emph{not} actively maintained. -@xref{FAQ,,``What has changed between ASDF 1 ASDF 2 and ASDF 3?''}. Furthermore, it is possible to upgrade from ASDF 1 to ASDF 2 or ASDF 3 on the fly (though we recommend instead upgrading your implementation or replacing its ASDF module). @@ -5461,12 +5463,12 @@ or the code of @url{https://cliki.net/cl-launch,@code{cl-launch}}. 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 @emph{twice}. -One first time, right after you load the old ASDF 2 and before you upgrade to the new ASDF 3, +A first time, right after you load the old ASDF 2 and before you upgrade to the new ASDF 3, so it may find where you put ASDF 3. -One second time, because some implementations can't handle a smooth upgrade to ASDF 3, +A second time, because some implementations can't handle a smooth upgrade to ASDF 3, and lose configuration as they do. @lisp -(require "asdf") +(ignore-errors (funcall 'require "asdf")) ;; <--- try real hard ;; <--- insert heroics here, if that failed to provide ASDF 2 or 3 ;; <--- insert configuration here, if that succeeded (asdf:load-system "asdf") @@ -5495,7 +5497,6 @@ and lose configuration as they do. @code{asdf-ecl} and its short-lived successor @code{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. -@xref{What happened to the bundle operations}. And yet, the feature is not enabled to be used by @code{load-system} by default on ECL as originally intended, because of a bug in ECL itself found during testing. @@ -5990,11 +5991,11 @@ Use from the @code{named-readtables} system the macro @code{named-readtables:def @section ASDF development FAQs @menu -* How do run the tests interactively in a REPL?:: +* How do I run the tests interactively in a REPL?:: @end menu -@node How do run the tests interactively in a REPL?, , ASDF development FAQs, ASDF development FAQs -@subsection How do run the tests interactively in a REPL? +@node How do I run the tests interactively in a REPL?, , ASDF development FAQs, ASDF development FAQs +@subsection How do I run the tests interactively in a REPL? This not-so-frequently asked question is primarily for ASDF developers, but those who encounter an unexpected error in some test may be diff --git a/doc/index.html b/doc/index.html index d6ca8912447a89f3e1ac4f64ec13956cfc388891..b1357ba574d5dffb6f1aafca768498358aa46b3a 100644 --- a/doc/index.html +++ b/doc/index.html @@ -37,14 +37,14 @@ extensibility, configurability, internal consistency, and the ability to deliver standalone executables. Its notable versions include pre-release 2.27 on February 1st 2013, - first release 3.0.0 on May 15th 2013, + first stable release 3.0.1 on May 16th 2013, major release 3.1.2 on May 6th 2014, - and latest release 3.1.4 on October 10th 2014. + and latest release 3.1.5 on July 21st 2015.

What it is

ASDF stands for Another System Definition Facility, - in the continuity of the Lisp DEFSYSTEM of yore. + the successor of the Lisp DEFSYSTEM of yore.

ASDF 3 contains two parts: asdf/defsystem and uiop.

@@ -60,7 +60,7 @@ And you must typically compile and load files that define packages, macros, variables, before you may compile and load other files that use them.

-

It is roughly what Common Lisp hackers use to build and load software +

ASDF is what Common Lisp hackers use to build and load software, where C hackers might use GNU Make to build software and ld.so to load it.

@@ -88,7 +88,7 @@ and the documentation as extracted from its docstrings by HEΛP (beware: you can, though it's not obvious, scroll the list of packages - with a scroll the right of the top-left pane, and then click on the one + with a scrollbar on the right of the top-left pane, and then click on the package you're interested in to browse its symbols).

uiop is distributed as part of the ASDF, @@ -223,6 +223,8 @@ MKCL , SBCL , Scieneer CL (Douglas Crosher) , XCL (Peter Graves) +CLASP +Corman Common Lisp -->

If there is an old or new implementation that we are missing, @@ -310,6 +312,10 @@ XCL (Peter Graves)

Extensions

Known extensions to ASDF include:

Former extensions, now superseded, include: