index.html 16.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>
  <head>
    <title>ASDF - Another System Definition Facility</title>
    <link type='text/css' href='style.css' rel='stylesheet' />
    <meta name="author" content="the ASDF group"/>
  </head>
  <body>
    <div class="header">
      <span class="logo">
        <a href="http://common-lisp.net/project/asdf/" title="ASDF Homepage">
          <img src="lisp-logo120x80.png" title="ASDF homepage" width="100" alt="Lisp Lizzard" />
        </a>
      </span>
      <h2>ASDF</h2><h4>Another System Definition Facility</h4>
    </div>
17
18
19
    <div class="system-links">
      <ul>
        <li><a href="#what_it_is">What it is</a></li>
20
21
        <li><a href="#what_it_is_not">What it is not</a></li>
        <li><a href="#implementations">Supported Implementations</a></li>
22
        <li><a href="#examples">Examples</a></li>
23
24
        <li><a href="#documentation">Documentation</a></li>
        <li><a href="#downloads">Getting it</a></li>
25
        <li><a href="#extensions">Extensions</a></li>
26
        <li><a href="#bugs">Reporting Bugs</a></li>
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
27
        <li><a href="#mailing-lists">Mailing Lists</a></li>
28
29
30
31
        <li><a href="http://common-lisp.net/gitweb?p=projects/asdf/asdf.git;a=log"
               >Changelog</a></li>
      </ul>
    </div>
32
    <div class="contents">
33
34
        <a id="ASDF 2"></a>
        <h3>ASDF 2</h3>
35
        <p>ASDF 2, initially released on May 31st 2010,
36
          is the current successor to Daniel Barlow's ASDF,
37
38
39
          made more portable and more robust, with a somewhat improved API.
          It has since been widely adopted by the CL community,
          and is actively maintained.
40
        </p>
41
42
43
44
45
        <a id="what_it_is"></a>
        <h3>What it is</h3>
        <p>ASDF is a tool for describing how source files are organized:
          what depends on which and when.
        </p>
46
        <p>It is roughly what Common Lisp hackers use to build software
47
48
49
50
51
          where C hackers would use say GNU Make.
        </p>
        <p>ASDF stands for <em>A</em>nother <em>S</em>ystem <em>D</em>efinition <em>F</em>acility,
          in the continuity of the Lisp DEFSYSTEM of yore.
        </p>
52
53
        <a id="what_it_is_not"></a>
        <h3>What it is not</h3>
54
        <p>ASDF will <em>not</em> download missing software components for you.
55
          For that, you want <a href="http://quicklisp.org/">Quicklisp</a>,
56
57
58
59
60
          that builds upon ASDF, and is great for pulling and installing
          tarballs of packages you may depend upon;
          we also recommend <a href="http://common-lisp.net/project/clbuild/">clbuild</a>,
          that now builds upon Quicklisp, as a great tool for pulling from version control
          packages you need to modify or want to contribute to.
61
62
63
64
65
66
67
68
69
70
71
          We recommend you should <em>not</em> use ASDF-Install anymore,
          as it is an older similar piece of software that is both unmaintained and obsolete.
        </p><p>
          If you're unsatisfied with ASDF, other actively maintained build systems for Common-Lisp
          that may or may not satisfy you include:
          Fran&ccedil;ois-Ren&eacute; Rideau's
          <a href="http://common-lisp.net/project/xcvb/">XCVB</a>
          (trying to build object and image files deterministically and in parallel),
          or its polar opposite,
          Drew McDermott's
          <a href="http://cs-www.cs.yale.edu/homes/dvm/">YTools</a>
72
73
          (trying maintain coherence of the current Lisp image at a fine grain),
          or the newcomer
74
75
          <a href="http://lisp.ystok.ru/asdlite/">ASDlite</a>
          (a somewhat improved incompatible variant of ASDF 1).
76
77
78
79
80
81
          Older systems that are not maintained anymore include
          Mark Kantrowitz's <a href="http://www.cliki.net/mk-defsystem">mk-defsystem</a>
          (free software successor of the old proprietary DEFSYSTEM's and predecessor of ASDF),
          Sean Ross's <a href="http://sean-ross.blogspot.com/search/label/mudballs">mudballs</a>
          (aborted attempt at making things cleaner than in ASDF),
          Peter Jetter's <a href="http://www.cliki.net/faslpath">faslpath</a>
82
          (a much simpler system establishing a mapping between packages and files),
83
84
85
86
          Alexander Kahl's <a href="http://www.cliki.net/evol">evol</a>
          (a reimplementation of the GNU autotools stack in Lisp),
          and probably more.
          However, none of these systems seems to ever have had the traction of ASDF.
87
        </p>
88
        <a id="implementations"></a>
89
90
91
92
93
        <h3>Supported Implementations</h3>
        <p>ASDF 2 now supports all CL implementations
          that seem to have any current user base.
        </p><p>
          Most implementations provide ASDF 2 as a module,
94
95
96
          and you can simply <tt>(require "asdf")</tt>.
          (All of them but CLISP also accept
          <tt>:asdf</tt>, <tt>"ASDF"</tt> or <tt>'asdf</tt> as an argument.)
97
98
99
100
        </p><p>
          A few implementations don't provide ASDF yet,
          but have announced they will in their next release.
          As for remaining implementations,
101
102
          they are obsolete and/or mostly unmaintained;
          still ASDF 2 supports them if you load it manually,
103
104
105
106
107
108
109
110
111
          though there might never be a next release
          to provide it through <tt>require</tt>.
        </p>
        <table>
          <tr><th></th>
            <th align="left">Provide "asdf"</th>
            <th align="left">Will provide it</th>
            <th align="left">Obsolete</th></tr>
          <tr><th align="left">Free</th>
112
            <td align="left">abcl ccl clisp cmucl ecl mkcl sbcl xcl</td>
113
114
115
            <td> </td>
            <td align="left">gcl mcl</td></tr>
          <tr><th align="left">Proprietary</th>
116
117
            <td align="left">allegro lispworks</td>
            <td align="left">scl</td>
118
119
120
121
122
123
124
125
126
            <td align="left">cormanlisp genera</td></tr>
        </table>
        <!-- Note to self:
             The maintainers of the following implementations follow asdf-announce:
             allegro	Gary King <gwking@franz.com>
             clisp	(sds)
             ecl	(juanjo)

             The maintainers of the following implementations require direct notification:
127
             abcl ccl cmucl gcl lispworks sbcl mkcl scl xcl
128
129
130
131
132
133
Armed Bear <armedbear-devel@common-lisp.net>,
openmcl-devel@clozure.com,
cmucl-imp@cons.org,
gcl-devel@gnu.org,
lisp-support@lispworks.com,
SBCL Devel-list <sbcl-devel@lists.sourceforge.net>,
134
Jean-Claude Beaudoin <jean.claude.beaudoin@gmail.com>,
135
136
Douglas Crosher <dtc3@scieneer.com>,
Peter Graves <gnooth@gmail.com>
137
        -->
138
139
        <p>
          If there is an old or new implementation that we are missing,
140
          it shouldn't be hard to adapt ASDF to support it.
141
          Ask us!
142
        </p>
143

144
145
146
147
148
149
        <a id="examples"></a>
        <h3>Examples</h3>
        <p>Download any of the many packages available through
          <a href="http://quicklisp.org/">Quicklisp</a>
          to see as many examples.</p>

150
151
152
153
154
155
156
        <a id="documentation"></a>
        <h3>Documentation</h3>
        <p>You can read our manual:</p>
        <ul>
          <li><a href="asdf.html">as one HTML file</a></li>
          <li><a href="asdf/">split into one HTML file per section</a></li>
          <li><a href="asdf.pdf">as a PDF document</a></li>
157
          <li><a href="http://common-lisp.net/gitweb?p=projects/asdf/asdf.git;a=blob;f=doc/asdf.texinfo">as texinfo source</a></li>
158
        </ul>
159
160
        <p>Regarding the internal design of ASDF in general,
          and the work we did on ASDF 2,
161
162
163
164
          see the last draft version of our paper for
          <a href="http://www.international-lisp-conference.org/2010/index">ILC 2010</a>,
          <cite><a href="ilc2010draft.pdf"
                   >Evolving ASDF: More Cooperation, Less Coordination</a></cite></p>
165
166
167
168
169
        <p>Finally, while the manual covers all the basics,
          some advanced or new features remain underdocumented.
          Please contact our mailing-list (see below)
          for any issue that isn't well-documented enough.
        </p>
170

171
        <a id="downloads"></a>
172
173
174
175
176
        <h3>Getting it</h3>
        <p>Though they may lag behind the version here, ASDF comes bundled with most Lisps.
          To get the greatest and latest, you can:
        </p>
        <ul>
177
          <li>download just the latest <em>release</em> source for
178
            <!--<a href="http://common-lisp.net/gitweb?p=projects/asdf/asdf.git;a=blob_plain;tag=RELEASE;f=asdf.lisp">asdf.lisp</a>,-->
179
            <a href="http://common-lisp.net/project/asdf/asdf.lisp">asdf.lisp</a>;
180
          </li>
181
          <li>download the latest <em>release</em>
182
183
            <!--<a href="http://common-lisp.net/gitweb?p=projects/asdf/asdf.git;tag=RELEASE;a=snapshot;sf=tgz">tarball</a>,-->
            <a href="http://common-lisp.net/project/asdf/asdf.tar.gz">tarball</a>
184
            to get all bells and whistles;
185
          </li>
186
187
188
189
          <li>download just the latest <em>development</em> source from our git repository:
            <a href="http://common-lisp.net/gitweb?p=projects/asdf/asdf.git;a=blob_plain;f=asdf.lisp;hb=HEAD">asdf.lisp</a>
          </li>
          <li>pull the latest <em>development</em> tree from our git repository
190
            <pre>git clone git://common-lisp.net/projects/asdf/asdf.git</pre>
191
192
193
194
195
196
197
198
            (note that our "master" branch is for current development;
            get our "release" branch for the latest stable release.);
          </li>
          <li>browse the latest <em>development</em> tree from our git repository:
            <a href="http://common-lisp.net/gitweb?p=projects/asdf/asdf.git">gitweb</a>
          </li>
          <li>download the tarball of a past release:
            <a href="http://common-lisp.net/project/asdf/archives/">archives</a>
199
200
        </li></ul>

201
202
203
204
205
206
207
208
209
210
211
212
213
        <a id="extensions"></a>
        <h3>Extensions</h3>
        <p>Known extensions to ASDF include:</p>
	<ul>
	  <li><a href="http://common-lisp.net/gitweb?p=projects/asdf/asdf-contrib.git"
		 >asdf-contrib</a>,
	    a collection of most of the below.</li>
	  <li><a href="http://common-lisp.net/gitweb?p=projects/asdf/asdf-encodings.git"
		 >asdf-encodings</a>,
	    to compile Lisp source files with character encodings other than UTF-8.</li>
	  <li><a href="http://common-lisp.net/gitweb?p=projects/asdf/asdf-bundle.git"
		 >asdf-bundle</a>,
	    to bundle one or more systems into a single FASL file, for easier delivery</li>
214
215
216
	  <li><a href="http://common-lisp.net/gitweb?p=projects/asdf/asdf-utils.git"
		 >asdf-utils</a>,
	    utilities originally from asdf, now exported from their own library.</li>
217
218
219
220
221
222
223
224
225
226
227
228
229
230
	  <li><a href="http://common-lisp.net/gitweb?p=projects/xcvb/xcvb.git"
		 >asdf-condition-control</a>
	    (distributed as part of XCVB),
	    to control which conditions to warn about or to muffle during compilation.</li>
	  <li><a href="http://common-lisp.net/gitweb?p=projects/asdf/asdf-finalizers.git"
		 >asdf-finalizers</a>,
	    to allow macros to include code to be evaluated
	    at the end of a file being compiled.</li>
	  <li><a href="http://common-lisp.net/gitweb?p=projects/xcvb/asdf-dependency-grovel.git"
		 >asdf-dependency-grovel</a>,
	    to compute the actual dependencies in a big ASDF system.</li>
	  <li><a href="http://common-lisp.net/project/qitab/"
		 >poiu</a>,
	    to compile a system in parallel.</li>
231
232
233
	  <li><a href="http://www.lrde.epita.fr/~didier/software/lisp/misc.php#asdf-flv"
		 >asdf-flv</a>,
	    to bind file-local variables around the compilation of some files.</li>
234
235
236
237
238
239
240
	</ul>

        <h3>Contributing</h3>
        <p>Join our mailing list, check the code out from git,
          send questions, ideas and patches!
        </p>

241
242
        <a id="bugs">
        <h3>Reporting Bugs</h3>
243
        <p>To report bugs, you can use our
244
245
246
247
248
          <a href="https://launchpad.net/asdf/">launchpad project</a>.
          If you're unsure about the bug or want to discuss how to fix it,
          you can send email to the project mailing-list below.
        </p>

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
249
250
        <a id="mailing-lists"></a>
        <h3>Mailing Lists</h3>
251
252
        <ul>
          <li><a href="http://common-lisp.net/cgi-bin/mailman/listinfo/asdf-devel">asdf-devel</a>:
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
253
254
255
256
257
258
259
260
261
            A list for questions, suggestions, bug reports, patches, and so on.
	    It's for everyone and everything. Please join the conversation!
	  </li>
          <li><a href="http://common-lisp.net/cgi-bin/mailman/listinfo/asdf-announce">asdf-announce</a>:
            A low-volume mailing-list for announcements only, mostly regarding new releases.
	    Posting is restricted to project administrators and to important notices.
	    Please subscribe to it if you're a Lisp implementation or distribution vendor,
	    who needs to know when to upgrade the ASDF you distribute,
	    but are otherwise not interested in day to day design and development.
262
263
264
265
266
267
268
269
270
271
        </li></ul>

        <h3>Contributing</h3>
        <p>Join our mailing list, check the code out from git,
          send questions, ideas and patches!
        </p>

        <a id="news"></a>
        <h3>What is happening</h3>
        <dl>
272
273
          <dt>In April 2012</dt>
          <dd>
274
275
276
            ASDF 2.21 now controls the character encoding used by Lisp source files.
            You can specify different encodings in your defsystem,
            e.g. <kbd>:encoding :latin1</kbd>,
277
            if you <kbd>:defsystem-depends-on (:asdf-encodings)</kbd>.
278
279
280
281
282
283
284
            While the default will remain to load and compile file
            with the <kbd>:default</kbd> external-format,
            we encourage all library authors to adopt
            the <i>de facto</i> standard, UTF-8,
            for all their source files (.lisp and .asd).
            Our intent is to bless and enforce this standard encoding
            on all these files by default in a not-to-faraway future.
285
          </dd>
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
286
          <dt>Since December 2009</dt>
287
          <dd>Fran&ccedil;ois-Ren&eacute; Rideau is de facto maintainer,
288
            with notable contributions from Robert P. Goldman, but also
289
            Juanjo Garcia-Ripoll and James Anderson.
290
            ASDF 2 released
291
            with many clean-ups, better configurability, some new features,
292
293
294
295
296
            and updated documentation.
          </dd>
          <dt>May 2006 to November 2009</dt>
          <dd>Gary King is de facto maintainer,
            with notable contributions from
297
            Robert P. Goldman, Nikodemus Siivola, Christophe Rhodes, Daniel Herring.
298
            Many small features and bug fixes,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
299
            making the project more maintainable,
300
            moving to using git and common-lisp.net.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
301
            Last version: 1.369.
302
303
304
305
306
          </dd>
          <dt>May 2004 to April 2006</dt>
          <dd>Christophe Rhodes is de facto maintainer,
            with notable contributions from
            Nikodemus Siivola, Peter Van Eynde, Edi Weitz, Kevin Rosenberg.
307
            The system made more robust, a few more features.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
308
            Last version: 1.97.
309
          <dt>August 2001 to May 2004</dt>
310
          <dd>Developed by Daniel Barlow, with notable contributions from
311
            Christophe Rhodes, Kevin Rosenberg, Edi Weitz, Rahul Jain.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
312
            Last version: 1.37.
313
314
          <dt>August 2001</dt>
          <dd>Created by Daniel Barlow</dd>
315
316
      </dl>
          </div>
317
318
319
320
321
      <div id="footer">
        <a class="nav" href="http://validator.w3.org/check/referer" title="xhtml1.1"><img src="http://common-lisp.net/project/cl-containers/shared/buttons/xhtml.gif" width="80" height="15" title="valid xhtml button" alt="valid xhtml" /></a>
        <a class="nav" href="http://www.catb.org/hacker-emblem/" title="hacker"> <img src="http://common-lisp.net/project/cl-containers/shared/buttons/hacker.png" width="80" height="15" title="hacker emblem" alt="hacker button" /></a>
        <a class="nav" href="http://www.lisp.org/" title="Association of Lisp Users"> <img src="http://common-lisp.net/project/cl-containers/shared/buttons/lambda-lisp.png" width="80" height="15" title="ALU emblem" alt="ALU button" /></a>
        <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>
322
        <p><span class="copyright"Copyright &copy; 2001-2012 Daniel Barlow and contributors</span></p>
323
        <p>ASDF has an <a href="http://www.opensource.org/licenses/mit-license.php">MIT style</a> license</p>
324
        <div id="timestamp">Last updated 2012-07-28</div>
325
    </div>
326
327
  </body>
</html>