Changeset 13636

Timestamp:

10/20/11 18:05:30 (10 years ago)

Author:

Mark Evenson

Message:

Document the ABCL-ASDF contrib which dynamically loads JVM dependencies.

Smooth voice.

File:

• trunk/abcl/doc/manual/abcl.tex (modified) (7 diffs)

trunk/abcl/doc/manual/abcl.tex

@@ -23 +23 @@
 
 \textsc{ABCL} is packaged as a single jar file usually named either
-``abcl.jar'' or something like``abcl-0.28.0.jar'' if you are using a
+``abcl.jar'' or possibly``abcl-0.28.0.jar'' if you are using a
 versioned package from your system vendor.  This byte archive can be
 executed under the control of a suitable JVM by using the ``-jar''
@@ -94 +94 @@
   \item The generic function signatures of the DOCUMENTATION symbol do
     not match the CLHS.
+  \item The TIME form does not return a proper VALUES to its caller.
 \end{itemize}
 
@@ -756 +757 @@
 \section{Extensible Sequences}
 
-\ref{RHODES2007}
+See \ref{RHODES2007} RHODES2007 for the design.
 
 The SEQUENCE package fully implements Christopher Rhodes' proposal for
@@ -831 +832 @@
 code is greater than 0x00ff.
 
+\subsection{JSS optionally extends the Reader}
+
+The JSS contrib consitutes an additional, optional extension to the
+reader in the definition of the #\" reader macro.
+
 \section{ASDF}
 
@@ -853 +859 @@
 and MVN.
 
-\section{asdf-install}
-
-An implementation of ASDF-INSTALL.  Superceded by Quicklisp (qv.)
-
 \section{asdf-jar}
 
@@ -864 +866 @@
 required source and fasls in a jar archive.
 
+\section{abcl-asdf}
+
+ABCL specific contributions to ASDF system definition mainly concerned
+with finding JVM artifacts such as jar archives to be dynamically loaded.
+
+\subsection{ABCL-ASDF Examples}
+
+\begin{listing-lisp}
+    ;;;; -*- Mode: LISP -*-
+    (in-package :asdf)
+
+    (defsystem :log4j
+      :components ((:mvn "log4j/log4j" 
+                    :version "1.4.9")))
+\end{listing-lisp}
+
+\subsection{abcl-asdf API}
+
+We define an API as consisting of the following ASDF classes:
+
+\textsc[JAR-DIRECTORY}, \textsc{JAR-FILE}, and
+\textsc{CLASS-FILE-DIRECTORY} for JVM artifacts that have a currently
+valid pathname representation
+
+And the MVN and IRI classes descend from ASDF-COMPONENT, but do not
+directly have a filesystem location.
+
+For use outside of ASDF, we currently define one method,
+\textsc{RESOLVE-DEPENDENCIES} which locates, downloads, caches, and then loads
+into the currently executing JVM process all recursive dependencies
+annotated in the Maven pom.xml graph.
+
+\subsection{ABCL-ASDF Example 2}
+
+Bypassing ASDF, one can directly issue requests for the Maven
+artifacts to be downloaded
+
+\begin{listing-lisp}
+    CL-USER> (abcl-asdf:resolve-dependencies "com.google.gwt" "gwt-user")
+    WARNING: Using LATEST for unspecified version.
+    "/Users/evenson/.m2/repository/com/google/gwt/gwt-user/2.4.0-rc1/gwt-user-2.4.0-rc1.jar:/Users/evenson/.m2/repository/javax/validation/validation-api/1.0.0.GA/validation-api-1.0.0.GA.jar:/Users/evenson/.m2/repository/javax/validation/validation-api/1.0.0.GA/validation-api-1.0.0.GA-sources.jar"
+\end{listing-lisp}
+
+Notice that all recursive dependencies have been located and installed
+as well.
+
+
 \section{jss}
 
@@ -880 +929 @@
   CL-USER) (#"propertyNames" (#"getProperties" 'java.lang.System))
 \end{listing-lisp}
+
+\section{asdf-install}
+
+An implementation of ASDF-INSTALL.  Superseded by Quicklisp (qv.)
 
 \chapter{History}