From eb45d7cce30ab6fd7e6d5b882d09b26edc2caaf5 Mon Sep 17 00:00:00 2001 From: Francois-Rene Rideau <tunes@google.com> Date: Thu, 4 Sep 2014 20:17:13 -0400 Subject: [PATCH] Update doc regarding availability of persistent source-registry cache and install-asdf script. --- doc/asdf.texinfo | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/doc/asdf.texinfo b/doc/asdf.texinfo index 2c383294..2f41dfd4 100644 --- a/doc/asdf.texinfo +++ b/doc/asdf.texinfo @@ -505,10 +505,10 @@ You can invoke it from the shell command-line as or you can @code{(load "tools/install-asdf.lisp")} from your Lisp REPL. It works on -Allegro CL, Clozure CL, CMU CL, GNU CLISP, LispWorks, SBCL, SCL, XCL. -It doesn't work on ABCL, Corman CL, ECL, GCL, Genera, MCL, MKCL, MOCL. -Happily, ABCL, ECL and MKCL are usually pretty up to date and shouldn't need that script. -GCL would be supported, except that so far is still lacking usable support for @code{require}. +Allegro CL, Clozure CL, CMU CL, ECL, GCL, GNU 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 for lack of success compiling it. Corman CL, Genera, MCL are obsolete anyway. MOCL is under development. @@ -3453,7 +3453,7 @@ The list can also be empty, allowing to stop a costly recursion in a huge direct To update such a cache after you install, update or remove source repositories, you can run a script distributed with ASDF: -@code{./tools/cl-source-registry-cache.lisp @emph{/path/to/directory}}. +@code{tools/cl-source-registry-cache.lisp @emph{/path/to/directory}}. To wholly invalidate the cache, you can delete the file @file{.cl-source-registry.cache} in that directory. In either case, for an existing Lisp process to see this change, @@ -3469,10 +3469,19 @@ a software source repository or installation package. Finally, advanced developers who juggle with a lot of code in their @code{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 @code{#!/usr/bin/cl} script, -which makes a difference as to their subjective interactivity and usability. +of every @code{#!/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 enough +(3.1.3.7 or later); it is not enough for a recent ASDF upgrade to be present, +since the upgrade will itself be found but +after the old version has scanned the directories without heeding such a cache. +To upgrade the implementation-provided ASDF, +use our script @code{tools/install-asdf.lisp}. @node Configuration API, Introspection, Caching Results, Controlling where ASDF searches for systems -- GitLab