<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.19.1">
<title>compile – Mix v1.7.2</title>
<link rel="stylesheet" href="dist/app-240d7fc7e5.css" />
<link rel="canonical" href="https://hexdocs.pm/mix/v1.7/Mix.Tasks.Compile.html" />
<script src="dist/sidebar_items-0c0044e6e4.js"></script>
</head>
<body data-type="tasks">
<script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">
<button class="sidebar-button sidebar-toggle">
<span class="icon-menu" aria-hidden="true"></span>
<span class="sr-only">Toggle Sidebar</span>
</button>
<button class="sidebar-button night-mode-toggle">
<span class="icon-theme" aria-hidden="true"></span>
<span class="sr-only">Toggle Theme</span>
</button>
<section class="sidebar">
<a href="http://elixir-lang.org/docs.html" class="sidebar-projectLink">
<div class="sidebar-projectDetails">
<h1 class="sidebar-projectName">
Mix </h1>
<h2 class="sidebar-projectVersion">
v1.7.2
</h2>
</div>
<img src="assets/logo.png" alt="Mix" class="sidebar-projectImage">
</a>
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button">
<span class="icon-search" aria-hidden="true"></span>
</button>
<input name="q" type="text" id="search-list" class="search-input" placeholder="Search" aria-label="Search" autocomplete="off" />
</form>
<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>
<li><a id="modules-list" href="#full-list">Modules</a></li>
<li><a id="exceptions-list" href="#full-list">Exceptions</a></li>
<li><a id="tasks-list" href="#full-list">Mix Tasks</a></li>
</ul>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<small class="visible-xs">Mix v1.7.2</small>
mix compile
<a href="https://github.com/elixir-lang/elixir/blob/v1.7.2/lib/mix/lib/mix/tasks/compile.ex#L1" title="View Source" class="view-source" rel="help">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</h1>
<section id="moduledoc">
<p>A meta task that compiles source files.</p>
<p>It simply runs the compilers registered in your project and returns
a tuple with the compilation status and a list of diagnostics.</p>
<h2 id="module-configuration" class="section-heading">
<a href="#module-configuration" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Configuration
</h2>
<ul>
<li><p><code class="inline">:compilers</code> - compilers to run, defaults to <a href="Mix.html#compilers/0"><code class="inline">Mix.compilers/0</code></a>,
which are <code class="inline">[:yecc, :leex, :erlang, :elixir, :xref, :app]</code>.</p>
</li>
<li><p><code class="inline">:consolidate_protocols</code> - when <code class="inline">true</code>, runs protocol
consolidation via the <code class="inline">compile.protocols</code> task. The default
value is <code class="inline">true</code>.</p>
</li>
<li><p><code class="inline">:build_embedded</code> - when <code class="inline">true</code>, embeds all code and priv
content in the <code class="inline">_build</code> directory instead of using symlinks.</p>
</li>
<li><p><code class="inline">:build_path</code> - the directory where build artifacts
should be written to. This option is intended only for
child apps within a larger umbrella application so that
each child app can use the common <code class="inline">_build</code> directory of
the parent umbrella. In a non-umbrella context, configuring
this has undesirable side-effects (such as skipping some
compiler checks) and should be avoided.</p>
</li>
</ul>
<h2 id="module-compilers" class="section-heading">
<a href="#module-compilers" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Compilers
</h2>
<p>To see documentation for each specific compiler, you must
invoke <code class="inline">help</code> directly for the compiler command:</p>
<pre><code class="nohighlight makeup elixir"><span class="n">mix</span><span class="w"> </span><span class="n">help</span><span class="w"> </span><span class="n">compile</span><span class="o">.</span><span class="n">elixir</span><span class="w">
</span><span class="n">mix</span><span class="w"> </span><span class="n">help</span><span class="w"> </span><span class="n">compile</span><span class="o">.</span><span class="n">erlang</span></code></pre>
<p>You can get a list of all compilers by running:</p>
<pre><code class="nohighlight makeup elixir"><span class="n">mix</span><span class="w"> </span><span class="n">compile</span><span class="w"> </span><span class="o">--</span><span class="n">list</span></code></pre>
<h2 id="module-command-line-options" class="section-heading">
<a href="#module-command-line-options" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Command line options
</h2>
<ul>
<li><code class="inline">--list</code> - lists all enabled compilers
</li>
<li><code class="inline">--no-archives-check</code> - skips checking of archives
</li>
<li><code class="inline">--no-deps-check</code> - skips checking of dependencies
</li>
<li><code class="inline">--no-protocol-consolidation</code> - skips protocol consolidation
</li>
<li><code class="inline">--force</code> - forces compilation
</li>
<li><code class="inline">--return-errors</code> - returns error status and diagnostics instead of exiting on error
</li>
<li><code class="inline">--erl-config</code> - path to an Erlang term file that will be loaded as mix config
</li>
</ul>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#compilers/0">compilers()</a>
</div>
<div class="summary-synopsis"><p>Returns all compilers</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#manifests/0">manifests()</a>
</div>
<div class="summary-synopsis"><p>Returns manifests for all compilers</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#run/1">run(args)</a>
</div>
<div class="summary-synopsis"><p>Receives command-line arguments and performs compilation. If it
produces errors, warnings, or any other diagnostic information,
it should return a tuple with the status and a list of diagnostics</p>
</div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Functions
</h1>
<div class="detail" id="compilers/0">
<div class="detail-header">
<a href="#compilers/0" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">compilers()</span>
<a href="https://github.com/elixir-lang/elixir/blob/v1.7.2/lib/mix/lib/mix/tasks/compile.ex#L149" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Returns all compilers.</p>
</section>
</div>
<div class="detail" id="manifests/0">
<div class="detail-header">
<a href="#manifests/0" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">manifests()</span>
<a href="https://github.com/elixir-lang/elixir/blob/v1.7.2/lib/mix/lib/mix/tasks/compile.ex#L156" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Returns manifests for all compilers.</p>
</section>
</div>
<div class="detail" id="run/1">
<div class="detail-header">
<a href="#run/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">run(args)</span>
<a href="https://github.com/elixir-lang/elixir/blob/v1.7.2/lib/mix/lib/mix/tasks/compile.ex#L86" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Receives command-line arguments and performs compilation. If it
produces errors, warnings, or any other diagnostic information,
it should return a tuple with the status and a list of diagnostics.</p>
<p>Callback implementation for <a href="Mix.Task.Compiler.html#c:run/1"><code class="inline">Mix.Task.Compiler.run/1</code></a>.</p>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener">ExDoc</a> (v0.19.1),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
</footer>
</div>
</div>
</section>
</div>
<script src="dist/app-a0c90688fa.js"></script>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
016232f1d9a3f7bee85855d35a2bca58
>
files
>
226
