153 lines
8 KiB
HTML
153 lines
8 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 location API (ASDF Manual)</title>
|
|
|
|
<meta name="description" content="Output location API (ASDF Manual)">
|
|
<meta name="keywords" content="Output location API (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="Credits-for-output-translations.html" rel="next" title="Credits for output translations">
|
|
<link href="Output-Caching-Results.html" rel="prev" title="Output Caching Results">
|
|
<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-location-API">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="Credits-for-output-translations.html" accesskey="n" rel="next">Credits for output translations</a>, Previous: <a href="Output-Caching-Results.html" accesskey="p" rel="prev">Caching Results</a>, Up: <a href="Controlling-where-ASDF-saves-compiled-files.html" accesskey="u" rel="up">Controlling where ASDF saves compiled files</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="Output-location-API-1"></span><h3 class="section">9.8 Output location API</h3>
|
|
|
|
<p>The specified functions are exported from package ASDF.
|
|
</p>
|
|
<dl class="def">
|
|
<dt id="index-initialize_002doutput_002dtranslations"><span class="category">Function: </span><span><strong>initialize-output-translations</strong> <em>&optional PARAMETER</em><a href='Output-location-API.html#index-initialize_002doutput_002dtranslations' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>will read the configuration and initialize all internal variables.
|
|
You may extend or override configuration
|
|
from the environment and configuration files
|
|
with the given <var>PARAMETER</var>, which can be
|
|
<code>nil</code> (no configuration override),
|
|
or a SEXP (in the SEXP DSL),
|
|
a string (as in the string DSL),
|
|
a pathname (of a file or directory with configuration),
|
|
or a symbol (fbound to function that when called returns one of the above).
|
|
</p></dd></dl>
|
|
|
|
<dl class="def">
|
|
<dt id="index-disable_002doutput_002dtranslations"><span class="category">Function: </span><span><strong>disable-output-translations</strong><a href='Output-location-API.html#index-disable_002doutput_002dtranslations' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>will initialize output translations in a way
|
|
that maps every pathname to itself,
|
|
effectively disabling the output translation facility.
|
|
</p></dd></dl>
|
|
|
|
<dl class="def">
|
|
<dt id="index-clear_002doutput_002dtranslations-1"><span class="category">Function: </span><span><strong>clear-output-translations</strong><a href='Output-location-API.html#index-clear_002doutput_002dtranslations-1' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>undoes any output translation configuration
|
|
and clears any cache for the mapping algorithm.
|
|
You might want to call this function
|
|
(or better, <code>clear-configuration</code>)
|
|
before you dump an image that would be resumed
|
|
with a different configuration,
|
|
and return an empty configuration.
|
|
Note that this does not include clearing information about
|
|
systems defined in the current image, only about
|
|
where to look for systems not yet defined.
|
|
</p></dd></dl>
|
|
|
|
<dl class="def">
|
|
<dt id="index-ensure_002doutput_002dtranslations"><span class="category">Function: </span><span><strong>ensure-output-translations</strong> <em>&optional PARAMETER</em><a href='Output-location-API.html#index-ensure_002doutput_002dtranslations' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>checks whether output translations have been initialized.
|
|
If not, initialize them with the given <var>PARAMETER</var>.
|
|
This function will be called before any attempt to operate on a system.
|
|
</p></dd></dl>
|
|
|
|
<dl class="def">
|
|
<dt id="index-apply_002doutput_002dtranslations"><span class="category">Function: </span><span><strong>apply-output-translations</strong> <em>PATHNAME</em><a href='Output-location-API.html#index-apply_002doutput_002dtranslations' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>Applies the configured output location translations to <var>PATHNAME</var>
|
|
(calls <code>ensure-output-translations</code> for the translations).
|
|
</p></dd></dl>
|
|
|
|
<p>Every time you use ASDF’s <code>output-files</code>, or
|
|
anything that uses it (that may compile, such as <code>operate</code>, <code>perform</code>, etc.),
|
|
<code>ensure-output-translations</code> is called with parameter <code>nil</code>,
|
|
which the first time around causes your configuration to be read.
|
|
If you change a configuration file,
|
|
you need to explicitly <code>initialize-output-translations</code> again,
|
|
or maybe <code>clear-output-translations</code> (or <code>clear-configuration</code>),
|
|
which will cause the initialization to happen next time around.
|
|
</p>
|
|
|
|
</div>
|
|
<hr>
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="Credits-for-output-translations.html">Credits for output translations</a>, Previous: <a href="Output-Caching-Results.html">Caching Results</a>, Up: <a href="Controlling-where-ASDF-saves-compiled-files.html">Controlling where ASDF saves compiled files</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>
|