/usr/share/doc/racket/raco/setup-check-deps.html is in racket-doc 6.7-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"/><title>6.5 Package Dependency Checking</title><link rel="stylesheet" type="text/css" href="../scribble.css" title="default"/><link rel="stylesheet" type="text/css" href="../racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-style.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../doc-site.css" title="default"/><script type="text/javascript" src="../scribble-common.js"></script><script type="text/javascript" src="../manual-racket.js"></script><script type="text/javascript" src="../doc-site.js"></script><script type="text/javascript" src="../local-redirect/local-redirect.js"></script><script type="text/javascript" src="../local-redirect/local-user-redirect.js"></script><!--[if IE 6]><style type="text/css">.SIEHidden { overflow: hidden; }</style><![endif]--></head><body id="doc-racket-lang-org"><div class="tocset"><div class="tocview"><div class="tocviewlist tocviewlisttopspace"><div class="tocviewtitle"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_0");">►</a></td><td></td><td><a href="index.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco</span>:<span class="mywbr"> </span> Racket Command-<wbr></wbr>Line Tools</a></td></tr></table></div><div class="tocviewsublisttop" style="display: none;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1 </td><td><a href="make.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco make</span>:<span class="mywbr"> </span> Compiling Source to Bytecode</a></td></tr><tr><td align="right">2 </td><td><a href="exe.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco exe</span>:<span class="mywbr"> </span> Creating Stand-<wbr></wbr>Alone Executables</a></td></tr><tr><td align="right">3 </td><td><a href="exe-dist.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco distribute</span>:<span class="mywbr"> </span> Sharing Stand-<wbr></wbr>Alone Executables</a></td></tr><tr><td align="right">4 </td><td><a href="planet.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco planet</span>:<span class="mywbr"> </span> Automatic Package Distribution</a></td></tr><tr><td align="right">5 </td><td><a href="pkg.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg</span>:<span class="mywbr"> </span> Package Management</a></td></tr><tr><td align="right">6 </td><td><a href="setup.html" class="tocviewselflink" data-pltdoc="x"><span class="stt">raco setup</span>:<span class="mywbr"> </span> Installation Management</a></td></tr><tr><td align="right">7 </td><td><a href="decompile.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco decompile</span>:<span class="mywbr"> </span> Decompiling Bytecode</a></td></tr><tr><td align="right">8 </td><td><a href="demod.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco demod</span>:<span class="mywbr"> </span> Demodularizing Programs</a></td></tr><tr><td align="right">9 </td><td><a href="link.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco link</span>:<span class="mywbr"> </span> Library Collection Links</a></td></tr><tr><td align="right">10 </td><td><a href="plt.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pack</span>:<span class="mywbr"> </span> Packing Library Collections</a></td></tr><tr><td align="right">11 </td><td><a href="unpack.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco unpack</span>:<span class="mywbr"> </span> Unpacking Library Collections</a></td></tr><tr><td align="right">12 </td><td><a href="ctool.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco ctool</span>:<span class="mywbr"> </span> Working with C Code</a></td></tr><tr><td align="right">13 </td><td><a href="test.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco test</span>:<span class="mywbr"> </span> Run tests</a></td></tr><tr><td align="right">14 </td><td><a href="docs.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco docs</span>:<span class="mywbr"> </span> Documentation Search</a></td></tr><tr><td align="right">15 </td><td><a href="expand.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco expand</span>:<span class="mywbr"> </span> Macro Expansion</a></td></tr><tr><td align="right">16 </td><td><a href="read.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco read</span>:<span class="mywbr"> </span> Reading and Pretty-<wbr></wbr>Printing</a></td></tr><tr><td align="right">17 </td><td><a href="scribble.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco scribble</span>:<span class="mywbr"> </span> Building Documentation</a></td></tr><tr><td align="right">18 </td><td><a href="command.html" class="tocviewlink" data-pltdoc="x">Adding a <span class="stt">raco</span> Command</a></td></tr><tr><td align="right">19 </td><td><a href="config-file.html" class="tocviewlink" data-pltdoc="x">Installation Configuration and Search Paths</a></td></tr></table></div></div><div class="tocviewlist"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_1");">▼</a></td><td>6 </td><td><a href="setup.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco setup</span>:<span class="mywbr"> </span> Installation Management</a></td></tr></table><div class="tocviewsublist" style="display: block;" id="tocview_1"><table cellspacing="0" cellpadding="0"><tr><td align="right">6.1 </td><td><a href="running.html" class="tocviewlink" data-pltdoc="x">Running <span class="stt">raco setup</span></a></td></tr><tr><td align="right">6.2 </td><td><a href="raco-setup-A.html" class="tocviewlink" data-pltdoc="x">Installing <span class="stt">".plt"</span> Archives</a></td></tr><tr><td align="right">6.3 </td><td><a href="setup-info.html" class="tocviewlink" data-pltdoc="x">Controlling <span class="stt">raco setup</span> with <span class="stt">"info.rkt"</span> Files</a></td></tr><tr><td align="right">6.4 </td><td><a href="info_rkt.html" class="tocviewlink" data-pltdoc="x"><span class="stt">"info.rkt"</span> File Format</a></td></tr><tr><td align="right">6.5 </td><td><a href="" class="tocviewselflink" data-pltdoc="x">Package Dependency Checking</a></td></tr><tr><td align="right">6.6 </td><td><a href="setup-plt-plt.html" class="tocviewlink" data-pltdoc="x">API for Setup</a></td></tr><tr><td align="right">6.7 </td><td><a href="_plt-archives.html" class="tocviewlink" data-pltdoc="x">API for Installing <span class="stt">".plt"</span> Archives</a></td></tr><tr><td align="right">6.8 </td><td><a href="dirs.html" class="tocviewlink" data-pltdoc="x">API for Finding Installation Directories</a></td></tr><tr><td align="right">6.9 </td><td><a href="getinfo.html" class="tocviewlink" data-pltdoc="x">API for Reading <span class="stt">"info.rkt"</span> Files</a></td></tr><tr><td align="right">6.10 </td><td><a href="relative-paths.html" class="tocviewlink" data-pltdoc="x">API for Relative Paths</a></td></tr><tr><td align="right">6.11 </td><td><a href="collection-names.html" class="tocviewlink" data-pltdoc="x">API for Collection Names</a></td></tr><tr><td align="right">6.12 </td><td><a href="collection-search.html" class="tocviewlink" data-pltdoc="x">API for Collection Searches</a></td></tr><tr><td align="right">6.13 </td><td><a href="matching-platform.html" class="tocviewlink" data-pltdoc="x">API for Platform Specifications</a></td></tr><tr><td align="right">6.14 </td><td><a href="cross-system.html" class="tocviewlink" data-pltdoc="x">API for Cross-<wbr></wbr>Platform Configuration</a></td></tr><tr><td align="right">6.15 </td><td><a href="xref.html" class="tocviewlink" data-pltdoc="x">API for Cross-<wbr></wbr>References for Installed Manuals</a></td></tr><tr><td align="right">6.16 </td><td><a href="materialize-user-docs.html" class="tocviewlink" data-pltdoc="x">API for Materializing User-<wbr></wbr>Specific Documentation</a></td></tr></table></div></div><div class="tocviewlist"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_2");">►</a></td><td>6.5 </td><td><a href="" class="tocviewselflink" data-pltdoc="x">Package Dependency Checking</a></td></tr></table><div class="tocviewsublistbottom" style="display: none;" id="tocview_2"><table cellspacing="0" cellpadding="0"><tr><td align="right">6.5.1 </td><td><a href="#%28part._.Declaring_.Build-.Time_.Dependencies%29" class="tocviewlink" data-pltdoc="x">Declaring Build-<wbr></wbr>Time Dependencies</a></td></tr><tr><td align="right">6.5.2 </td><td><a href="#%28part._.How_.Dependency_.Checking_.Works%29" class="tocviewlink" data-pltdoc="x">How Dependency Checking Works</a></td></tr></table></div></div></div><div class="tocsub"><div class="tocsubtitle">On this page:</div><table class="tocsublist" cellspacing="0"><tr><td><span class="tocsublinknumber">6.5.1<tt> </tt></span><a href="#%28part._.Declaring_.Build-.Time_.Dependencies%29" class="tocsubseclink" data-pltdoc="x">Declaring Build-<wbr></wbr>Time Dependencies</a></td></tr><tr><td><span class="tocsublinknumber">6.5.2<tt> </tt></span><a href="#%28part._.How_.Dependency_.Checking_.Works%29" class="tocsubseclink" data-pltdoc="x">How Dependency Checking Works</a></td></tr></table></div></div><div class="maincolumn"><div class="main"><div class="navsettop"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.7", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.7");">top</a></span><span class="navright"> <a href="info_rkt.html" title="backward to "6.4 "info.rkt" File Format"" data-pltdoc="x">← prev</a> <a href="setup.html" title="up to "6 raco setup: Installation Management"" data-pltdoc="x">up</a> <a href="setup-plt-plt.html" title="forward to "6.6 API for Setup"" data-pltdoc="x">next →</a></span> </div><h4 x-source-module="(lib "scribblings/raco/raco.scrbl")" x-source-pkg="racket-doc" x-part-tag=""setup-check-deps"">6.5<tt> </tt><a name="(part._setup-check-deps)"></a>Package Dependency Checking</h4><p>When <span class="stt">raco setup</span> is run with no arguments,<span class="refelem"><span class="refcolumn"><span class="refcontent">Unless
<span class="nobreak"><span class="stt">--check-pkg-deps</span></span> is specified, dependency checking is disabled
if any collection is specified for <span class="stt">raco setup</span>.</span></span></span> after building
all collections and documentation, <span class="stt">raco setup</span> check package
dependencies. Specifically, it inspects compiled files and
documentation to check that references across package boundaries are
reflected by dependency declarations in each package-level
<span class="stt">"info.rkt"</span> file (see <a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=pkg&rel=metadata.html&version=6.7" class="Sq" data-pltdoc="x">Package Metadata</a>).</p><p>Dependency checking in <span class="stt">raco setup</span> is intended as an aid to
package developers to help them declare dependencies correctly. The
<span class="stt">raco setup</span> process itself does not depend on package dependency
declarations. Similarly, a package with a missing dependency
declaration may install successfully for other users, as long as they
happen to have the dependencies installed already. A missing
dependency creates trouble for others who install a package without
having the dependency installed already.</p><p>Practically every package depends on the <span class="stt">"base"</span> package,
which includes the collections that are in a minimal variant of
Racket. Declaring a dependency on <span class="stt">"base"</span> may seem
unnecessary, since its collections are always installed. In a future
version of Racket, however, the minimal collections may change, and
the new set of minimal collections will then have a package name, such
as <span class="stt">"base2"</span>. Declaring a dependency on <span class="stt">"base"</span> ensures
forward compatibility, and <span class="stt">raco setup</span> complains if the
declaration is missing.</p><p>To accommodate the early stages of package development, missing
dependencies are not treated as an error for a package that has no
dependency declarations.</p><h5 x-source-module="(lib "scribblings/raco/raco.scrbl")" x-source-pkg="racket-doc" x-part-tag=""Declaring_Build-Time_Dependencies"">6.5.1<tt> </tt><a name="(part._.Declaring_.Build-.Time_.Dependencies)"></a>Declaring Build-Time Dependencies</h5><p>A build-time dependency is one that is not present in a package if it
is converted to a <a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=pkg&rel=strip.html%23%2528tech._binary._package%2529&version=6.7" class="techoutside Sq" data-pltdoc="x"><span class="techinside">binary package</span></a> (see
<a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=pkg&rel=strip.html&version=6.7" class="Sq" data-pltdoc="x">Source, Binary, and Built Packages</a>). For example, <span class="stt">"tests"</span> and
<span class="stt">"scribblings"</span> directories are stripped away in a binary
package by default, so cross-package references from directories with
those names are treated as build dependencies. Similarly,
<span class="RktSym">test</span> and <span class="RktSym">doc</span> submodules are stripped
away, so references within those submodules create build dependencies.</p><p>Build-time-only dependencies can be listed as <span class="RktSym">build-deps</span>
instead of <span class="RktSym">deps</span> in a package’s <span class="stt">"info.rkt"</span> file.
Dependencies listed in <span class="RktSym">deps</span>, meanwhile, are treated as both
run-time and build-time dependencies. The advantage of using
<span class="RktSym">build-deps</span>, instead of listing all dependencies in
<span class="RktSym">deps</span>, is that a binary version of the package can install
with fewer dependencies.</p><h5 x-source-module="(lib "scribblings/raco/raco.scrbl")" x-source-pkg="racket-doc" x-part-tag=""How_Dependency_Checking_Works"">6.5.2<tt> </tt><a name="(part._.How_.Dependency_.Checking_.Works)"></a>How Dependency Checking Works</h5><p>Dependency checking uses <span class="stt">".zo"</span> files, associated
<span class="stt">".dep"</span> files (see <a href="Dependency_Files.html" data-pltdoc="x">Dependency Files</a>), and the
documentation index. Dynamic references, such as through
<span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Module_Names_and_Loading.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._dynamic-require%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">dynamic-require</a></span>, are not visible to the dependency checker;
only dependencies via <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=require.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._require%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x">require</a></span>,
<span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Filesystem.html%23%2528form._%2528%2528lib._racket%252Fruntime-path..rkt%2529._define-runtime-module-path-index%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x">define-runtime-module-path-index</a></span>, and other forms that
cooperate with <span class="RktSym">raco</span><span class="stt"> </span><span class="RktSym">make</span> are visible for dependency checking.</p><p>Dependency checking is sensitive to whether a dependency is needed
only as a build-time dependency. If <span class="stt">raco setup</span> detects that a
missing dependency could be added as a built-time dependency, it will
suggest the addition, but <span class="stt">raco setup</span> will not suggest
converting a normal dependency to a build-time dependency (since every
normal dependency counts as a build-time dependency, too).</p><div class="navsetbottom"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.7", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.7");">top</a></span><span class="navright"> <a href="info_rkt.html" title="backward to "6.4 "info.rkt" File Format"" data-pltdoc="x">← prev</a> <a href="setup.html" title="up to "6 raco setup: Installation Management"" data-pltdoc="x">up</a> <a href="setup-plt-plt.html" title="forward to "6.6 API for Setup"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>
|