1
0
Fork 0
cl-sites/asdf.common-lisp.dev/asdf/Output-Configurations.html
2023-11-12 11:34:18 +01:00

167 lines
7.5 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>Output Configurations (ASDF Manual)</title>
<meta name="description" content="Output Configurations (ASDF Manual)">
<meta name="keywords" content="Output Configurations (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="Controlling-where-ASDF-saves-compiled-files.html" rel="up" title="Controlling where ASDF saves compiled files">
<link href="Output-Backward-Compatibility.html" rel="next" title="Output Backward Compatibility">
<link href="Controlling-where-ASDF-saves-compiled-files.html" rel="prev" title="Controlling where ASDF saves compiled files">
<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="Output-Configurations">
<div class="header">
<p>
Next: <a href="Output-Backward-Compatibility.html" accesskey="n" rel="next">Backward Compatibility</a>, Previous: <a href="Controlling-where-ASDF-saves-compiled-files.html" accesskey="p" rel="prev">Controlling where ASDF saves compiled files</a>, Up: <a href="Controlling-where-ASDF-saves-compiled-files.html" accesskey="u" rel="up">Controlling where ASDF saves compiled files</a> &nbsp; [<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="Configurations-2"></span><h3 class="section">9.1 Configurations</h3>
<p>Configurations specify mappings from input locations to output locations.
Once again we rely on the XDG base directory specification for configuration.
See <a href="Controlling-where-ASDF-searches-for-systems.html">XDG base directory</a>.
</p>
<ol>
<li> Some hardcoded wrapping output translations configuration may be used.
This allows special output translations (or usually, invariant directories)
to be specified corresponding to the similar special entries in the source registry.
</li><li> An application may explicitly initialize the output-translations
configuration using the Configuration API
in which case this takes precedence.
(see <a href="Controlling-where-ASDF-saves-compiled-files.html">Configuration API</a>.)
It may itself compute this configuration from the command-line,
from a script, from its own configuration file, etc.
</li><li> The source registry will be configured from
the environment variable <code>ASDF_OUTPUT_TRANSLATIONS</code> if it exists.
</li><li> The source registry will be configured from
user configuration file
<samp>$XDG_CONFIG_DIRS/common-lisp/asdf-output-translations.conf</samp>
(which defaults to
<samp>~/.config/common-lisp/asdf-output-translations.conf</samp>)
if it exists.
</li><li> The source registry will be configured from
user configuration directory
<samp>$XDG_CONFIG_DIRS/common-lisp/asdf-output-translations.conf.d/</samp>
(which defaults to
<samp>~/.config/common-lisp/asdf-output-translations.conf.d/</samp>)
if it exists.
</li><li> The source registry will be configured from
system configuration file
<samp>/etc/common-lisp/asdf-output-translations.conf</samp>
if it exists.
</li><li> The source registry will be configured from
system configuration directory
<samp>/etc/common-lisp/asdf-output-translations.conf.d/</samp>
if it exists.
</li></ol>
<p>Each of these configurations is specified as a SEXP
in a trivial domain-specific language (see <a href="Configuration-DSL.html">Configuration DSL</a>).
Additionally, a more shell-friendly syntax is available
for the environment variable (see <a href="Shell_002dfriendly-syntax-for-configuration.html">Shell-friendly syntax for configuration</a>).
</p>
<p>When processing an entry in the above list of configuration methods,
ASDF will stop unless that entry
explicitly or implicitly specifies that it
includes its inherited configuration.
</p>
<p>Note that by default, a per-user cache is used for output files.
This allows the seamless use of shared installations of software
between several users, and takes files out of the way of the developers
when they browse source code,
at the expense of taking a small toll when developers have to clean up
output files and find they need to get familiar with output-translations
first.<a id="DOCF15" href="Output-Configurations.html#FOOT15"><sup>15</sup></a>
</p>
</div>
<div class="footnote">
<hr>
<h4 class="footnotes-heading">Footnotes</h4>
<h5><a id="FOOT15" href="Output-Configurations.html#DOCF15">(15)</a></h5>
<p>A <code>CLEAN-OP</code> would be a partial solution to this problem.</p>
</div>
<hr>
<div class="header">
<p>
Next: <a href="Output-Backward-Compatibility.html">Backward Compatibility</a>, Previous: <a href="Controlling-where-ASDF-saves-compiled-files.html">Controlling where ASDF saves compiled files</a>, Up: <a href="Controlling-where-ASDF-saves-compiled-files.html">Controlling where ASDF saves compiled files</a> &nbsp; [<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>