Better document how to use list-of
authorFrancois-Rene Rideau <tunes@google.com>
Mon, 2 Jul 2012 04:48:00 +0000 (00:48 -0400)
committerFrancois-Rene Rideau <tunes@google.com>
Mon, 2 Jul 2012 04:48:00 +0000 (00:48 -0400)
README.list-of
asdf-finalizers-test.asd

index 22f5dd6..4fa33f4 100644 (file)
@@ -3,8 +3,23 @@ LIST-OF
 This library exemplifies how to use ASDF-FINALIZERS,
 and offers a way to implement lists with a uniform type of elements.
 
+Because of its reliance on ASDF-FINALIZERS,
+any file that directly or indirectly (via macro-expansion) uses LIST-OF
+must include (ASDF-FINALIZERS:FINAL-FORMS) as its last form
+you probably want to have your package :use :asdf-finalizers, and
+you probably also need to in your defsystem to either
+  :depends-on (:list-of)
+  :around-compile "asdf-finalizers:check-finalizers-around-compile"
+or to
+  :depends-on (:list-of)
+  :defsystem-depends-on (:asdf-finalizers)
+  :default-component-class :finalized-cl-source-file
+
+
 ==== Exported Functionality ====
 
+LIST-OF defines the LIST-OF package from which it exports:
+
 DEFTYPE LIST-OF (TYPE)
   type of proper lists all of the elements of which are of given TYPE.
   Beware: the type checking predicate may never stop when fed a circular list.
index 1763940..ecefc44 100644 (file)
@@ -2,6 +2,6 @@
 
 (asdf:defsystem :asdf-finalizers-test
   :defsystem-depends-on (:asdf-finalizers)
-  :depends-on (:list-of :fare-utils :hu.dwim.stefil)
   :around-compile "asdf-finalizers:check-finalizers-around-compile"
+  :depends-on (:list-of :fare-utils :hu.dwim.stefil)
   :components ((:file "asdf-finalizers-test")))