136 lines
6 KiB
HTML
136 lines
6 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 here directive (ASDF Manual)</title>
|
|
|
|
<meta name="description" content="The here directive (ASDF Manual)">
|
|
<meta name="keywords" content="The here directive (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="Configuration-Directories.html" rel="up" title="Configuration Directories">
|
|
<link href="Configuration-Directories.html" rel="prev" title="Configuration Directories">
|
|
<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="subsection" id="The-here-directive">
|
|
<div class="header">
|
|
<p>
|
|
Previous: <a href="Configuration-Directories.html" accesskey="p" rel="prev">Configuration Directories</a>, Up: <a href="Configuration-Directories.html" accesskey="u" rel="up">Configuration Directories</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-_003ahere-directive"></span><h4 class="subsection">8.6.1 The :here directive</h4>
|
|
|
|
<p>The <code>:here</code> directive is an absolute pathname designator that
|
|
refers to the directory containing the configuration file currently
|
|
being processed.
|
|
</p>
|
|
<p>The <code>:here</code> directive is intended to simplify the delivery of
|
|
complex CL systems, and for easy configuration of projects shared through
|
|
revision control systems, in accordance with our design principle that
|
|
each participant should be able to provide all and only the information
|
|
available to him or her.
|
|
</p>
|
|
<p>Consider a person X who has set up the source code repository for a
|
|
complex project with a master directory <samp>dir/</samp>. Ordinarily, one
|
|
might simply have the user add a directive that would look something
|
|
like this:
|
|
</p><div class="example">
|
|
<pre class="example"> (:tree "path/to/dir")
|
|
</pre></div>
|
|
<p>But what if X knows that there are very large subtrees
|
|
under dir that are filled with, e.g., Java source code, image files for
|
|
icons, etc.? All of the asdf system definitions are contained in the
|
|
subdirectories <samp>dir/src/lisp/</samp> and <samp>dir/extlib/lisp/</samp>, and
|
|
these are the only directories that should be searched.
|
|
</p>
|
|
<p>In this case, X can put into <samp>dir/</samp> a file <samp>asdf.conf</samp> that
|
|
contains the following:
|
|
</p><div class="example">
|
|
<pre class="example">(:source-registry
|
|
(:tree (:here "src/lisp/"))
|
|
(:tree (:here "extlib/lisp"))
|
|
(:directory (:here "outlier/")))
|
|
</pre></div>
|
|
|
|
<p>Then when someone else (call her Y) checks out a copy of this
|
|
repository, she need only add
|
|
</p><div class="example">
|
|
<pre class="example">(:include "/path/to/my/checkout/directory/asdf.conf")
|
|
</pre></div>
|
|
<p>to one of her previously-existing asdf source location configuration
|
|
files, or invoke <code>initialize-source-registry</code> with a configuration
|
|
form containing that s-expression. ASDF will find the .conf file that X
|
|
has provided, and then set up source locations within the working
|
|
directory according to X’s (relative) instructions.
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="header">
|
|
<p>
|
|
Previous: <a href="Configuration-Directories.html">Configuration Directories</a>, Up: <a href="Configuration-Directories.html">Configuration Directories</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>
|