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

146 lines
7.4 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 Backward Compatibility (ASDF Manual)</title>
<meta name="description" content="Output Backward Compatibility (ASDF Manual)">
<meta name="keywords" content="Output Backward Compatibility (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-Configuration-DSL.html" rel="next" title="Output Configuration DSL">
<link href="Output-Configurations.html" rel="prev" title="Output Configurations">
<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-Backward-Compatibility">
<div class="header">
<p>
Next: <a href="Output-Configuration-DSL.html" accesskey="n" rel="next">Configuration DSL</a>, Previous: <a href="Output-Configurations.html" accesskey="p" rel="prev">Configurations</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="Backward-Compatibility-2"></span><h3 class="section">9.2 Backward Compatibility</h3>
<span id="index-ASDF_002dBINARY_002dLOCATIONS-compatibility"></span>
<p>We purposely do <em>not</em> provide backward compatibility with earlier versions of
<code>ASDF-Binary-Locations</code> (8 Sept 2009),
<code>common-lisp-controller</code> (7.0) or
<code>cl-launch</code> (2.35),
each of which had similar general capabilities.
The APIs of these programs were not designed
for easy user configuration
through configuration files.
Recent versions of <code>common-lisp-controller</code> (7.2) and <code>cl-launch</code> (3.000)
use the new <code>asdf-output-translations</code> API as defined below.
<code>ASDF-Binary-Locations</code> is fully superseded and not to be used anymore.
</p>
<p>This incompatibility shouldn&rsquo;t inconvenience many people.
Indeed, few people use and customize these packages;
these few people are experts who can trivially adapt to the new configuration.
Most people are not experts, could not properly configure these features
(except inasmuch as the default configuration of
<code>common-lisp-controller</code> and/or <code>cl-launch</code>
might have been doing the right thing for some users),
and yet will experience software that &ldquo;just works&rdquo;,
as configured by the system distributor, or by default.
</p>
<p>Nevertheless, if you are a fan of <code>ASDF-Binary-Locations</code>,
we provide a limited emulation mode:
</p>
<dl class="def">
<dt id="index-enable_002dasdf_002dbinary_002dlocations_002dcompatibility"><span class="category">Function: </span><span><strong>enable-asdf-binary-locations-compatibility</strong> <em>&amp;key centralize-lisp-binaries default-toplevel-directory include-per-user-information map-all-source-files source-to-target-mappings</em><a href='Output-Backward-Compatibility.html#index-enable_002dasdf_002dbinary_002dlocations_002dcompatibility' class='copiable-anchor'> &para;</a></span></dt>
<dd><p>This function will initialize the new <code>asdf-output-translations</code> facility in a way
that emulates the behaviour of the old <code>ASDF-Binary-Locations</code> facility.
Where you would previously set global variables
<var>*centralize-lisp-binaries*</var>,
<var>*default-toplevel-directory*</var>,
<var>*include-per-user-information*</var>,
<var>*map-all-source-files*</var> or <var>*source-to-target-mappings*</var>
you will now have to pass the same values as keyword arguments to this function.
Note however that as an extension the <code>:source-to-target-mappings</code> keyword argument
will accept any valid pathname designator for <code>asdf-output-translations</code>
instead of just strings and pathnames.
</p></dd></dl>
<p>If you insist, you can also keep using the old <code>ASDF-Binary-Locations</code>
(the one available as an extension to load of top of ASDF,
not the one built into a few old versions of ASDF),
but first you must disable <code>asdf-output-translations</code>
with <code>(asdf:disable-output-translations)</code>,
or you might experience &ldquo;interesting&rdquo; issues.
</p>
<p>Also, note that output translation is enabled by default.
To disable it, use <code>(asdf:disable-output-translations)</code>.
</p>
</div>
<hr>
<div class="header">
<p>
Next: <a href="Output-Configuration-DSL.html">Configuration DSL</a>, Previous: <a href="Output-Configurations.html">Configurations</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>