asdf.texinfo 274 KB
Newer Older
Hugo Ishimaru's avatar
Hugo Ishimaru committed
1
\input texinfo          @c -*- mode: texinfo; coding: utf-8 -*-
2
@c %**start of header
Hugo Ishimaru's avatar
Hugo Ishimaru committed
3
@documentencoding UTF-8
4
@setfilename asdf.info
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
5
@settitle ASDF Manual
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-2019 Daniel Barlow and contributors.
40

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

43
This manual revised @copyright{} 2009-2019 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
Robert Goldman's avatar
Robert Goldman committed
68
@subtitle Manual for Version 3.3.5.1
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
Robert Goldman's avatar
Robert Goldman committed
85
Manual for Version 3.3.5.1
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
* Concept Index::
Robert Goldman's avatar
Robert Goldman committed
108
* Function and Macro Index::
109
* Variable Index::              @c @detailmenu
Robert Goldman's avatar
Robert Goldman committed
110
* Class and Type Index::        @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
* Parsing system definitions::
151

152
Operations
153

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

157
Components
158

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

Robert Goldman's avatar
Robert Goldman committed
163
Properties
164

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

168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
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
188
* The here directive::
189
190
191
192
193
194
195
196

Introspection

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

Controlling where ASDF saves compiled files

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

Miscellaneous additional functionality

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

214
FAQ
215

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

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

226
* What are ASDF 1 2 3?::
227
* How do I detect the ASDF version?::
228
229
230
231
232
233
234
235
236
* 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::
237
* Pitfalls of the upgrade to ASDF 3::
238
* What happened to the bundle operations::
239
240
241
242
243

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?::
244
* After upgrading ASDF, ASDF (and Quicklisp) can't find my systems: After upgrading ASDF.
245
246
247
248
249

Issues with configuring ASDF

* How can I customize where fasl files are stored?::
* How can I wholly disable the compiler output cache?::
250
* How can I debug problems finding ASDF systems::
251
252
253
254
255
256
257
258

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?::
259
* How do I mark a source file to be loaded only and not compiled?::
260
* How do I work with readtables?::
261
* How can I capture ASDF's output?::
262
* LOAD-PATHNAME has a weird value::
263
264
265

ASDF development FAQs

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
266
* How do I run the tests interactively in a REPL?::
267
268

@end detailmenu
269
270
271
272
273
274
@end menu

@end ifnottex

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

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

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

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,
297
298
and one for implementers of Common Lisp extensions who want to extend
the build system.
299
For more specifics,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
300
@pxref{Using ASDF},
301
to learn how to use ASDF to load a system.
Robert P. Goldman's avatar
Robert P. Goldman committed
302
@xref{Defining systems with defsystem},
303
to learn how to define a system of your own.
304
@xref{The object model of ASDF}, for a description of
Robert P. Goldman's avatar
Robert P. Goldman committed
305
the ASDF internals and how to extend ASDF.
306

307
Note that
308
309
310
311
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
312
Despite what the name might suggest,
313
314
ASDF-Install was never a part of ASDF; it was always a separate piece of software.
ASDF-Install has also been unmaintained and obsolete for a very long time.
315
We recommend you use Quicklisp
316
(@uref{http://www.quicklisp.org/}) instead,
317
a Common Lisp package manager which works well and is being actively maintained.
318
If you want to download software from version control instead of tarballs,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
319
320
321
322
323
324
so you may more easily modify it,
we recommend clbuild (@uref{http://common-lisp.net/project/clbuild/}).
As for where on your filesystem to install Common Lisp software,
we recommend subdirectories of @file{~/common-lisp/}:
starting with ASDF 3.1.2 (2014), this hierarchy is included
in the default source-registry configuration.
325

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
326
327
Finally, note that this manual is incomplete.
All the bases are covered,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
328
329
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
330
The source code remains the ultimate source of information,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
331
free software systems in Quicklisp remain the best source of examples,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
332
333
334
and the mailing-list the best place to ask for help.


335
336
@node  Quick start summary, Loading ASDF, Introduction, Top
@chapter Quick start summary
337

338
@itemize
339
340
341
342
343

@item To load an ASDF system:

@itemize
@item
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
344
345
346
347
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}.
348
349

@item
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
350
351
Make sure software is installed where ASDF can find it.
The simplest way is to put all your Lisp code in subdirectories of
352
@file{~/common-lisp/} (starting with ASDF 3.1.2),
353
354
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
355
For more details, @pxref{Configuring ASDF to find your systems}.
356
357

@item
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
358
359
Load your system with @code{(asdf:load-system "@var{my-system}")}.
@xref{Using ASDF}.
360
361
362
363
364
365
366
367
368
369

@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
370
371
Make a new directory for your system, @code{@var{my-system}/},
again in a location where ASDF can find it.
372
373
All else being equal, the easiest location is probably
@file{~/common-lisp/my-system/}.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
374
@xref{Configuring ASDF to find your systems}.
375

376
377

@item
378
379
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
380
381
and put it in @file{@var{my-system}.asd}.
This file must have the same name as your system, all lowercase.
382
@xref{Defining systems with defsystem}.
383
384

@item
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
385
Use @code{(asdf:load-system "@var{my-system}")}
386
to make sure it's all working properly. @xref{Using ASDF}.
387
388
389
390

@end itemize
@end itemize

Robert P. Goldman's avatar
Robert P. Goldman committed
391
392
@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.
393
394
395
396
397
398





@node Loading ASDF, Configuring ASDF, Quick start summary, Top
399
@comment  node-name,  next,  previous,  up
400
@chapter Loading ASDF
401

402
403
404
405
@menu
* Loading a pre-installed ASDF::
* Checking whether ASDF is loaded::
* Upgrading ASDF::
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
406
* Replacing your implementation's ASDF::
407
* Loading ASDF from source::
408
@end menu
409

410
@node  Loading a pre-installed ASDF, Checking whether ASDF is loaded, Loading ASDF, Loading ASDF
411
412
@section Loading a pre-installed ASDF

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
413
414
415
416
417
418
419
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{
420
421
NB: all implementations except GNU CLISP also accept
@code{(require "ASDF")}, @code{(require 'asdf)} and @code{(require :asdf)}.
422
For portability's sake, you should use @code{(require "asdf")}.
423
}
424

425
If the implementation you are using doesn't provide a recent ASDF 3,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
426
427
428
429
430
431
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
432
433
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
434
435
436
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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
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.

453

454
@node Checking whether ASDF is loaded, Upgrading ASDF, Loading a pre-installed ASDF, Loading ASDF
455
456
@section Checking whether ASDF is loaded

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
457
To check that ASDF is properly loaded, you can run this form:
458
459
460
461
462
463
464

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

If it returns a string,
that is the version of ASDF that is currently installed.
465
466
If that version is suitably recent (say, 3.1.2 or later),
then you can skip directly to next chapter: @xref{Configuring ASDF}.
467
468
469

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

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

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
476
477
478
479
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.
480

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
481
@node  Upgrading ASDF, Replacing your implementation's ASDF, Checking whether ASDF is loaded, Loading ASDF
482
@section Upgrading ASDF
483
484
485
@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.
486

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
487
If your implementation already provides ASDF 3 or later (and it should),
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
488
489
490
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
491
492
We recommend you download an official tarball or checkout a release from git into
@file{~/common-lisp/asdf/}.
493
494
(@pxref{Configuring ASDF to find your systems}).

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
495
Once the source code for ASDF is installed,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
496
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
497
ASDF 3 will automatically look whether an updated version of itself is available
498
499
amongst the regularly configured systems, before it compiles anything else.

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

503

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
504
505
@node Replacing your implementation's ASDF, Loading ASDF from source, Upgrading ASDF, Loading ASDF
@section Replacing your implementation's ASDF
506
507

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

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

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
518
519
The ASDF source repository contains a tool to
help you upgrade your implementation's ASDF.
520
521
522
523
524
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
525
This script works on
526
527
528
529
530
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
531
MOCL is incomplete.
532

533

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
534
@node Loading ASDF from source,  , Replacing your implementation's ASDF, Loading ASDF
535
@section Loading ASDF from source
536

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
537
538
539
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}
540
541
542
543
544
somewhere and load it with:

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

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

548
You can extract this file from latest release tarball on the
549
@url{https://common-lisp.net/project/asdf/,ASDF website}.
550
If you are daring and willing to report bugs, you can get
551
the latest and greatest version of ASDF from its git repository.
552
553
@xref{Getting the latest version}.

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
554
555
556
557
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}}.
558

559

560
561
@node Configuring ASDF, Using ASDF, Loading ASDF, Top
@comment  node-name,  next,  previous,  up
562
563
@chapter Configuring ASDF

564
565
566
567
568
569
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
570
571
572


@menu
573
* Configuring ASDF to find your systems::
Robert P. Goldman's avatar
Robert P. Goldman committed
574
* Configuring ASDF to find your systems --- old style::
575
* Configuring where ASDF stores object files::
Robert P. Goldman's avatar
Robert P. Goldman committed
576
* Resetting the ASDF configuration::
Robert P. Goldman's avatar
Robert P. Goldman committed
577
578
@end menu

Robert P. Goldman's avatar
Robert P. Goldman committed
579
@node Configuring ASDF to find your systems, Configuring ASDF to find your systems --- old style, Configuring ASDF, Configuring ASDF
580
581
@section Configuring ASDF to find your systems

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

Robert P. Goldman's avatar
Robert P. Goldman committed
585
586
587
588
There are a number of different techniques for setting yourself up with
ASDF, starting from easiest to the most complex:

@itemize @bullet
589

590
@item
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
591
592
Put all of your systems in one of the standard locations,
subdirectories of
593
@itemize
594
@item
595
@file{~/common-lisp/} or
596
@item
597
@file{~/.local/share/common-lisp/source/}.
598
@end itemize
599
If you install software there, you don't need further
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
600
601
602
603
604
605
606
607
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
608
You can then skip to the next section. @xref{Loading a system}.
Robert P. Goldman's avatar
Robert P. Goldman committed
609

610
@item
611
If you're using some tool to install software (e.g. Quicklisp),
612
613
the authors of that tool should already have configured ASDF.

614
@item
Robert P. Goldman's avatar
Robert P. Goldman committed
615
616
617
618
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
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
@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/")}
649

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
650
651
652
653
654
655
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/}.
656

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
657
658
659
660
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/")}
661
662
663

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

666
667
668
669
@lisp
(asdf:clear-source-registry)
@end lisp

Robert P. Goldman's avatar
Robert P. Goldman committed
670
671
@item
In earlier versions of ASDF, the system source registry was configured
672
673
674
675
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
676
skip directly to @ref{Configuring where ASDF stores object files}.
677

Robert P. Goldman's avatar
Robert P. Goldman committed
678
679
680
681
682
683
684
@end itemize

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



685
@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
686
687
@section Configuring ASDF to find your systems --- old style

688
689
690

@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
691

692
Novices may skip this section.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
693
694
Please @emph{do not} use the central-registry if you are a novice,
and @emph{do not} instruct novices to use the central-registry.
695
696
697
698
@c ``Experts may read it then proceed to ...''
@c some better section explaining
@c *central-registry* vs source-registry vs *system-definition-search-functions*,
@c and .../asdf/tools/cl-source-registry-cache.lisp
699
700
701
702
703

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

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
You @emph{must} configure this variable @emph{after} you load ASDF 3 or later,
yet @emph{before} the first time you try to use it.
This loading and configuring of ASDF must happen
as part of some initialization script:
typically, either a script you maintain that builds your project,
or your implementation's initialization script
(e.g. @file{~/.sbclrc} for SBCL).

Also, if you are using an ancient ASDF 2 or earlier to load ASDF 3 or later,
then after it loads the ancient ASDF, your script @emph{must} configure
the central-registry a first time to tell ASDF 1 or 2 where to find ASDF 3,
then load ASDF 3 with e.g. @code{(asdf:operate 'asdf:load-op "asdf")},
then configure the central-registry again, because
ASDF 3 will not preserve the central-registry from ASDF 2 when upgrading.
You should probably be using the source-registry instead, which will be preserved
(unless you manually called @code{asdf:initialize-source-registry} with an argument,
in which case you will have to do it again indeed).
However, if you are using an ancient ASDF 2 or earlier,
we @emph{strongly} recommend that you should instead upgrade your implementation,
or overwrite the ancient ASDF installation with a more recent one:
@xref{Replacing your implementation's ASDF}.
725

726
The @code{asdf:*central-registry*} is empty by default in ASDF 2 or ASDF 3,
727
but is still supported for compatibility with ASDF 1.
728
When used, it takes precedence over the above source-registry.@footnote{
729
730
731
732
733
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*}.
734
@xref{Defining systems with defsystem}.}
735

736
737
For example, let's say you want ASDF to find the @file{.asd} file
@file{/home/me/src/foo/foo.asd}.
738
In your Lisp initialization file, you could have the following:
739
740

@lisp
741
(require "asdf")
742
743
744
745
746
(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
747
and coerce the result to a pathname.@footnote{
748
ASDF will indeed call @code{eval} on each entry.
749
It will skip entries that evaluate to @code{nil}.
750
751

Strings and pathname objects are self-evaluating,
752
in which case the @code{eval} step does nothing;
753
754
755
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
756
757
758
759
760
761
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,
762
and must evaluate to a directory to look in (or @code{nil}).
763
764
By ``directory'', we mean
``designator for a pathname with a non-empty DIRECTORY component''.
765
}
766
The trailing directory name separator
767
is necessary to tell Lisp that you're discussing a directory
768
769
770
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.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
771
772
Modern versions of ASDF will issue an error and offer you to
remove such entries from the central-registry.
773

774
775
776
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
777
778
in a common directory
and push @emph{that} directory (the ``link farm'')
779
780
781
782
783
784
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
785
786
787
  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.
}
788

789
For example, if @code{#p"/home/me/cl/systems/"}
790
791
is an element of @code{*central-registry*}, you could set up the
system @var{foo} as follows:
792
793
794
795
796
797

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

798
This old style for configuring ASDF is not recommended for new users,
799
800
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.
801

802

Robert P. Goldman's avatar
Robert P. Goldman committed
803
@node Configuring where ASDF stores object files, Resetting the ASDF configuration, Configuring ASDF to find your systems --- old style, Configuring ASDF
804
@section Configuring where ASDF stores object files
805
@findex clear-output-translations
806
807
808
809
810

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

811
This allows the same source code repository to be shared
812
between several versions of several Common Lisp implementations,
813
814
815
816
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.
817

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

823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
@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
870

871
872
873
874
875
876
@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.)
877

878
Note that before ASDF 2,
879
880
881
882
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.
883
cl-launch 3.000 and common-lisp-controller 7.2 have been updated
884
to delegate object file placement to ASDF.
885

886
@node Resetting the ASDF configuration,  , Configuring where ASDF stores object files, Configuring ASDF
Robert P. Goldman's avatar
Robert P. Goldman committed
887
888
@section Resetting the ASDF configuration

889
890
@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
891

892
893
894
895
896
897

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
898
   Undoes any ASDF configuration
899
900
901
   regarding source-registry or output-translations.
@end defun

902
@vindex *image-dump-hook*
903
904
905
906
907
908
909
910
911
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.
912

913
@node  Using ASDF, Defining systems with defsystem, Configuring ASDF, Top
914
915
@chapter Using ASDF

Robert P. Goldman's avatar
Robert P. Goldman committed
916
917
@menu
* Loading a system::
918
* Convenience Functions::
Robert P. Goldman's avatar
Robert P. Goldman committed
919
920
921
* Moving on::
@end menu

922
@node Loading a system, Convenience Functions, Using ASDF, Using ASDF
923
924
925
926
@section Loading a system

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

@example
929
(asdf:load-system :@var{foo})
930
931
@end example

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
932
933
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
934
935
936
937
938

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

939
940
941
942
943
Note that the canonical name of a system is a string, in @emph{lowercase}.
System names can also be specified as symbols (including keyword
symbols).
If a symbol is given as argument, its package is ignored,
its @code{symbol-name} is taken, and converted to lowercase.
944
The name must be a suitable value for the @code{:name} initarg
945
to @code{make-pathname} in whatever filesystem the system is to be found.
946

947
Using lowercase as canonical is unconventional,
948
but was selected after some consideration.
949
The type of file systems we  support
950
951
952
953
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
954

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

956
957
@node Convenience Functions, Moving on, Loading a system, Using ASDF
@section Convenience Functions
Robert Goldman's avatar
Robert Goldman committed
958

959
960
961
962
963
964
965
@c I believe thes are all unnecessary because of the function macros
@c below [2016/01/30:rpg]
@c @findex load-system
@c @findex compile-system
@c @findex test-system
@c @findex require-system
@c @findex make
966

967
ASDF provides three commands for the most common system operations:
968
@code{load-system}, @code{compile-system}, and @code{test-system}.
969
970
971
972
973
974
975
976
977
978
979
980

ASDF also provides @code{require-system}, a variant of @code{load-system}
that skips loading systems that are already loaded.  This is sometimes
useful, for example, in order to avoid re-loading libraries that come
pre-loaded into your  lisp implementation.

ASDF also provides @code{make}, a way of allowing system developers to
choose a default operation for their systems.  For example, a developer
who has created a system intended to format a specific document, might
make document-formatting the default operation invoked by @code{make},
instead of loading.  If the system developer doesn't specify in the
system definition, the default operation will be loading.
981

982
983
@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.
984

985
986
987
988

@c FIXME: There should be a @defun for OPERATE, but there isn't.  Not
@c sure where it belongs...  The discussion here is just confusing if
@c the reader doesn't understand how ASDF works. [2016/01/30:rpg]
989
990
991
@findex operate
@findex oos

992
993
Because ASDF is an extensible system
for defining @emph{operations} on @emph{components},
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
994
995
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
996
997
998
(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
999
compiling, loading and testing.
1000

Robert P. Goldman's avatar