asdf.texinfo 261 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-2016 Daniel Barlow and contributors.
40

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

43
This manual revised @copyright{} 2009-2016 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.2.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
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
85
Manual for Version 3.2.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
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

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

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

ASDF development FAQs

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

@end detailmenu
267
268
269
270
271
272
@end menu

@end ifnottex

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

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

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

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

305
Note that
306
307
308
309
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
310
311
Despite what the name might suggest,
ASDF-Install was never a part of ASDF, it was a separate piece of software.
312
ASDF-Install is also unmaintained and obsolete.
313
We recommend you use Quicklisp
314
(@uref{http://www.quicklisp.org/}) instead,
315
a Common Lisp package manager which works well and is being actively maintained.
316
If you want to download software from version control instead of tarballs,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
317
318
319
320
321
322
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.
323

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


333
334
@node  Quick start summary, Loading ASDF, Introduction, Top
@chapter Quick start summary
335

336
@itemize
337
338
339
340
341

@item To load an ASDF system:

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

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

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

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

374
375

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

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

@end itemize
@end itemize

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





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

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

408
@node  Loading a pre-installed ASDF, Checking whether ASDF is loaded, Loading ASDF, Loading ASDF
409
410
@section Loading a pre-installed ASDF

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

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

451

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

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

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

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

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

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

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

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

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

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

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

501

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

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

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

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

531

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

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

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

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

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

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

557

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

562
563
564
565
566
567
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
568
569
570


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

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

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

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

@itemize @bullet
587

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

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

612
@item
Robert P. Goldman's avatar
Robert P. Goldman committed
613
614
615
616
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
617
618
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
@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/")}
647

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

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

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

664
665
666
667
@lisp
(asdf:clear-source-registry)
@end lisp

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

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

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



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

686
687
688

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

690
Novices may skip this section.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
691
692
Please @emph{do not} use the central-registry if you are a novice,
and @emph{do not} instruct novices to use the central-registry.
693
694
695
696
@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
697
698
699
700
701

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
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
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}.
723

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

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

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

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

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

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

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

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

800

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

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

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

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

821
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
@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
868

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

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

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

887
888
@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
889

890
891
892
893
894
895

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

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

911
@node  Using ASDF, Defining systems with defsystem, Configuring ASDF, Top
912
913
@chapter Using ASDF

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

920
@node Loading a system, Convenience Functions, Using ASDF, Using ASDF
921
922
923
924
@section Loading a system

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

@example
927
(asdf:load-system :@var{foo})
928
929
@end example

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

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

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
937
938
939
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.
940
The name must be a suitable value for the @code{:name} initarg
941
to @code{make-pathname} in whatever filesystem the system is to be found.
942

943
944
The lower-casing-symbols behaviour is unconventional,
but was selected after some consideration.
945
946
947
948
949
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
950

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

952
953
@node Convenience Functions, Moving on, Loading a system, Using ASDF
@section Convenience Functions
Robert Goldman's avatar
Robert Goldman committed
954

955
956
957
958
959
960
961
@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
962

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

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.
977

978
979
@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.
980

981
982
983
984

@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]
985
986
987
@findex operate
@findex oos

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

997
998
@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
999
@c @xref{Configuring ASDF to find your systems}.
1000