asdf.texinfo 250 KB
Newer Older
1
2
\input texinfo          @c -*- texinfo -*-
@c %**start of header
3
@setfilename asdf.info
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
4
@settitle ASDF Manual
5
@syncodeindex tp fn
6
7
@c %**end of header

8
9
@c We use @&key, etc to escape & from TeX in lambda lists --
@c so we need to define them for info as well.
10
@macro AallowOtherKeys
11
12
&allow-other-keys
@end macro
13
@macro Aoptional
14
15
&optional
@end macro
16
@macro Arest
17
18
&rest
@end macro
19
@macro Akey
20
21
&key
@end macro
22
@macro Abody
23
24
25
&body
@end macro

26
27
28
@c for install-info
@dircategory Software development
@direntry
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
29
* asdf: (asdf).           Another System Definition Facility (for Common Lisp)
30
31
@end direntry

32
@copying
33
34
This manual describes ASDF, a system definition facility
for Common Lisp programs and libraries.
35

36
You can find the latest version of this manual at
37
@url{https://common-lisp.net/project/asdf/asdf.html}.
38

39
ASDF Copyright @copyright{} 2001-2015 Daniel Barlow and contributors.
40

41
This manual Copyright @copyright{} 2001-2015 Daniel Barlow and contributors.
42

43
This manual revised @copyright{} 2009-2015 Robert P. Goldman and Francois-Rene Rideau.
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
``Software''), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

@end copying

@titlepage
67
@title ASDF: Another System Definition Facility
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
68
@subtitle Manual for Version 3.1.6.3
69
70
71
72
73
@c The following two commands start the copyright page.
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
74

75
76
77
78
79
80
81
@c Output the table of contents at the beginning.
@contents

@c -------------------

@ifnottex

82
@node Top, Introduction, (dir), (dir)
83
@top ASDF: Another System Definition Facility
84
@ifnottex
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
85
Manual for Version 3.1.6.3
86
87
@end ifnottex

88

89
90
91
@insertcopying

@menu
92
* Introduction::
93
* Quick start summary::
94
* Loading ASDF::
95
96
* Configuring ASDF::
* Using ASDF::
97
98
* Defining systems with defsystem::
* The object model of ASDF::
99
* Controlling where ASDF searches for systems::
100
101
102
103
104
* Controlling where ASDF saves compiled files::
* Error handling::
* Miscellaneous additional functionality::
* Getting the latest version::
* FAQ::
105
106
* Ongoing Work::
* Bibliography::
107
108
* Concept Index::
* Function and Class Index::
109
* Variable Index::              @c @detailmenu
110
@c
111
112
113
114
115
116
117
118
119

@detailmenu
 --- The Detailed Node Listing ---

Loading ASDF

* Loading a pre-installed ASDF::
* Checking whether ASDF is loaded::
* Upgrading ASDF::
120
* Replacing your implementation's ASDF::
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
121
* Loading ASDF from source::
122

123
124
125
Configuring ASDF

* Configuring ASDF to find your systems::
Robert P. Goldman's avatar
Robert P. Goldman committed
126
* Configuring ASDF to find your systems --- old style::
127
* Configuring where ASDF stores object files::
Robert P. Goldman's avatar
Robert P. Goldman committed
128
* Resetting the ASDF configuration::
129

130
131
132
Using ASDF

* Loading a system::
133
* Convenience Functions::
134
135
* Moving on::

136
137
138
139
140
141
Defining systems with defsystem

* The defsystem form::
* A more involved example::
* The defsystem grammar::
* Other code in .asd files::
142
* The package-inferred-system extension::
143

144
The Object model of ASDF
145

146
147
* Operations::
* Components::
148
* Dependencies::
149
* Functions::
150

151
Operations
152

153
154
* Predefined operations of ASDF::
* Creating new operations::
155

156
Components
157

158
159
160
* Common attributes of components::
* Pre-defined subclasses of component::
* Creating new component types::
161

162
properties
163

164
165
* Pre-defined subclasses of component::
* Creating new component types::
166

167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
Controlling where ASDF searches for systems

* Configurations::
* Truenames and other dangers::
* XDG base directory::
* Backward Compatibility::
* Configuration DSL::
* Configuration Directories::
* Shell-friendly syntax for configuration::
* Search Algorithm::
* Caching Results::
* Configuration API::
* Introspection::
* Status::
* Rejected ideas::
* TODO::
* Credits for the source-registry::

Configuration Directories

Robert P. Goldman's avatar
Robert P. Goldman committed
187
* The here directive::
188
189
190
191
192
193
194
195

Introspection

* *source-registry-parameter* variable::
* Information about system dependencies::

Controlling where ASDF saves compiled files

196
197
198
199
200
* Output Configurations::
* Output Backward Compatibility::
* Output Configuration DSL::
* Output Configuration Directories::
* Output Shell-friendly syntax for configuration::
201
* Semantics of Output Translations::
202
* Output Caching Results::
203
204
205
206
207
208
* Output location API::
* Credits for output translations::

Miscellaneous additional functionality

* Controlling file compilation::
209
* Controlling source file character encoding::
210
* Miscellaneous Functions::
211
212
* Some Utility Functions::

213
FAQ
214

215
* Where do I report a bug?::
216
* Mailing list::
217
* What has changed between ASDF 1 ASDF 2 and ASDF 3?::
218
219
220
221
* Issues with installing the proper version of ASDF::
* Issues with configuring ASDF::
* Issues with using and extending ASDF to define systems::
* ASDF development FAQs::
222

223
``What has changed between ASDF 1, ASDF 2, and ASDF 3?''
224

225
* What are ASDF 1 2 3?::
226
* How do I detect the ASDF version?::
227
228
229
230
231
232
233
234
235
* ASDF can portably name files in subdirectories::
* Output translations::
* Source Registry Configuration::
* Usual operations are made easier to the user::
* Many bugs have been fixed::
* ASDF itself is versioned::
* ASDF can be upgraded::
* Decoupled release cycle::
* Pitfalls of the transition to ASDF 2::
236
* Pitfalls of the upgrade to ASDF 3::
237
* What happened to the bundle operations::
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255

Issues with installing the proper version of ASDF

* My Common Lisp implementation comes with an outdated version of ASDF. What to do?::
* I'm a Common Lisp implementation vendor. When and how should I upgrade ASDF?::

Issues with configuring ASDF

* How can I customize where fasl files are stored?::
* How can I wholly disable the compiler output cache?::

Issues with using and extending ASDF to define systems

* How can I cater for unit-testing in my system?::
* How can I cater for documentation generation in my system?::
* How can I maintain non-Lisp (e.g. C) source files?::
* I want to put my module's files at the top level.  How do I do this?::
* How do I create a system definition where all the source files have a .cl extension?::
256
* How do I mark a source file to be loaded only and not compiled?::
257
* How do I work with readtables?::
258
259
260

ASDF development FAQs

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
261
* How do I run the tests interactively in a REPL?::
262
263

@end detailmenu
264
265
266
267
268
269
@end menu

@end ifnottex

@c -------------------

270
@node Introduction, Quick start summary, Top, Top
271
272
@comment  node-name,  next,  previous,  up
@chapter Introduction
Robert P. Goldman's avatar
Robert P. Goldman committed
273
274
275
276
277
278
@cindex ASDF-related features
@vindex *features*
@cindex Testing for ASDF
@cindex ASDF versions
@cindex :asdf
@cindex :asdf2
279
@cindex :asdf3
280

281
282
ASDF is Another System Definition Facility:
a tool for specifying how systems of Common Lisp software
283
are made up of components (sub-systems and files),
284
285
and how to operate on these components in the right order
so that they can be compiled, loaded, tested, etc.
286
If you are new to ASDF, @pxref{Quick start summary,,the quick start
287
guide}.
288
289
290
291

ASDF presents three faces:
one for users of Common Lisp software who want to reuse other people's code,
one for writers of Common Lisp software who want to specify how to build their systems,
292
293
and one for implementers of Common Lisp extensions who want to extend
the build system.
294
For more specifics,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
295
@pxref{Using ASDF},
296
to learn how to use ASDF to load a system.
Robert P. Goldman's avatar
Robert P. Goldman committed
297
@xref{Defining systems with defsystem},
298
to learn how to define a system of your own.
299
@xref{The object model of ASDF}, for a description of
Robert P. Goldman's avatar
Robert P. Goldman committed
300
the ASDF internals and how to extend ASDF.
301

302
Note that
303
304
305
306
ASDF is @emph{not} a tool for library and system @emph{installation};
it plays a role like @code{make} or @code{ant}, not like a package manager.
In particular, ASDF should not to be confused with Quicklisp or ASDF-Install,
that attempt to find and download ASDF systems for you.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
307
Despite what the name might suggest, ASDF-Install is not part of ASDF, but a separate piece of software.
308
ASDF-Install is also unmaintained and obsolete.
309
We recommend you use Quicklisp
310
(@uref{http://www.quicklisp.org/}) instead,
311
a Common Lisp package manager which works well and is being actively maintained.
312
If you want to download software from version control instead of tarballs,
313
so you may more easily modify it, we recommend clbuild (@uref{http://common-lisp.net/project/clbuild/}).
314
315
We recommend @file{~/common-lisp/}
as a place into which to install Common Lisp software;
316
starting with ASDF 3.1.2, it is included in the default source-registry configuration.
317

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
318
319
Finally, note that this manual is incomplete.
All the bases are covered,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
320
321
but many advanced topics are only barely alluded to,
and there is not much in terms of examples.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
322
The source code remains the ultimate source of information,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
323
free software systems in Quicklisp remain the best source of examples,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
324
325
326
and the mailing-list the best place to ask for help.


327
328
@node  Quick start summary, Loading ASDF, Introduction, Top
@chapter Quick start summary
329

330
@itemize
331
332
333
334
335

@item To load an ASDF system:

@itemize
@item
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
336
337
338
339
Load ASDF itself into your Lisp image, using
@code{(require "asdf")}.
Check that you have a recent version using @code{(asdf:asdf-version)}.
For more details, or if any of the above fails, @pxref{Loading ASDF}.
340
341

@item
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
342
343
Make sure software is installed where ASDF can find it.
The simplest way is to put all your Lisp code in subdirectories of
344
@file{~/common-lisp/} (starting with ASDF 3.1.2),
345
346
or @file{~/.local/share/common-lisp/source/}
(for ASDF 2 and later, or if you want to keep source in a hidden directory).
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
347
For more details, @pxref{Configuring ASDF to find your systems}.
348
349

@item
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
350
351
Load your system with @code{(asdf:load-system "@var{my-system}")}.
@xref{Using ASDF}.
352
353
354
355
356
357
358
359
360
361

@end itemize

@item To make your own ASDF system:

@itemize
@item
As above, load and configure ASDF.

@item
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
362
363
Make a new directory for your system, @code{@var{my-system}/},
again in a location where ASDF can find it.
364
365
All else being equal, the easiest location is probably
@file{~/common-lisp/my-system/}.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
366
@xref{Configuring ASDF to find your systems}.
367

368
369

@item
370
371
Create an ASDF system definition listing the dependencies of
your system, its components, and their interdependencies,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
372
373
and put it in @file{@var{my-system}.asd}.
This file must have the same name as your system, all lowercase.
374
@xref{Defining systems with defsystem}.
375
376

@item
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
377
Use @code{(asdf:load-system "@var{my-system}")}
378
to make sure it's all working properly. @xref{Using ASDF}.
379
380
381
382

@end itemize
@end itemize

Robert P. Goldman's avatar
Robert P. Goldman committed
383
384
@c FIXME: (1) add a sample project that the user can cut and paste to
@c get started.  (2) discuss the option of starting with Quicklisp.
385
386
387
388
389
390





@node Loading ASDF, Configuring ASDF, Quick start summary, Top
391
@comment  node-name,  next,  previous,  up
392
@chapter Loading ASDF
393

394
395
396
397
@menu
* Loading a pre-installed ASDF::
* Checking whether ASDF is loaded::
* Upgrading ASDF::
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
398
* Replacing your implementation's ASDF::
399
* Loading ASDF from source::
400
@end menu
401

402
@node  Loading a pre-installed ASDF, Checking whether ASDF is loaded, Loading ASDF, Loading ASDF
403
404
@section Loading a pre-installed ASDF

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
405
406
407
408
409
410
411
The recommended way to load ASDF is via:
@lisp
(require "asdf")
@end lisp

All actively maintained Lisp implementations now include a copy of ASDF 3
that you can load this way using Common Lisp's @code{require} function.@footnote{
412
413
NB: all implementations except GNU CLISP also accept
@code{(require "ASDF")}, @code{(require 'asdf)} and @code{(require :asdf)}.
414
For portability's sake, you should use @code{(require "asdf")}.
415
}
416

417
If the implementation you are using doesn't provide a recent ASDF 3,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
418
419
420
421
422
423
we recommend you upgrade it.
If for some reason you would rather not upgrade it,
we recommend you replace your implementation's ASDF.
@xref{Replacing your implementation's ASDF}.
If all else fails, see @pxref{Loading ASDF from source} below.

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
424
425
If you use an actively maintained implementation that fails to provide
an up-to-date enough stable release of ASDF,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
426
427
428
you may also send a bug report to your Lisp vendor and complain about it
--- or you may fix the issue yourself if it's free software.

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
As of the writing of this manual,
the following implementations provide ASDF 3 this way:
ABCL, Allegro CL, CLASP, Clozure CL, CMUCL, ECL, GNU CLISP, LispWorks, MKCL, SBCL.
The following implementations only provide ASDF 2:
MOCL, XCL.
The following implementations don't provide ASDF:
Corman CL, GCL, Genera, MCL, SCL.
The latter implementations are not actively maintained (except maybe GCL);
if some of them are ever released again, they probably will include ASDF 3.

For maximum convenience you might want to have ASDF loaded
whenever you start your Lisp implementation,
for example by loading it from the startup script or dumping a custom core
--- check your Lisp implementation's manual for details.
SLIME notably sports a @code{slime-asdf} contrib that makes life easier with ASDF.

445

446
@node Checking whether ASDF is loaded, Upgrading ASDF, Loading a pre-installed ASDF, Loading ASDF
447
448
@section Checking whether ASDF is loaded

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
449
To check that ASDF is properly loaded, you can run this form:
450
451
452
453
454
455
456

@lisp
(asdf:asdf-version)
@end lisp

If it returns a string,
that is the version of ASDF that is currently installed.
457
458
If that version is suitably recent (say, 3.1.2 or later),
then you can skip directly to next chapter: @xref{Configuring ASDF}.
459
460
461

If it raises an error,
then either ASDF is not loaded, or
462
463
you are using a very old version of ASDF,
and need to install ASDF 3.
464

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
465
466
For more precision in detecting versions old and new,
@pxref{How do I detect the ASDF version?}.
467

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
468
469
470
471
If you are experiencing problems with ASDF,
please try upgrading to the latest released version,
using the method below,
before you contact us and raise an issue.
472

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
473
@node  Upgrading ASDF, Replacing your implementation's ASDF, Checking whether ASDF is loaded, Loading ASDF
474
@section Upgrading ASDF
475
476
477
@c FIXME: tighten this up a bit -- there's a lot of stuff here that
@c doesn't matter to almost anyone.  Move discussion of updating antique
@c versions of ASDF down, or encapsulate it.
478

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
479
480
481
If your implementation already provides ASDF 3 or later (and it should),
but you want a more recent ASDF version than your implementation provides,
then you just need to ensure the more recent ASDF is installed in a configured path, like any other system.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
482
483
We recommend you download an official tarball or checkout a release from git into
@file{~/common-lisp/asdf/}.
484
485
(@pxref{Configuring ASDF to find your systems}).

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
486
Once the source code for ASDF is installed,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
487
you don't need any extra step to load it beyond the usual @code{(require "asdf")}:
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
488
ASDF 3 will automatically look whether an updated version of itself is available
489
490
amongst the regularly configured systems, before it compiles anything else.

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
491
492
If your implementation fails to provide ASDF 3 or later,
@pxref{Replacing your implementation's ASDF}.
493

494

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
495
496
@node Replacing your implementation's ASDF, Loading ASDF from source, Upgrading ASDF, Loading ASDF
@section Replacing your implementation's ASDF
497
498

All maintained implementations now provide ASDF 3 in their latest release.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
499
If your doesn't, we recommend you upgrade it.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
500

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
501
Now, if you insist on using an old implementation that didn't provide ASDF or provided an old version,
502
we recommend installing a recent ASDF, as explained below,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
503
into your implementation's installation directory.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
504
Thus your modified implementation will now provide ASDF 3.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
505
This requires proper write permissions and may necessitate execution as a system administrator.
506
507
508
509
510
511
512

The ASDF source repository contains a tool to help you upgrade your implementation's ASDF.
You can invoke it from the shell command-line as
@code{tools/asdf-tools install-asdf lispworks}
(where you can replace @code{lispworks} by the name of the relevant implementation),
or you can @code{(load "tools/install-asdf.lisp")} from your Lisp REPL.

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
513
This script works on
514
515
516
517
518
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 much.
Corman CL, Genera, MCL are obsolete anyway.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
519
MOCL is incomplete.
520

521

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
522
@node Loading ASDF from source,  , Replacing your implementation's ASDF, Loading ASDF
523
@section Loading ASDF from source
524

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
525
526
527
If you write build scripts that must remain portable to old machines with old implementations
that you cannot ensure have been upgraded or modified to provide a recent ASDF,
you may have to install the file @file{asdf.lisp}
528
529
530
531
532
somewhere and load it with:

@lisp
(load "/path/to/your/installed/asdf.lisp")
@end lisp
533

534
The single file @file{asdf.lisp} is all you normally need to use ASDF.
535

536
You can extract this file from latest release tarball on the
537
@url{https://common-lisp.net/project/asdf/,ASDF website}.
538
If you are daring and willing to report bugs, you can get
539
the latest and greatest version of ASDF from its git repository.
540
541
@xref{Getting the latest version}.

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
542
543
544
545
For scripts that try to use ASDF simply via @code{require} at first, and
make heroic attempts to load it the hard way if at first they don't succeed,
see @file{tools/load-asdf.lisp} distributed with the ASDF source repository,
or the code of @url{https://cliki.net/cl-launch,@code{cl-launch}}.
546

547

548
549
@node Configuring ASDF, Using ASDF, Loading ASDF, Top
@comment  node-name,  next,  previous,  up
550
551
@chapter Configuring ASDF

552
553
554
555
556
557
For standard use cases, ASDF should work pretty much out of the box.
We recommend you skim the sections on configuring ASDF to find your systems
and choose the method of installing Lisp software that works best for you.
Then skip directly to @xref{Using ASDF}. That will probably be enough.
You are unlikely to have to worry about the way ASDF stores object files,
and resetting the ASDF configuration is usually only needed in corner cases.
Robert P. Goldman's avatar
Robert P. Goldman committed
558
559
560


@menu
561
* Configuring ASDF to find your systems::
Robert P. Goldman's avatar
Robert P. Goldman committed
562
* Configuring ASDF to find your systems --- old style::
563
* Configuring where ASDF stores object files::
Robert P. Goldman's avatar
Robert P. Goldman committed
564
* Resetting the ASDF configuration::
Robert P. Goldman's avatar
Robert P. Goldman committed
565
566
@end menu

Robert P. Goldman's avatar
Robert P. Goldman committed
567
@node Configuring ASDF to find your systems, Configuring ASDF to find your systems --- old style, Configuring ASDF, Configuring ASDF
568
569
@section Configuring ASDF to find your systems

Robert P. Goldman's avatar
Robert P. Goldman committed
570
In order to compile and load your systems, ASDF must be configured to find
571
572
the @file{.asd} files that contain system definitions.

Robert P. Goldman's avatar
Robert P. Goldman committed
573
574
575
576
There are a number of different techniques for setting yourself up with
ASDF, starting from easiest to the most complex:

@itemize @bullet
577

578
@item
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
579
580
Put all of your systems in one of the standard locations,
subdirectories of
581
@itemize
582
@item
583
@file{~/common-lisp/} or
584
@item
585
@file{~/.local/share/common-lisp/source/}.
586
@end itemize
587
If you install software there, you don't need further
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
588
589
590
591
592
593
594
595
configuration.@footnote{
  @file{~/common-lisp/} is only included in
  the default configuration
  starting with ASDF 3.1.2 or later.
  If your implementation provides an earlier variant of ASDF,
  you may need to explicitly configure it to use this path,
  as further explained.
}
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
596
You can then skip to the next section. @xref{Loading a system}.
Robert P. Goldman's avatar
Robert P. Goldman committed
597

598
@item
599
If you're using some tool to install software (e.g. Quicklisp),
600
601
the authors of that tool should already have configured ASDF.

602
@item
Robert P. Goldman's avatar
Robert P. Goldman committed
603
604
605
606
If you have more specific desires about how to lay out your software on
disk, the preferred way to configure where ASDF finds your systems is
the @code{source-registry} facility,
fully described in its own chapter of this manual.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
@xref{Controlling where ASDF searches for systems}.
Here is a quick recipe for getting started.

First create the directory
@file{~/.config/common-lisp/source-registry.conf.d/}@footnote{
  For Windows users, and starting with ASDF 3.1.5, start from your
  @file{%LOCALAPPDATA%}, which is usually @file{~/AppData/Local/}
  (but you can ask in a @code{CMD.EXE} terminal
  @code{echo %LOCALAPPDATA%} to make sure)
  and underneath create a subpath
  @file{config/common-lisp/source-registry.conf.d/}.
};
there create a file with any name of your choice
but with the type @file{conf}@footnote{
  By requiring the @file{.conf}
  extension, and ignoring other files, ASDF allows you to have disabled files,
  editor backups, etc. in the same directory with your active
  configuration files.

  ASDF will also ignore files whose names start with a @file{.} character.

  It is customary to start the filename with two digits, to control the
  sorting of the @code{conf} files in the source registry directory, and
  thus the order in which the directories will be scanned.
},
for instance @file{50-luser-lisp.conf};
in this file, add the following line
to tell ASDF to recursively scan all the subdirectories under @file{/home/luser/lisp/}
for @file{.asd} files:
@kbd{(:tree "/home/luser/lisp/")}
637

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
638
639
640
641
642
643
That's enough. You may replace @file{/home/luser/lisp/} by wherever you want to install your source code.
You don't actually need to specify anything if you use the default @file{~/common-lisp/} as above
and your implementation provides ASDF 3.1.2 or later.
If your implementation provides an earlier variant of ASDF 3,
you might want to specify @kbd{(:tree (:home "common-lisp/"))} for bootstrap purposes,
then install a recent source tree of ASDF under @file{~/common-lisp/asdf/}.
644

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
645
646
647
648
If you prefer to use a ``link farm'', which is faster to use but costlier to manage than a recursive traversal,
say at @file{/home/luser/.asd-link-farm/}, then
you may instead (or additionally) create a file @file{42-asd-link-farm.conf}, containing the line:
@kbd{(:directory "/home/luser/.asd-link-farm/")}
649
650
651

ASDF will automatically read your configuration
the first time you try to find a system.
Robert P. Goldman's avatar
Robert P. Goldman committed
652
If necessary, you can reset the source-registry configuration with:
653

654
655
656
657
@lisp
(asdf:clear-source-registry)
@end lisp

Robert P. Goldman's avatar
Robert P. Goldman committed
658
659
@item
In earlier versions of ASDF, the system source registry was configured
660
661
662
663
using a global variable, @code{asdf:*central-registry*}.
For more details about this, see the following section,
@ref{Configuring ASDF to find your systems --- old style}.
Unless you need to understand this,
Robert P. Goldman's avatar
Robert P. Goldman committed
664
skip directly to @ref{Configuring where ASDF stores object files}.
665

Robert P. Goldman's avatar
Robert P. Goldman committed
666
667
668
669
670
671
672
@end itemize

Note that your Operating System distribution or your system administrator
may already have configured system-managed libraries for you.



673
@node Configuring ASDF to find your systems --- old style, Configuring where ASDF stores object files, Configuring ASDF to find your systems, Configuring ASDF
Robert P. Goldman's avatar
Robert P. Goldman committed
674
675
@section Configuring ASDF to find your systems --- old style

676
677
678

@c FIXME: this section should be moved elsewhere.  The novice user
@c should not be burdened with it. [2014/02/27:rpg]
Robert P. Goldman's avatar
Robert P. Goldman committed
679

680
681
682
683
684
685
686
687
688
689
690
691

The old way to configure ASDF to find your systems is by
@code{push}ing directory pathnames onto the variable
@code{asdf:*central-registry*}.

You must configure this variable between the time you load ASDF
and the time you first try to use it.
Loading and configuring ASDF presumably happen
as part of some initialization script that builds or starts
your Common Lisp software system.
(For instance, some SBCL users used to put it in their @file{~/.sbclrc}.)

692
The @code{asdf:*central-registry*} is empty by default in ASDF 2 or ASDF 3,
693
but is still supported for compatibility with ASDF 1.
694
When used, it takes precedence over the above source-registry.@footnote{
695
696
697
698
699
It is possible to further customize
the system definition file search.
That's considered advanced use, and covered later:
search forward for
@code{*system-definition-search-functions*}.
700
@xref{Defining systems with defsystem}.}
701

702
703
704
For example, let's say you want ASDF to find the @file{.asd} file
@file{/home/me/src/foo/foo.asd}.
In your lisp initialization file, you could have the following:
705
706

@lisp
707
(require "asdf")
708
709
710
711
712
(push "/home/me/src/foo/" asdf:*central-registry*)
@end lisp

Note the trailing slash: when searching for a system,
ASDF will evaluate each entry of the central registry
713
and coerce the result to a pathname.@footnote{
714
ASDF will indeed call @code{eval} on each entry.
715
It will skip entries that evaluate to @code{nil}.
716
717

Strings and pathname objects are self-evaluating,
718
in which case the @code{eval} step does nothing;
719
720
721
but you may push arbitrary s-expressions onto the central registry.
These s-expressions may be evaluated to compute context-dependent
entries, e.g. things that depend
722
723
724
725
726
727
on the value of shell variables or the identity of the user.

The variable @code{asdf:*central-registry*} is thus a list of
``system directory designators''.
A @dfn{system directory designator} is a form
which will be evaluated whenever a system is to be found,
728
729
730
and must evaluate to a directory to look in (or @code{NIL}).
By ``directory'', we mean
``designator for a pathname with a non-empty DIRECTORY component''.
731
}
732
The trailing directory name separator
733
is necessary to tell Lisp that you're discussing a directory
734
735
736
rather than a file.  If you leave it out, ASDF is likely to look in
@code{/home/me/src/} instead of @code{/home/me/src/foo/} as you
intended, and fail to find your system definition.
737

738
739
740
Typically there are a lot of @file{.asd} files, and
a common idiom was to put
@emph{symbolic links} to all of one's @file{.asd} files
741
742
in a common directory
and push @emph{that} directory (the ``link farm'')
743
744
745
746
747
748
onto
@code{asdf:*central-registry*},
instead of pushing each individual system directory.

ASDF knows to follow @emph{symlinks}
to the actual location of the systems.@footnote{
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
749
750
751
  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.
}
752

753
For example, if @code{#p"/home/me/cl/systems/"}
754
755
is an element of @code{*central-registry*}, you could set up the
system @var{foo} as follows:
756
757
758
759
760
761

@example
$ cd /home/me/cl/systems/
$ ln -s ~/src/foo/foo.asd .
@end example

762
This old style for configuring ASDF is not recommended for new users,
763
764
but it is supported for old users, and for users who want a simple way to
programmatically control what directories are added to the ASDF search path.
765

766

Robert P. Goldman's avatar
Robert P. Goldman committed
767
@node Configuring where ASDF stores object files, Resetting the ASDF configuration, Configuring ASDF to find your systems --- old style, Configuring ASDF
768
@section Configuring where ASDF stores object files
769
@findex clear-output-translations
770
771
772
773
774

ASDF lets you configure where object files will be stored.
Sensible defaults are provided and
you shouldn't normally have to worry about it.

775
This allows the same source code repository to be shared
776
between several versions of several Common Lisp implementations,
777
778
779
780
between several users using different compilation options,
with users who lack write privileges on shared source directories, etc.
This also keeps source directories from being cluttered
with object/fasl files.
781

782
Starting with ASDF 2, the @code{asdf-output-translations} facility
783
was added to ASDF itself.  This facility controls where object files will be stored.
784
This facility is fully described in a chapter of this manual,
785
@ref{Controlling where ASDF saves compiled files}.
786

787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
@c FIXME: possibly this should be moved elsewhere.  It's redundant here,
@c and makes this section of the manual too long and daunting for the
@c new user. [2014/02/27:rpg]
@c The simplest way to add a translation to your search path,
@c say from @file{/foo/bar/baz/quux/}
@c to @file{/where/i/want/my/fasls/}
@c is to create the directory
@c @file{~/.config/common-lisp/asdf-output-translations.conf.d/}
@c and there create a file with any name of your choice and the type @file{conf},
@c for instance @file{42-bazquux.conf}
@c containing the line:

@c @kbd{("/foo/bar/baz/quux/" "/where/i/want/my/fasls/")}

@c To disable output translations for source under a given directory,
@c say @file{/toto/tata/}
@c you can create a file @file{40-disable-toto.conf}
@c with the line:

@c @kbd{("/toto/tata/")}

@c To wholly disable output translations for all directories,
@c you can create a file @file{00-disable.conf}
@c with the line:

@c @kbd{(t t)}

@c Note that your Operating System distribution or your system administrator
@c may already have configured translations for you.
@c In absence of any configuration, the default is to redirect everything
@c under an implementation-dependent subdirectory of @file{~/.cache/common-lisp/}.
@c @xref{Controlling where ASDF searches for systems}, for full details.

@c The required @file{.conf} extension allows you to have disabled files
@c or editor backups (ending in @file{~}), and works portably
@c (for instance, it is a pain to allow both empty and non-empty extension on CLISP).
@c Excluded are files the name of which start with a @file{.} character.
@c It is customary to start the filename with two digits
@c that specify the order in which the directories will be scanned.

@c ASDF will automatically read your configuration
@c the first time you try to find a system.
@c You can reset the source-registry configuration with:

@c @lisp
@c (asdf:clear-output-translations)
@c @end lisp
834

835
836
837
838
839
840
@c And you probably should do so before you dump your Lisp image,
@c if the configuration may change
@c between the machine where you save it at the time you save it
@c and the machine you resume it at the time you resume it.
@c (Once again, you should use @code{(asdf:clear-configuration)}
@c before you dump your Lisp image, which includes the above.)
841

842
Note that before ASDF 2,
843
844
845
846
other ASDF add-ons offered the same functionality,
each in subtly different and incompatible ways:
ASDF-Binary-Locations, cl-launch, common-lisp-controller.
ASDF-Binary-Locations is now not needed anymore and should not be used.
847
cl-launch 3.000 and common-lisp-controller 7.2 have been updated
848
to delegate object file placement to ASDF.
849

850
@node Resetting the ASDF configuration,  , Configuring where ASDF stores object files, Configuring ASDF
Robert P. Goldman's avatar
Robert P. Goldman committed
851
852
@section Resetting the ASDF configuration

853
854
@c FIXME: this should probably be moved out of the "quickstart" part of
@c the manual. [2014/02/27:rpg]
Robert P. Goldman's avatar
Robert P. Goldman committed
855

856
857
858
859
860
861

When you dump and restore an image, or when you tweak your configuration,
you may want to reset the ASDF configuration.
For that you may use the following function:

@defun clear-configuration
862
   Undoes any ASDF configuration
863
864
865
   regarding source-registry or output-translations.
@end defun

866
@vindex *image-dump-hook*
867
868
869
870
871
872
873
874
875
This function is pushed onto the @code{uiop:*image-dump-hook*} by default,
which means that if you save an image using @code{uiop:dump-image},
or via @code{asdf:image-op} and @code{asdf:program-op},
it will be automatically called to clear your configuration.
If for some reason you prefer to call your implementation's underlying functionality,
be sure to call @code{clear-configuration} manually,
or push it into your implementation's equivalent of @code{uiop:*image-dump-hook*},
e.g. @code{sb-ext:*save-hooks*} on SBCL, or @code{ext:*before-save-initializations*}
on CMUCL and SCL, etc.
876

877
@node  Using ASDF, Defining systems with defsystem, Configuring ASDF, Top
878
879
@chapter Using ASDF

Robert P. Goldman's avatar
Robert P. Goldman committed
880
881
@menu
* Loading a system::
882
* Convenience Functions::
Robert P. Goldman's avatar
Robert P. Goldman committed
883
884
885
* Moving on::
@end menu

886
@node Loading a system, Convenience Functions, Using ASDF, Using ASDF
887
888
889
890
@section Loading a system

The system @var{foo} is loaded (and compiled, if necessary)
by evaluating the following Lisp form:
891
892

@example
893
(asdf:load-system :@var{foo})
894
895
@end example

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
896
897
On some implementations (@pxref{Convenience Functions}),
ASDF hooks into the @code{cl:require} facility and you can just use:
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
898
899
900
901
902

@example
(require :@var{foo})
@end example

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
903
904
905
Note that the canonical name of a system is a string, conventionally lowercase.
A system name can also be specified as a symbol (including a keyword),
in which case its @code{symbol-name} is taken and lowercased.
906
The name must be a suitable value for the @code{:name} initarg
907
to @code{make-pathname} in whatever filesystem the system is to be found.
908

909
910
The lower-casing-symbols behaviour is unconventional,
but was selected after some consideration.
911
912
913
914
915
The type of systems we want to support
either have lowercase as customary case (Unix, Mac, Windows)
or silently convert lowercase to uppercase (lpns).
@c so this makes more sense than attempting to use @code{:case :common},
@c which is reported not to work on some implementations
916

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
917

918
919
@node Convenience Functions, Moving on, Loading a system, Using ASDF
@section Convenience Functions
Robert Goldman's avatar
Robert Goldman committed
920

921
922
923
@findex load-system
@findex compile-system
@findex test-system
Robert Goldman's avatar
Robert Goldman committed
924
@findex require-system
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
925
@findex make
926

927
ASDF provides three commands for the most common system operations:
928
@code{load-system}, @code{compile-system}, and @code{test-system}.
929
930
It also provides @code{require-system}, a version of @code{load-system}
that skips trying to update systems that are already loaded.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
931
932
933
And it provides @code{make}, a function that uses whichever operation
was specified by the author of the target system,
which by default behaves like @code{load-system}.
934

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
935
936
@c FIXME: We seem to export @findex bundle-system also, that some ECL users seem to rely on.
@c But it's probably better that bundle operations have their own manual chapter at some point.
937
938
939
940

@findex operate
@findex oos

941
942
Because ASDF is an extensible system
for defining @emph{operations} on @emph{components},
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
943
944
it also provides a generic function @code{operate},
so you may arbitrarily operate on your systems beyond the default operations.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
945
946
947
(At the interactive REPL, users often use its shorter alias @code{oos},
which stands for operate-on-system, a name inherited from @code{mk-defsystem}.)
You'll use @code{operate} whenever you want to do something beyond
948
compiling, loading and testing.
949

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
950
Note that output from ASDF and ASDF extensions are sent
951
to the CL stream @code{*standard-output*},
952
so rebinding that stream around calls to @code{asdf:operate}
953
should redirect all output from ASDF operations.
954

955
956
@c Reminder: before ASDF can operate on a system, however,
@c it must be able to find and load that system's definition.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
957
@c @xref{Configuring ASDF to find your systems}.
958

959
960
@c FIXME: the following is too complicated for here, especially since
@c :force hasn't been defined yet.  Move it. [2014/02/27:rpg]
961

962
963
@findex load-system
@vindex *load-system-operation*
964
965
@findex already-loaded-systems
@findex require-system
966
@code{load-system} applies @code{operate} with the operation from
967
@code{*load-system-operation*}
968
the system, and any provided keyword arguments.
969
970
@code{*load-system-operation*} by default is @code{load-op};
it would be @code{load-bundle-op} by default on ECL, if only an implementation bug were fixed.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
971

972
@code{require-system} skips any update to systems that have already been loaded,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
973
in the spirit of @code{cl:require}.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
974
975
976
It does it by calling @code{load-system} with a keyword option excluding already loaded systems.@footnote{
  For the curious, the option is @code{:force-not (already-loaded-systems)}.
}.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
977
978
979
980
981
982
983
On actively maintained free software implementations
(namely recent versions of ABCL, Clozure CL, CMUCL, ECL, GNU CLISP, MKCL and SBCL),
once ASDF itself is loaded, @code{cl:require} too can load ASDF systems,
by falling back on @code{require-system}
for module names not recognized by the implementation.

Note that @code{cl:require} and @code{require-system} are appropriate to load code
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
984
that is not being modified during the current programming session.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
985
986
987
This notably includes the implementation-provided extension modules that @code{cl:require} can load.
This also includes any number of ASDF systems that the user isn't either developing or debugging,
for which a previously installed version is deemed to be satisfactory.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
988
989
@code{require-system} and through it @code{cl:require} can load these systems without any problem.
But for code that you are actively developing, debugging, or otherwise modifying,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
990
you should use @code{load-system}, so ASDF will pick on your modifications
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
991
992
993
994
995
996
997
998
999
1000
1001
and transitively re-build the modified files and everything that depends on them.

Finally, starting with ASDF 3.1, a function @code{make} is also available,
that does ``The Right Thing'' with your system.
The default behaviour is to load the system as if by @code{load-system};
but instead of this default, system authors can specify
the intended use of their system by specifying their desired operation
with a @code{:build-operation} argument in the system definition.
@c Document :build-operation in the defsystem section.
@c Document in the extension section that for richer programmatic access, you may instead use an overriding
@c @code{(defmethod component-depends-on ((o build-op) (s system)) ...)}.
1002
1003
1004


@node Moving on,  , Convenience Functions, Using ASDF
1005
@section Moving on
1006

1007
1008
1009
1010
1011
That's all you need to know to use ASDF to load systems written by others.
The rest of this manual deals with writing system definitions
for Common Lisp software you write yourself,
including how to extend ASDF to define new operation and component types.

1012

1013
@node Defining systems with defsystem, The object model of ASDF, Using ASDF, Top
1014
1015
1016
@comment  node-name,  next,  previous,  up
@chapter Defining systems with defsystem

1017
This chapter describes how to use ASDF to define systems and develop
1018
1019
1020
1021
software.


@menu
1022
1023
1024
1025
* The defsystem form::
* A more involved example::
* The defsystem grammar::
* Other code in .asd files::
1026
* The package-inferred-system extension::
1027
1028
1029
1030
1031
@end menu

@node  The defsystem form, A more involved example, Defining systems with defsystem, Defining systems with defsystem
@comment  node-name,  next,  previous,  up
@section The defsystem form
1032
@findex defsystem
1033
1034
@cindex asdf-user
@findex load-asd
1035

1036
1037
This section begins with an example of a system definition,
then gives the full grammar of @code{defsystem}.
1038

1039
Let's look at a simple system.
1040
1041
This is a complete file that should be saved as @file{hello-lisp.asd}
(in order that ASDF can find it
1042
1043
when ordered to operate on the system named @code{"hello-lisp"}).

1044
@lisp
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1045
;; Usual Lisp comments are allowed here
1046

1047
(defsystem "hello-lisp"
1048
  :description "hello-lisp: a sample Lisp system."
1049
  :version "0.0.1"
1050
1051
  :author "Joe User <joe@@example.com>"
  :licence "Public Domain"
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1052
  :depends-on ("optima.ppcre" "command-line-arguments")
1053
1054
1055
  :components ((:file "packages")
               (:file "macros" :depends-on ("packages"))
               (:file "hello" :depends-on ("macros"))))
1056
1057
1058
1059
1060
@end lisp

Some notes about this example:

@itemize
1061

1062
@item
1063
1064
The @code{defsystem} form defines a system named @code{hello-lisp}
that contains three source files:
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1065
@file{packages.lisp}, @file{macros.lisp} and @file{hello.lisp}.
1066
1067

@item