171 lines
8.1 KiB
HTML
171 lines
8.1 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ -->
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<!-- This manual describes ASDF, a system definition facility
|
|
for Common Lisp programs and libraries.
|
|
|
|
You can find the latest version of this manual at
|
|
https://common-lisp.net/project/asdf/asdf.html.
|
|
|
|
ASDF Copyright (C) 2001-2019 Daniel Barlow and contributors.
|
|
|
|
This manual Copyright (C) 2001-2019 Daniel Barlow and contributors.
|
|
|
|
This manual revised (C) 2009-2019 Robert P. Goldman and Francois-Rene Rideau.
|
|
|
|
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.
|
|
-->
|
|
<title>The defsystem form (ASDF Manual)</title>
|
|
|
|
<meta name="description" content="The defsystem form (ASDF Manual)">
|
|
<meta name="keywords" content="The defsystem form (ASDF Manual)">
|
|
<meta name="resource-type" content="document">
|
|
<meta name="distribution" content="global">
|
|
<meta name="Generator" content="makeinfo">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
<link href="index.html" rel="start" title="Top">
|
|
<link href="Concept-Index.html" rel="index" title="Concept Index">
|
|
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
|
<link href="Defining-systems-with-defsystem.html" rel="up" title="Defining systems with defsystem">
|
|
<link href="A-more-involved-example.html" rel="next" title="A more involved example">
|
|
<link href="Defining-systems-with-defsystem.html" rel="prev" title="Defining systems with defsystem">
|
|
<style type="text/css">
|
|
<!--
|
|
a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em}
|
|
a.summary-letter {text-decoration: none}
|
|
blockquote.indentedblock {margin-right: 0em}
|
|
div.display {margin-left: 3.2em}
|
|
div.example {margin-left: 3.2em}
|
|
kbd {font-style: oblique}
|
|
pre.display {font-family: inherit}
|
|
pre.format {font-family: inherit}
|
|
pre.menu-comment {font-family: serif}
|
|
pre.menu-preformatted {font-family: serif}
|
|
span.nolinebreak {white-space: nowrap}
|
|
span.roman {font-family: initial; font-weight: normal}
|
|
span.sansserif {font-family: sans-serif; font-weight: normal}
|
|
span:hover a.copiable-anchor {visibility: visible}
|
|
ul.no-bullet {list-style: none}
|
|
-->
|
|
</style>
|
|
|
|
|
|
</head>
|
|
|
|
<body lang="en">
|
|
<div class="section" id="The-defsystem-form">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="A-more-involved-example.html" accesskey="n" rel="next">A more involved example</a>, Previous: <a href="Defining-systems-with-defsystem.html" accesskey="p" rel="prev">Defining systems with defsystem</a>, Up: <a href="Defining-systems-with-defsystem.html" accesskey="u" rel="up">Defining systems with defsystem</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<hr>
|
|
<span id="The-defsystem-form-1"></span><h3 class="section">6.1 The defsystem form</h3>
|
|
<span id="index-defsystem"></span>
|
|
<span id="index-asdf_002duser"></span>
|
|
<span id="index-load_002dasd"></span>
|
|
|
|
<p>This section begins with an example of a system definition,
|
|
then gives the full grammar of <code>defsystem</code>.
|
|
</p>
|
|
<p>Let’s look at a simple system.
|
|
This is a complete file that should be saved as <samp>hello-lisp.asd</samp>
|
|
(in order that ASDF can find it
|
|
when ordered to operate on the system named <code>"hello-lisp"</code>).
|
|
</p>
|
|
<div class="example lisp">
|
|
<pre class="lisp">;; Usual Lisp comments are allowed here
|
|
|
|
(defsystem "hello-lisp"
|
|
:description "hello-lisp: a sample Lisp system."
|
|
:version "0.0.1"
|
|
:author "Joe User <joe@example.com>"
|
|
:licence "Public Domain"
|
|
:depends-on ("optima.ppcre" "command-line-arguments")
|
|
:components ((:file "packages")
|
|
(:file "macros" :depends-on ("packages"))
|
|
(:file "hello" :depends-on ("macros"))))
|
|
</pre></div>
|
|
|
|
<p>Some notes about this example:
|
|
</p>
|
|
<ul>
|
|
<li> The <code>defsystem</code> form defines a system named <code>hello-lisp</code>
|
|
that contains three source files:
|
|
<samp>packages.lisp</samp>, <samp>macros.lisp</samp> and <samp>hello.lisp</samp>.
|
|
|
|
</li><li> The <samp>.lisp</samp> suffix is implicit for Lisp source files.
|
|
The source files are located in the same directory
|
|
as the <code>.asd</code> file with the system definition.
|
|
|
|
</li><li> The file <samp>macros</samp> depends on <samp>packages</samp>
|
|
(presumably because the package it’s in is defined in <samp>packages</samp>),
|
|
and the file <samp>hello</samp> depends on <samp>macros</samp>
|
|
(and hence, transitively on <samp>packages</samp>).
|
|
This means that ASDF will compile and load <samp>packages</samp> then <samp>macros</samp>
|
|
before starting the compilation of file <samp>hello</samp>.
|
|
|
|
</li><li> This example system has external dependencies on two other systems,
|
|
<code>optima.ppcre</code> (that provides a friendly interface to matching regular expressions),
|
|
and <code>command-line-arguments</code> (that provides a way to parse arguments passed from the shell command line).
|
|
To use this system, ASDF must be configured to find installed copies of these systems;
|
|
it will load them before it tries to compile and load <code>hello-lisp</code>.
|
|
|
|
</li><li> This system also defines a bunch of metadata.
|
|
While it is optional to define these fields
|
|
(and other fields like <code>:bug-tracker</code>, <code>:mailto</code>, <code>:long-name</code>,
|
|
<code>:long-description</code>, <code>:source-control</code>),
|
|
it is strongly recommended to define the fields <code>:description</code>, <code>:version</code>, <code>:author</code>, and <code>:licence</code>,
|
|
especially if you intend your software to be eventually included in Quicklisp.
|
|
|
|
</li><li> Make sure you know how the <code>:version</code> numbers will be parsed!
|
|
Only period-separated non-negative integers are accepted at present.
|
|
See <a href="The-defsystem-grammar.html#Version-specifiers">Version specifiers</a>.
|
|
|
|
</li><li> This file contains a single form, the <code>defsystem</code> declaration.
|
|
No <code>in-package</code> form, no <code>asdf:</code> package prefix, no nothing.
|
|
Just the one naked <code>defsystem</code> form.
|
|
This is what we recommend.
|
|
More complex system definition files are possible with arbitrary Lisp code,
|
|
but we recommend that you keep it simple if you can.
|
|
This will make your system definitions more robust and more future-proof.
|
|
|
|
<span id="index-_003aversion"></span>
|
|
|
|
</li></ul>
|
|
|
|
<p>This is all you need to know to define simple systems.
|
|
The next example is much more involved, to give you a glimpse of how you can do more complex things.
|
|
However, since it’s ultimately arbitrary Lisp code, there is no bottom to the rabbit hole.
|
|
</p>
|
|
|
|
</div>
|
|
<hr>
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="A-more-involved-example.html">A more involved example</a>, Previous: <a href="Defining-systems-with-defsystem.html">Defining systems with defsystem</a>, Up: <a href="Defining-systems-with-defsystem.html">Defining systems with defsystem</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|