Commit d6584a59 authored by Francois-Rene Rideau's avatar Francois-Rene Rideau

Documentation update. Also compile doc in test-all.

parent 0b8873f9
......@@ -4,8 +4,8 @@ webhome_public := "http://common-lisp.net/project/asdf/"
clnet_home := "/project/asdf/public_html/"
sourceDirectory := $(shell pwd)
lisps ?= ccl clisp sbcl ecl cmucl abcl xcl scl allegro
## occasionally tested by not me: allegromodern lispworks
lisps ?= ccl clisp sbcl ecl cmucl abcl scl allegro
## occasionally tested by not me: allegromodern lispworks xcl
## FAIL: gclcvs (COMPILER BUGS!!!)
## tentatively supported by asdf, not supported by our tests: cormancl mcl genera
......@@ -95,7 +95,7 @@ do-test-all:
${MAKE} do-test lisp=$$lisp || exit 1 ; \
done
test-all: test-forward-references test-upgrade do-test-all
test-all: test-forward-references doc test-upgrade do-test-all
# Note that the debian git at git://git.debian.org/git/pkg-common-lisp/cl-asdf.git is stale,
# as we currently build directly from upstream at git://common-lisp.net/projects/asdf/asdf.git
......@@ -113,7 +113,7 @@ replace-sbcl-asdf:
replace-ccl-asdf:
ccl --eval '(progn(compile-file "asdf.lisp" :output-file (format nil "~Atools/asdf.lx64fsl" (ccl::ccl-directory)))(quit))'
WRONGFUL_TAGS := 1.1720 README RELEASE STABLE
WRONGFUL_TAGS := 1.37 1.1720 README RELEASE STABLE
# Delete wrongful tags from local repository
fix-local-git-tags:
for i in ${WRONGFUL_TAGS} ; do git tag -d $$i ; done
......
......@@ -431,7 +431,7 @@ between the machine where you save it at the time you save it
and the machine you resume it at the time you resume it.
@section Configuring ASDF to find your systems -- old style
@section Configuring ASDF to find your systems --- old style
The old way to configure ASDF to find your systems is by
@code{push}ing directory pathnames onto the variable
......@@ -498,7 +498,8 @@ instead of pushing each of the many involved directories
to the @code{asdf:*central-registry*}.
ASDF knows how to follow such @emph{symlinks}
to the actual file location when resolving the paths of system components
(on Windows, you can use Windows shortcuts instead of POSIX symlinks).
(on Windows, you can use Windows shortcuts instead of POSIX symlinks;
if you try aliases under MacOS, we are curious to hear about your experience).
For example, if @code{#p"/home/me/cl/systems/"} (note the trailing slash)
is a member of @code{*central-registry*}, you could set up the
......@@ -1898,7 +1899,7 @@ ASDF will first search for @code{.asd} files in the directories specified in
@code{asdf:*central-registry*}
before it searches in the source registry above.
@xref{Configuring ASDF,,Configuring ASDF to find your systems -- old style}.
@xref{Configuring ASDF,,Configuring ASDF to find your systems --- old style}.
By default, @code{asdf:*central-registry*} will be empty.
......@@ -1963,27 +1964,36 @@ EXCLUSION-PATTERN := a string without wildcards, that will be matched exactly
Pathnames are designated using another DSL,
shared with the output-translations configuration DSL below.
The DSL is resolved by the function @code{asdf::resolve-location},
to be documented and exported at some point in the future.
@example
ABSOLUTE-COMPONENT-DESIGNATOR :=
(ABSOLUTE-COMPONENT-DESIGNATOR RELATIVE-COMPONENT-DESIGNATOR ...) |
STRING | ;; namestring (better be absolute or bust, directory assumed where applicable)
;; on MCL, a MacOSX-style POSIX namestring (for MacOS9 style, use #p"...")
;; in output-translations, directory is assumed and **/*.*.* added if it's last
STRING | ;; namestring (better be absolute or bust, directory assumed where applicable).
;; In output-translations, directory is assumed and **/*.*.* added if it's last.
;; On MCL, a MacOSX-style POSIX namestring (for MacOS9 style, use #p"...");
;; Note that none of the above applies to strings used in *central-registry*,
;; which doesn't use this DSL: they are processed as normal namestrings.
;; however, you can compute what you put in the *central-registry*
;; based on the results of say (asdf::resolve-location "/Users/fare/cl/cl-foo/")
PATHNAME | ;; pathname (better be an absolute path, or bust)
;; In output-translations, unless followed by relative components,
;; it better have appropriate wildcards, as in **/*.*.*
:HOME | ;; designates the user-homedir-pathname ~/
:USER-CACHE | ;; designates the default location for the user cache
:HERE | ;; designates the location of the configuration file
;; (or *default-pathname-defaults*, if invoked interactively)
:ROOT ;; magic, for output-translations source only: paths that are relative to the root of the source host and device
:ROOT ;; magic, for output-translations source only: paths that are relative
;; to the root of the source host and device
;; Not valid anymore: :SYSTEM-CACHE (was a security hazard)
RELATIVE-COMPONENT-DESIGNATOR :=
(RELATIVE-COMPONENT-DESIGNATOR RELATIVE-COMPONENT-DESIGNATOR ...) |
STRING | ;; relative directory pathname as interpreted by coerce-pathname
;; in output translations, if last component, **/*.*.* is added
STRING | ;; relative directory pathname as interpreted by coerce-pathname.
;; In output translations, if last component, **/*.*.* is added
PATHNAME | ;; pathname; unless last component, directory is assumed.
:IMPLEMENTATION | ;; a directory based on implementation, e.g. sbcl-1.0.49-linux-x64
:IMPLEMENTATION | ;; directory based on implementation, e.g. sbcl-1.0.49-linux-x64
:IMPLEMENTATION-TYPE | ;; a directory based on lisp-implementation-type only, e.g. sbcl
:DEFAULT-DIRECTORY | ;; a relativized version of the default directory
:*/ | ;; any direct subdirectory (since ASDF 2.011.4)
......
......@@ -62,19 +62,20 @@
that seem to have any current user base.
</p><p>
Most implementations provide ASDF 2 as a module,
and you can simply <tt>(require :asdf)</tt> or <tt>(require "asdf")</tt>.
and you can simply <tt>(require "asdf")</tt> or <tt>(require :asdf)</tt>.
Note that most implementations accept
<tt>:asdf</tt>, <tt>"ASDF"</tt> and <tt>"asdf"</tt>
indiscriminately, but that as exceptions,
CMUCL accepts only upper-case (or a case-converted symbol),
whereas CLISP accepts only lower-case
(in a string, or again a case-converted symbol again).
indiscriminately, but that there are exceptions:
CLISP accepts only lower-case
(in a string, or a properly escaped lower-case symbol),
whereas unless you use a recent version from June 2011 or later,
CMUCL accepts only upper-case (or a case-converted symbol).
</p><p>
A few implementations don't provide ASDF yet,
but have announced they will in their next release.
As for remaining implementations,
they are obsolete or mostly unmaintained,
ASDF 2 supports them if you load it manually,
they are obsolete and/or mostly unmaintained;
still ASDF 2 supports them if you load it manually,
though there might never be a next release
to provide it through <tt>require</tt>.
</p>
......@@ -234,7 +235,7 @@ Peter Graves <gnooth@gmail.com>
<a class="nav" href="http://common-lisp.net/" title="Common-Lisp.net"> <img src="http://common-lisp.net/project/cl-containers/shared/buttons/lisp-lizard.png" width="80" height="15" title="Common-Lisp.net" alt="Common-Lisp.net button" /></a>
<p><span class="copyright"Copyright &copy; 2001-2011 Daniel Barlow and contributors</span></p>
<p>ASDF has an <a href="http://www.opensource.org/licenses/mit-license.php">MIT style</a> license</p>
<div id="timestamp">Last updated 2011-06-08</div>
<div id="timestamp">Last updated 2011-06-18</div>
</div>
</body>
</html>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment