Update user guide

author: Loïc Hoguin <[email protected]> 2020-06-18 15:11:15 +0200
committer: Loïc Hoguin <[email protected]> 2020-06-18 15:11:15 +0200
commit: 4f3353c7bc3e6da54b0613d1f0f89759f6dcbe98 (patch)
tree: a6c84711a1e6cdae6d64e870946699d7febdb435
parent: 1e209c658e768911a27fbed8f996e99e8b68f320 (diff)
download: erlang.mk-4f3353c7bc3e6da54b0613d1f0f89759f6dcbe98.tar.gz
erlang.mk-4f3353c7bc3e6da54b0613d1f0f89759f6dcbe98.tar.bz2
erlang.mk-4f3353c7bc3e6da54b0613d1f0f89759f6dcbe98.zip
10 files changed, 113 insertions, 42 deletions
diff --git a/guide/concuerror.html b/guide/concuerror.html
new file mode 100644
index 0000000..32ae140
--- /dev/null
+++ b/guide/concuerror.html
@@ -0,0 +1,71 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="utf-8"/>
+<title>Erlang.mk User Guide</title>
+<style type="text/css"><!--
+body{background:white;color:black;font-family:"Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;justify-content:center;margin:0 auto;padding:0;width:600px}
+header {align-items:center;display:flex;justify-content:center}
+header nav.left{text-align:right;width:150px}
+header nav.right{text-align:left;width:150px}
+header nav a{display:block;margin:1.5em 1em}
+main{margin-top:2em;text-align:justify}
+main h2, main h3{margin-top:2em}
+main h1, main div.chapter>div.titlepage h2{font-size:2em;margin-top:.67em}
+a{color:#d9230f;text-decoration:none}
+a:hover{text-decoration:underline}
+a.xref{display:none}
+h1, h2, h3{font-weight:normal}
+div.navfooter{margin-bottom:1em}
+--></style>
+</head>
+<body>
+<header>
+	<nav class="left">
+		<a href="index.html">User guide</a>
+		<a href="getting_started.html">Tutorials</a>
+	</nav>
+	<a href="/" class="logo"><img src="../res/logo-small.png" alt="Erlang.mk" title="Erlang.mk: A build tool for Erlang that just works" height="200" width="206"/></a>
+	<nav class="right">
+		<a href="https://github.com/ninenines/erlang.mk/tree/master/index">470+ packages</a>
+		<a href="https://github.com/ninenines/erlang.mk/issues">Issues?</a>
+	</nav>
+</header>
+<main>
+
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="dialyzer.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="xref.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="concuerror"></a>Chapter 26. Concuerror</h2></div></div></div><p><a class="ulink" href="https://concuerror.com/" target="_top">Concuerror</a> is a stateless model
+checking tool for Erlang programs. It can be used to detect
+and debug concurrency errors, such as deadlocks and errors
+due to race conditions. The key property of such errors is
+that they only occur on few, specific schedulings of the
+program. Moreover, unlike tools based on randomisation,
+Concuerror can verify the absence of such errors, because
+it tests the program systematically.</p><p>Erlang.mk provides a wrapper around Concuerror.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_configuration_9"></a>26.1. Configuration</h2></div></div></div><p>The <code class="literal">CONCUERROR_TESTS</code> variable must be defined in order to
+use Concuerror. It lists the Concuerror test cases. There
+is currently no way to detect test cases automatically. The
+tests must be listed as <code class="literal">module:function</code> separated by
+whitespace. For example:</p><pre class="programlisting">CONCUERROR_TESTS = ranch_concuerror:start_stop ranch_concuerror:info</pre><p>Concuerror will output some information directly on the
+screen when run, but errors will only be written to a file.
+This is because the error output can be very large. By
+default Erlang.mk instructs Concuerror to save log files
+in the <span class="emphasis"><em>logs/</em></span> directory (shared with Common Test). This
+can be changed by setting <code class="literal">CONCUERROR_LOGS_DIR</code>:</p><pre class="programlisting">CONCUERROR_LOGS_DIR = $(CURDIR)/path/to/logs</pre><p>Concuerror options can be specified using the
+<code class="literal">CONCUERROR_OPTS</code> variable:</p><pre class="programlisting">CONCUERROR_OPTS = -k</pre><p>Note that options may also be specified on a per-module
+basis using the <code class="literal">-concuerror_options([]).</code> attribute.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_writing_tests_3"></a>26.2. Writing tests</h2></div></div></div><p>Concuerror tests are a simple 0-arity function that must
+be exported. For example:</p><pre class="programlisting">-export([info/0]).
+
+info() →
+    %% Ensure we can call ranch:info/1 after starting a listener.
+    SupPid = do_start(),
+    {ok, _} = ranch:start_listener(?FUNCTION_NAME,
+        ranch_erlang_transport, #{
+            num_acceptors ⇒ 1
+        },
+        echo_protocol, []),
+    #{} = ranch:info(?FUNCTION_NAME),
+    do_stop(SupPid).</pre><p>Do not forget to add the function to <code class="literal">CONCUERROR_TESTS</code>
+as well.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_usage_7"></a>26.3. Usage</h2></div></div></div><p>To run Concuerror:</p><pre class="programlisting">$ make concuerror</pre><p>Erlang.mk will create an index of all the test logs in
+the <span class="emphasis"><em>$(CONCUERROR_LOGS_DIR)/concuerror.html</em></span> file.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="dialyzer.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="tests.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="xref.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
+</main>
+</body>
+</html>
diff --git a/guide/contributing.html b/guide/contributing.html
index 6e3f374..a49f1d8 100644
--- a/guide/contributing.html
+++ b/guide/contributing.html
@@ -33,7 +33,7 @@ div.navfooter{margin-bottom:1em}
 </header>
 <main>
 
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="history.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> </td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="contributing"></a>Chapter 31. Contributing</h2></div></div></div><p>You are welcome and encouraged to contribute.</p><p>This is how.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_priorities"></a>31.1. Priorities</h2></div></div></div><p>From the most important to the least important:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="history.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> </td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="contributing"></a>Chapter 32. Contributing</h2></div></div></div><p>You are welcome and encouraged to contribute.</p><p>This is how.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_priorities"></a>32.1. Priorities</h2></div></div></div><p>From the most important to the least important:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
 Bugs
 </li><li class="listitem">
 Package issues/additions
@@ -41,7 +41,7 @@ Package issues/additions
 Refactoring
 </li><li class="listitem">
 Features
-</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_bugs"></a>31.2. Bugs</h2></div></div></div><p>If you have found a bug, you should open a ticket. Include
+</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_bugs"></a>32.2. Bugs</h2></div></div></div><p>If you have found a bug, you should open a ticket. Include
 everything relevant including the command you used, output,
 a link to the code that triggers the issue, why you think
 this is a bug, etc.</p><p>If you think you have found a bug but you are not sure, you
@@ -49,7 +49,7 @@ should open a ticket as previously explained.</p><p>If you have found a bug and
 NOW, open a ticket as previously explained.</p><p>Once you have opened a ticket, be patient, try to answer
 questions in a timely manner and confirm that the bug was
 indeed fixed when it is.</p><p>If you can’t be patient, either try to solve the bug and
-contribute the fix back or become a paying customer.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_code"></a>31.3. Code</h2></div></div></div><p>The code is located in the <span class="emphasis"><em>core/*.mk</em></span> and <span class="emphasis"><em>plugins/*.mk</em></span> files.
+contribute the fix back or become a paying customer.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_code"></a>32.3. Code</h2></div></div></div><p>The code is located in the <span class="emphasis"><em>core/*.mk</em></span> and <span class="emphasis"><em>plugins/*.mk</em></span> files.
 The tests are located in the <span class="emphasis"><em>test/Makefile</em></span> and <span class="emphasis"><em>test/*.mk</em></span> files.</p><p>If you have a fix or a hack for a bug, you should open a
 pull request. Any fix should include a test case that fails
 before the fix and is working after.</p><p>If you have a test case that reproduces a bug, but no fix for
@@ -62,7 +62,7 @@ The value 4 is particular and shows expanded commands right
 before they are executed.</p><p>To run tests in parallel, use the <code class="literal">-j</code> option. It is generally
 a good idea to also use the <code class="literal">-k</code> option to run all tests even
 if one fails. For example: <code class="literal">make check -j 32 -k</code>.</p><p>Some changes should be tested against all packages. Continue
-reading for more details on testing them.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_packages"></a>31.4. Packages</h2></div></div></div><p>You can search existing packages using the <code class="literal">make search q=STRING</code>
+reading for more details on testing them.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_packages"></a>32.4. Packages</h2></div></div></div><p>You can search existing packages using the <code class="literal">make search q=STRING</code>
 command. This can be done both from an Erlang.mk project or
 directly from the Erlang.mk repository.</p><p>Packages can be added to the index using the <code class="literal">pkg_add.sh</code> script.</p><pre class="programlisting">$ git clone https://github.com/$YOURUSERNAME/erlang.mk
 $ cd erlang.mk
@@ -75,11 +75,11 @@ where <code class="literal">PACKAGE</code> is the name of the package, for examp
 This can take a long time. Some packages will fail with certain
 versions of Erlang, or if a prerequisite is missing from your system.
 You can of course speed things up using the <code class="literal">-j</code> and <code class="literal">-k</code> flags.</p><p>After all packages have been tested, you can run the command
-<code class="literal">make summary</code> to know what changed since the previous run.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_documentation"></a>31.5. Documentation</h2></div></div></div><p>The documentation is always right.</p><p>If you think you have found a mistake in the documentation,
+<code class="literal">make summary</code> to know what changed since the previous run.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_documentation"></a>32.5. Documentation</h2></div></div></div><p>The documentation is always right.</p><p>If you think you have found a mistake in the documentation,
 this is a bug. You can either open a ticket or send a pull
 request.</p><p>To make sure that the documentation changes work, install
 the listed <a class="link" href="asciidoc.html" title="Chapter 15. AsciiDoc documentation">Requirements</a> on your system and
-run <code class="literal">make docs</code>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_feature_requests"></a>31.6. Feature requests</h2></div></div></div><p>If you have an awesome idea or need something that Erlang.mk
+run <code class="literal">make docs</code>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_feature_requests"></a>32.6. Feature requests</h2></div></div></div><p>If you have an awesome idea or need something that Erlang.mk
 doesn’t provide yet, open a ticket. Provide as much detail as
 possible.</p><p>If you have code, great! Open a pull request as previously
 explained.</p><p>If not, you can still improve your feature request by writing
diff --git a/guide/dialyzer.html b/guide/dialyzer.html
index 471e876..1a85939 100644
--- a/guide/dialyzer.html
+++ b/guide/dialyzer.html
@@ -33,7 +33,7 @@ div.navfooter{margin-bottom:1em}
 </header>
 <main>
 
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ci.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="xref.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="dialyzer"></a>Chapter 25. Dialyzer</h2></div></div></div><p>Dialyzer is a tool that will detect discrepancies in your
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ci.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="concuerror.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="dialyzer"></a>Chapter 25. Dialyzer</h2></div></div></div><p>Dialyzer is a tool that will detect discrepancies in your
 program. It does so using a technique known as success
 typing analysis which has the advantage of providing no
 false positives. Dialyzer is able to detect type errors,
@@ -66,7 +66,7 @@ Dialyzer creates it automatically.</p><p>The PLT file will be removed when you r
 code. It is possible to configure Erlang.mk to use the
 compiled source files instead. This is done using the
 <code class="literal">DIALYZER_DIRS</code> variable:</p><pre class="programlisting">DIALYZER_DIRS = -r ebin</pre><p>This value must be set before including Erlang.mk to
-function properly.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ci.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="tests.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="xref.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
+function properly.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ci.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="tests.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="concuerror.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
 </main>
 </body>
 </html>
diff --git a/guide/history.html b/guide/history.html
index 279ad39..7231fe1 100644
--- a/guide/history.html
+++ b/guide/history.html
@@ -33,8 +33,8 @@ div.navfooter{margin-bottom:1em}
 </header>
 <main>
 
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="why.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="contributing.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="history"></a>Chapter 30. Short history</h2></div></div></div><p>This chapter aims to be a brief record of the life of the
-Erlang.mk project.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_before_erlang_mk"></a>30.1. Before Erlang.mk</h2></div></div></div><p>Erlang.mk originates from the Cowboy project. Cowboy started
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="why.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="contributing.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="history"></a>Chapter 31. Short history</h2></div></div></div><p>This chapter aims to be a brief record of the life of the
+Erlang.mk project.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_before_erlang_mk"></a>31.1. Before Erlang.mk</h2></div></div></div><p>Erlang.mk originates from the Cowboy project. Cowboy started
 as a Rebar project and I, Loïc Hoguin, was very happy with it
 for a couple years. Over time however I started getting annoyed
 and frustrated by a number of things, including bad defaults,
@@ -46,7 +46,7 @@ than a minute to complete.</p><p>Following this success I started removing a lit
 on the fateful day of January 5th, 2013, removed the dependency
 on Rebar entirely. Rebar, and in particular the concept of
 dependencies, was, and still is, a pretty strong influence.</p><p>Erlang.mk was conceived.</p><p>A few months passed and, on May 1st, 2013, the Erlang.mk
-repository was created. Erlang.mk was born.</p><p>Little did I know how much it would grow.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_lifetime_of_the_project"></a>30.2. Lifetime of the project</h2></div></div></div><p>Erlang.mk would eventually become a much larger file able to
+repository was created. Erlang.mk was born.</p><p>Little did I know how much it would grow.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_lifetime_of_the_project"></a>31.2. Lifetime of the project</h2></div></div></div><p>Erlang.mk would eventually become a much larger file able to
 deal with many more projects than just Cowboy. From the birth
 of the project, the biggest force for growth was user contributions,
 because Erlang.mk appealed to a variety of people with different
diff --git a/guide/index.html b/guide/index.html
index d545587..415948f 100644
--- a/guide/index.html
+++ b/guide/index.html
@@ -33,7 +33,7 @@ div.navfooter{margin-bottom:1em}
 </header>
 <main>
 
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="installation.html">Next</a></td></tr></table><hr /></div><div xml:lang="en" class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="idm1"></a>Erlang.mk User Guide</h1></div><div><div class="author"><h3 class="author"><span class="firstname">Loïc</span> <span class="surname">Hoguin</span></h3><code class="email">&lt;<a class="email" href="mailto:[email protected]">[email protected]</a>&gt;</code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="chapter"><a href="installation.html">1. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="installation.html#_on_unix">1.1. On Unix</a></span></dt><dt><span class="section"><a href="installation.html#_on_windows">1.2. On Windows</a></span></dt></dl></dd><dt><span class="chapter"><a href="getting_started.html">2. Getting started</a></span></dt><dd><dl><dt><span class="section"><a href="getting_started.html#_creating_a_folder_for_your_project">2.1. Creating a folder for your project</a></span></dt><dt><span class="section"><a href="getting_started.html#_downloading_erlang_mk">2.2. Downloading Erlang.mk</a></span></dt><dt><span class="section"><a href="getting_started.html#_getting_started_with_otp_applications">2.3. Getting started with OTP applications</a></span></dt><dt><span class="section"><a href="getting_started.html#_getting_started_with_otp_libraries">2.4. Getting started with OTP libraries</a></span></dt><dt><span class="section"><a href="getting_started.html#_getting_started_with_otp_releases">2.5. Getting started with OTP releases</a></span></dt><dt><span class="section"><a href="getting_started.html#_getting_started_from_scratch">2.6. Getting started from scratch</a></span></dt><dt><span class="section"><a href="getting_started.html#_using_spaces_instead_of_tabs">2.7. Using spaces instead of tabs</a></span></dt><dt><span class="section"><a href="getting_started.html#_using_templates">2.8. Using templates</a></span></dt><dt><span class="section"><a href="getting_started.html#_hiding_erlang_mk_from_git">2.9. Hiding Erlang.mk from git</a></span></dt><dt><span class="section"><a href="getting_started.html#_getting_help">2.10. Getting help</a></span></dt></dl></dd><dt><span class="chapter"><a href="overview.html">3. Overview</a></span></dt><dd><dl><dt><span class="section"><a href="overview.html#_building_your_project">3.1. Building your project</a></span></dt><dt><span class="section"><a href="overview.html#_exploring_the_package_index">3.2. Exploring the package index</a></span></dt><dt><span class="section"><a href="overview.html#_generating_documentation">3.3. Generating documentation</a></span></dt><dt><span class="section"><a href="overview.html#_running_tests">3.4. Running tests</a></span></dt><dt><span class="section"><a href="overview.html#_need_more">3.5. Need more?</a></span></dt></dl></dd><dt><span class="chapter"><a href="updating.html">4. Updating Erlang.mk</a></span></dt><dd><dl><dt><span class="section"><a href="updating.html#_initial_bootstrap">4.1. Initial bootstrap</a></span></dt><dt><span class="section"><a href="updating.html#_updating">4.2. Updating</a></span></dt><dt><span class="section"><a href="updating.html#_customizing_the_build">4.3. Customizing the build</a></span></dt></dl></dd><dt><span class="chapter"><a href="limitations.html">5. Limitations</a></span></dt><dd><dl><dt><span class="section"><a href="limitations.html#_erlang_must_be_available">5.1. Erlang must be available</a></span></dt><dt><span class="section"><a href="limitations.html#_spaces_in_path">5.2. Spaces in path</a></span></dt><dt><span class="section"><a href="limitations.html#_dependency_tracking_and_modification_times">5.3. Dependency tracking and modification times</a></span></dt></dl></dd><dt><span class="part"><a href="code.html">I. Code</a></span></dt><dd><dl><dt><span class="chapter"><a href="building.html">6. Building</a></span></dt><dd><dl><dt><span class="section"><a href="building.html#_how_to_build">6.1. How to build</a></span></dt><dt><span class="section"><a href="building.html#_what_to_build">6.2. What to build</a></span></dt><dt><span class="section"><a href="building.html#_application_resource_file">6.3. Application resource file</a></span></dt><dt><span class="section"><a href="building.html#_automatic_application_resource_file_values">6.4. Automatic application resource file values</a></span></dt><dt><span class="section"><a href="building.html#_file_formats">6.5. File formats</a></span></dt><dt><span class="section"><a href="building.html#_compilation_options">6.6. Compilation options</a></span></dt><dt><span class="section"><a href="building.html#_cold_and_hot_builds">6.7. Cold and hot builds</a></span></dt><dt><span class="section"><a href="building.html#_dependency_tracking">6.8. Dependency tracking</a></span></dt><dt><span class="section"><a href="building.html#_generating_erlang_source">6.9. Generating Erlang source</a></span></dt><dt><span class="section"><a href="building.html#_cleaning">6.10. Cleaning</a></span></dt></dl></dd><dt><span class="chapter"><a href="deps.html">7. Packages and dependencies</a></span></dt><dd><dl><dt><span class="section"><a href="deps.html#_searching_packages">7.1. Searching packages</a></span></dt><dt><span class="section"><a href="deps.html#_adding_dependencies_to_your_project">7.2. Adding dependencies to your project</a></span></dt><dt><span class="section"><a href="deps.html#_how_deps_are_fetched_and_built">7.3. How deps are fetched and built</a></span></dt><dt><span class="section"><a href="deps.html#_fetching_and_listing_dependencies_only">7.4. Fetching and listing dependencies only</a></span></dt><dt><span class="section"><a href="deps.html#_querying_dependencies">7.5. Querying dependencies</a></span></dt><dt><span class="section"><a href="deps.html#_ignoring_unwanted_dependencies">7.6. Ignoring unwanted dependencies</a></span></dt><dt><span class="section"><a href="deps.html#_dependencies_directory">7.7. Dependencies directory</a></span></dt><dt><span class="section"><a href="deps.html#_many_applications_in_one_repository">7.8. Many applications in one repository</a></span></dt><dt><span class="section"><a href="deps.html#_repositories_with_no_application_at_the_root_level">7.9. Repositories with no application at the root level</a></span></dt><dt><span class="section"><a href="deps.html#_autopatch">7.10. Autopatch</a></span></dt><dt><span class="section"><a href="deps.html#_dealing_with_duplicate_modules">7.11. Dealing with duplicate modules</a></span></dt><dt><span class="section"><a href="deps.html#_skipping_deps">7.12. Skipping deps</a></span></dt></dl></dd><dt><span class="chapter"><a href="ports.html">8. NIFs and port drivers</a></span></dt><dd><dl><dt><span class="section"><a href="ports.html#_c_source_code_location_and_erlang_environment">8.1. C source code location and Erlang environment</a></span></dt><dt><span class="section"><a href="ports.html#_using_a_custom_makefile">8.2. Using a custom Makefile</a></span></dt><dt><span class="section"><a href="ports.html#_using_erlang_mk_directly">8.3. Using Erlang.mk directly</a></span></dt><dt><span class="section"><a href="ports.html#_propagating_compile_and_linker_flags_to_sub_makefiles">8.4. Propagating compile and linker flags to sub-Makefiles</a></span></dt></dl></dd><dt><span class="chapter"><a href="relx.html">9. Releases</a></span></dt><dd><dl><dt><span class="section"><a href="relx.html#_setup">9.1. Setup</a></span></dt><dt><span class="section"><a href="relx.html#_configuration">9.2. Configuration</a></span></dt><dt><span class="section"><a href="relx.html#_generating_the_release">9.3. Generating the release</a></span></dt><dt><span class="section"><a href="relx.html#_running_the_release">9.4. Running the release</a></span></dt><dt><span class="section"><a href="relx.html#_upgrading_a_release">9.5. Upgrading a release</a></span></dt><dt><span class="section"><a href="relx.html#_getting_relx_semver_value">9.6. Getting Relx semver value</a></span></dt></dl></dd><dt><span class="chapter"><a href="sfx.html">10. Self-extracting releases</a></span></dt><dd><dl><dt><span class="section"><a href="sfx.html#_generating_the_self_extracting_archive">10.1. Generating the self-extracting archive</a></span></dt><dt><span class="section"><a href="sfx.html#_running_the_release_2">10.2. Running the release</a></span></dt></dl></dd><dt><span class="chapter"><a href="escript.html">11. Escripts</a></span></dt><dd><dl><dt><span class="section"><a href="escript.html#_requirements">11.1. Requirements</a></span></dt><dt><span class="section"><a href="escript.html#_generating_an_escript">11.2. Generating an escript</a></span></dt><dt><span class="section"><a href="escript.html#_configuration_2">11.3. Configuration</a></span></dt><dt><span class="section"><a href="escript.html#_extra_files">11.4. Extra files</a></span></dt><dt><span class="section"><a href="escript.html#_optimizing_for_size">11.5. Optimizing for size</a></span></dt></dl></dd><dt><span class="chapter"><a href="kerl.html">12. OTP version management</a></span></dt><dd><dl><dt><span class="section"><a href="kerl.html#_erlang_versions">12.1. Erlang versions</a></span></dt><dt><span class="section"><a href="kerl.html#otp_version_pinning">12.2. OTP version pinning</a></span></dt><dt><span class="section"><a href="kerl.html#_continuous_integration">12.3. Continuous integration</a></span></dt><dt><span class="section"><a href="kerl.html#_configuring_kerl">12.4. Configuring Kerl</a></span></dt></dl></dd><dt><span class="chapter"><a href="cross_compiling.html">13. Cross compiling</a></span></dt><dd><dl><dt><span class="section"><a href="cross_compiling.html#_compiling">13.1. Compiling</a></span></dt><dt><span class="section"><a href="cross_compiling.html#_building_the_release">13.2. Building the release</a></span></dt></dl></dd><dt><span class="chapter"><a href="compat.html">14. Compatibility with other build tools</a></span></dt><dd><dl><dt><span class="section"><a href="compat.html#_rebar_projects_as_erlang_mk_dependencies">14.1. Rebar projects as Erlang.mk dependencies</a></span></dt><dt><span class="section"><a href="compat.html#_erlang_mk_projects_as_rebar_dependencies">14.2. Erlang.mk projects as Rebar dependencies</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="docs.html">II. Documentation</a></span></dt><dd><dl><dt><span class="chapter"><a href="asciidoc.html">15. AsciiDoc documentation</a></span></dt><dd><dl><dt><span class="section"><a href="asciidoc.html#_requirements_2">15.1. Requirements</a></span></dt><dt><span class="section"><a href="asciidoc.html#_writing_asciidoc_documentation">15.2. Writing AsciiDoc documentation</a></span></dt><dt><span class="section"><a href="asciidoc.html#_configuration_3">15.3. Configuration</a></span></dt><dt><span class="section"><a href="asciidoc.html#_usage">15.4. Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="edoc.html">16. EDoc comments</a></span></dt><dd><dl><dt><span class="section"><a href="edoc.html#_writing_edoc_comments">16.1. Writing EDoc comments</a></span></dt><dt><span class="section"><a href="edoc.html#_configuration_4">16.2. Configuration</a></span></dt><dt><span class="section"><a href="edoc.html#_usage_2">16.3. Usage</a></span></dt><dt><span class="section"><a href="edoc.html#_running_edoc_on_all_applications">16.4. Running EDoc on all applications</a></span></dt></dl></dd><dt><span class="chapter"><a href="sphinx.html">17. Sphinx documentation</a></span></dt><dd><dl><dt><span class="section"><a href="sphinx.html#_writing_sphinx_documentation">17.1. Writing Sphinx documentation</a></span></dt><dt><span class="section"><a href="sphinx.html#_basic_setup">17.2. Basic setup</a></span></dt><dt><span class="section"><a href="sphinx.html#_erlang_mk_configuration">17.3. Erlang.mk configuration</a></span></dt><dt><span class="section"><a href="sphinx.html#_generating_man_pages">17.4. Generating man pages</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="tests.html">III. Tests</a></span></dt><dd><dl><dt><span class="chapter"><a href="shell.html">18. Erlang shell</a></span></dt><dd><dl><dt><span class="section"><a href="shell.html#_configuration_5">18.1. Configuration</a></span></dt><dt><span class="section"><a href="shell.html#_usage_3">18.2. Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="eunit.html">19. EUnit</a></span></dt><dd><dl><dt><span class="section"><a href="eunit.html#_writing_tests">19.1. Writing tests</a></span></dt><dt><span class="section"><a href="eunit.html#_configuration_6">19.2. Configuration</a></span></dt><dt><span class="section"><a href="eunit.html#_usage_4">19.3. Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="ct.html">20. Common Test</a></span></dt><dd><dl><dt><span class="section"><a href="ct.html#_writing_tests_2">20.1. Writing tests</a></span></dt><dt><span class="section"><a href="ct.html#_configuration_7">20.2. Configuration</a></span></dt><dt><span class="section"><a href="ct.html#_usage_5">20.3. Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="proper.html">21. PropEr</a></span></dt><dt><span class="chapter"><a href="triq.html">22. Triq</a></span></dt><dt><span class="chapter"><a href="coverage.html">23. Code coverage</a></span></dt><dd><dl><dt><span class="section"><a href="coverage.html#_enabling_cover_when_running_tests">23.1. Enabling cover when running tests</a></span></dt><dt><span class="section"><a href="coverage.html#_adding_applications_to_the_cover_report">23.2. Adding applications to the cover report</a></span></dt><dt><span class="section"><a href="coverage.html#_configuring_paths">23.3. Configuring paths</a></span></dt><dt><span class="section"><a href="coverage.html#_merging_coverdata_files">23.4. Merging coverdata files</a></span></dt></dl></dd><dt><span class="chapter"><a href="ci.html">24. Continuous integration</a></span></dt><dd><dl><dt><span class="section"><a href="ci.html#_configuring_erlang_otp_versions_to_test">24.1. Configuring Erlang/OTP versions to test</a></span></dt><dt><span class="section"><a href="ci.html#_running_tests_across_all_configured_versions">24.2. Running tests across all configured versions</a></span></dt><dt><span class="section"><a href="ci.html#_extending_the_ci_targets">24.3. Extending the CI targets</a></span></dt></dl></dd><dt><span class="chapter"><a href="dialyzer.html">25. Dialyzer</a></span></dt><dd><dl><dt><span class="section"><a href="dialyzer.html#_how_it_works">25.1. How it works</a></span></dt><dt><span class="section"><a href="dialyzer.html#_configuration_8">25.2. Configuration</a></span></dt><dt><span class="section"><a href="dialyzer.html#_usage_6">25.3. Usage</a></span></dt><dt><span class="section"><a href="dialyzer.html#_dialyzing_beam_files">25.4. Dialyzing beam files</a></span></dt></dl></dd><dt><span class="chapter"><a href="xref.html">26. Xref</a></span></dt></dl></dd><dt><span class="part"><a href="plugins.html">IV. Third-party plugins</a></span></dt><dd><dl><dt><span class="chapter"><a href="plugins_usage.html">27. External plugins</a></span></dt><dd><dl><dt><span class="section"><a href="plugins_usage.html#_loading_all_plugins_from_a_dependency">27.1. Loading all plugins from a dependency</a></span></dt><dt><span class="section"><a href="plugins_usage.html#_loading_one_plugin_from_a_dependency">27.2. Loading one plugin from a dependency</a></span></dt><dt><span class="section"><a href="plugins_usage.html#_writing_external_plugins">27.3. Writing external plugins</a></span></dt><dt><span class="section"><a href="plugins_usage.html#_early_stage_plugins">27.4. Early-stage plugins</a></span></dt><dt><span class="section"><a href="plugins_usage.html#_loading_plugins_local_to_the_application">27.5. Loading  plugins local to the application</a></span></dt></dl></dd><dt><span class="chapter"><a href="plugins_list.html">28. List of plugins</a></span></dt><dd><dl><dt><span class="section"><a href="plugins_list.html#_ci_erlang_mk">28.1. ci.erlang.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_efene_mk">28.2. efene.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_elixir_mk">28.3. elixir.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_elvis_mk">28.4. elvis.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_esh_mk">28.5. esh.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_geas">28.6. geas</a></span></dt><dt><span class="section"><a href="plugins_list.html#_hexer_mk">28.7. hexer.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_hexpm_mk">28.8. hexpm.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_jorel">28.9. jorel</a></span></dt><dt><span class="section"><a href="plugins_list.html#_lfe_mk">28.10. lfe.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_mix_mk">28.11. mix.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_reload_mk">28.12. reload.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_rust_mk">28.13. rust.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_version_mk">28.14. version.mk</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="about.html">V. About Erlang.mk</a></span></dt><dd><dl><dt><span class="chapter"><a href="why.html">29. Why Erlang.mk</a></span></dt><dd><dl><dt><span class="section"><a href="why.html#_erlang_mk_is_fast">29.1. Erlang.mk is fast</a></span></dt><dt><span class="section"><a href="why.html#_erlang_mk_gives_you_the_full_power_of_unix">29.2. Erlang.mk gives you the full power of Unix</a></span></dt><dt><span class="section"><a href="why.html#_erlang_mk_is_a_text_file">29.3. Erlang.mk is a text file</a></span></dt><dt><span class="section"><a href="why.html#_erlang_mk_can_manage_erlang_itself">29.4. Erlang.mk can manage Erlang itself</a></span></dt><dt><span class="section"><a href="why.html#_erlang_mk_can_do_more_than_erlang">29.5. Erlang.mk can do more than Erlang</a></span></dt><dt><span class="section"><a href="why.html#_erlang_mk_integrates_nicely_in_make_and_automake_projects">29.6. Erlang.mk integrates nicely in Make and Automake projects</a></span></dt></dl></dd><dt><span class="chapter"><a href="history.html">30. Short history</a></span></dt><dd><dl><dt><span class="section"><a href="history.html#_before_erlang_mk">30.1. Before Erlang.mk</a></span></dt><dt><span class="section"><a href="history.html#_lifetime_of_the_project">30.2. Lifetime of the project</a></span></dt></dl></dd><dt><span class="chapter"><a href="contributing.html">31. Contributing</a></span></dt><dd><dl><dt><span class="section"><a href="contributing.html#_priorities">31.1. Priorities</a></span></dt><dt><span class="section"><a href="contributing.html#_bugs">31.2. Bugs</a></span></dt><dt><span class="section"><a href="contributing.html#_code">31.3. Code</a></span></dt><dt><span class="section"><a href="contributing.html#_packages">31.4. Packages</a></span></dt><dt><span class="section"><a href="contributing.html#_documentation">31.5. Documentation</a></span></dt><dt><span class="section"><a href="contributing.html#_feature_requests">31.6. Feature requests</a></span></dt></dl></dd></dl></dd></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="installation.html">Next</a></td></tr></table></div>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="installation.html">Next</a></td></tr></table><hr /></div><div xml:lang="en" class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="idm1"></a>Erlang.mk User Guide</h1></div><div><div class="author"><h3 class="author"><span class="firstname">Loïc</span> <span class="surname">Hoguin</span></h3><code class="email">&lt;<a class="email" href="mailto:[email protected]">[email protected]</a>&gt;</code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="chapter"><a href="installation.html">1. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="installation.html#_on_unix">1.1. On Unix</a></span></dt><dt><span class="section"><a href="installation.html#_on_windows">1.2. On Windows</a></span></dt></dl></dd><dt><span class="chapter"><a href="getting_started.html">2. Getting started</a></span></dt><dd><dl><dt><span class="section"><a href="getting_started.html#_creating_a_folder_for_your_project">2.1. Creating a folder for your project</a></span></dt><dt><span class="section"><a href="getting_started.html#_downloading_erlang_mk">2.2. Downloading Erlang.mk</a></span></dt><dt><span class="section"><a href="getting_started.html#_getting_started_with_otp_applications">2.3. Getting started with OTP applications</a></span></dt><dt><span class="section"><a href="getting_started.html#_getting_started_with_otp_libraries">2.4. Getting started with OTP libraries</a></span></dt><dt><span class="section"><a href="getting_started.html#_getting_started_with_otp_releases">2.5. Getting started with OTP releases</a></span></dt><dt><span class="section"><a href="getting_started.html#_getting_started_from_scratch">2.6. Getting started from scratch</a></span></dt><dt><span class="section"><a href="getting_started.html#_using_spaces_instead_of_tabs">2.7. Using spaces instead of tabs</a></span></dt><dt><span class="section"><a href="getting_started.html#_using_templates">2.8. Using templates</a></span></dt><dt><span class="section"><a href="getting_started.html#_hiding_erlang_mk_from_git">2.9. Hiding Erlang.mk from git</a></span></dt><dt><span class="section"><a href="getting_started.html#_getting_help">2.10. Getting help</a></span></dt></dl></dd><dt><span class="chapter"><a href="overview.html">3. Overview</a></span></dt><dd><dl><dt><span class="section"><a href="overview.html#_building_your_project">3.1. Building your project</a></span></dt><dt><span class="section"><a href="overview.html#_exploring_the_package_index">3.2. Exploring the package index</a></span></dt><dt><span class="section"><a href="overview.html#_generating_documentation">3.3. Generating documentation</a></span></dt><dt><span class="section"><a href="overview.html#_running_tests">3.4. Running tests</a></span></dt><dt><span class="section"><a href="overview.html#_need_more">3.5. Need more?</a></span></dt></dl></dd><dt><span class="chapter"><a href="updating.html">4. Updating Erlang.mk</a></span></dt><dd><dl><dt><span class="section"><a href="updating.html#_initial_bootstrap">4.1. Initial bootstrap</a></span></dt><dt><span class="section"><a href="updating.html#_updating">4.2. Updating</a></span></dt><dt><span class="section"><a href="updating.html#_customizing_the_build">4.3. Customizing the build</a></span></dt></dl></dd><dt><span class="chapter"><a href="limitations.html">5. Limitations</a></span></dt><dd><dl><dt><span class="section"><a href="limitations.html#_erlang_must_be_available">5.1. Erlang must be available</a></span></dt><dt><span class="section"><a href="limitations.html#_spaces_in_path">5.2. Spaces in path</a></span></dt><dt><span class="section"><a href="limitations.html#_dependency_tracking_and_modification_times">5.3. Dependency tracking and modification times</a></span></dt></dl></dd><dt><span class="part"><a href="code.html">I. Code</a></span></dt><dd><dl><dt><span class="chapter"><a href="building.html">6. Building</a></span></dt><dd><dl><dt><span class="section"><a href="building.html#_how_to_build">6.1. How to build</a></span></dt><dt><span class="section"><a href="building.html#_what_to_build">6.2. What to build</a></span></dt><dt><span class="section"><a href="building.html#_application_resource_file">6.3. Application resource file</a></span></dt><dt><span class="section"><a href="building.html#_automatic_application_resource_file_values">6.4. Automatic application resource file values</a></span></dt><dt><span class="section"><a href="building.html#_file_formats">6.5. File formats</a></span></dt><dt><span class="section"><a href="building.html#_compilation_options">6.6. Compilation options</a></span></dt><dt><span class="section"><a href="building.html#_cold_and_hot_builds">6.7. Cold and hot builds</a></span></dt><dt><span class="section"><a href="building.html#_dependency_tracking">6.8. Dependency tracking</a></span></dt><dt><span class="section"><a href="building.html#_generating_erlang_source">6.9. Generating Erlang source</a></span></dt><dt><span class="section"><a href="building.html#_cleaning">6.10. Cleaning</a></span></dt></dl></dd><dt><span class="chapter"><a href="deps.html">7. Packages and dependencies</a></span></dt><dd><dl><dt><span class="section"><a href="deps.html#_searching_packages">7.1. Searching packages</a></span></dt><dt><span class="section"><a href="deps.html#_adding_dependencies_to_your_project">7.2. Adding dependencies to your project</a></span></dt><dt><span class="section"><a href="deps.html#_how_deps_are_fetched_and_built">7.3. How deps are fetched and built</a></span></dt><dt><span class="section"><a href="deps.html#_fetching_and_listing_dependencies_only">7.4. Fetching and listing dependencies only</a></span></dt><dt><span class="section"><a href="deps.html#_querying_dependencies">7.5. Querying dependencies</a></span></dt><dt><span class="section"><a href="deps.html#_ignoring_unwanted_dependencies">7.6. Ignoring unwanted dependencies</a></span></dt><dt><span class="section"><a href="deps.html#_dependencies_directory">7.7. Dependencies directory</a></span></dt><dt><span class="section"><a href="deps.html#_many_applications_in_one_repository">7.8. Many applications in one repository</a></span></dt><dt><span class="section"><a href="deps.html#_repositories_with_no_application_at_the_root_level">7.9. Repositories with no application at the root level</a></span></dt><dt><span class="section"><a href="deps.html#_autopatch">7.10. Autopatch</a></span></dt><dt><span class="section"><a href="deps.html#_dealing_with_duplicate_modules">7.11. Dealing with duplicate modules</a></span></dt><dt><span class="section"><a href="deps.html#_skipping_deps">7.12. Skipping deps</a></span></dt></dl></dd><dt><span class="chapter"><a href="ports.html">8. NIFs and port drivers</a></span></dt><dd><dl><dt><span class="section"><a href="ports.html#_c_source_code_location_and_erlang_environment">8.1. C source code location and Erlang environment</a></span></dt><dt><span class="section"><a href="ports.html#_using_a_custom_makefile">8.2. Using a custom Makefile</a></span></dt><dt><span class="section"><a href="ports.html#_using_erlang_mk_directly">8.3. Using Erlang.mk directly</a></span></dt><dt><span class="section"><a href="ports.html#_propagating_compile_and_linker_flags_to_sub_makefiles">8.4. Propagating compile and linker flags to sub-Makefiles</a></span></dt></dl></dd><dt><span class="chapter"><a href="relx.html">9. Releases</a></span></dt><dd><dl><dt><span class="section"><a href="relx.html#_setup">9.1. Setup</a></span></dt><dt><span class="section"><a href="relx.html#_configuration">9.2. Configuration</a></span></dt><dt><span class="section"><a href="relx.html#_generating_the_release">9.3. Generating the release</a></span></dt><dt><span class="section"><a href="relx.html#_running_the_release">9.4. Running the release</a></span></dt><dt><span class="section"><a href="relx.html#_upgrading_a_release">9.5. Upgrading a release</a></span></dt><dt><span class="section"><a href="relx.html#_getting_relx_semver_value">9.6. Getting Relx semver value</a></span></dt></dl></dd><dt><span class="chapter"><a href="sfx.html">10. Self-extracting releases</a></span></dt><dd><dl><dt><span class="section"><a href="sfx.html#_generating_the_self_extracting_archive">10.1. Generating the self-extracting archive</a></span></dt><dt><span class="section"><a href="sfx.html#_running_the_release_2">10.2. Running the release</a></span></dt></dl></dd><dt><span class="chapter"><a href="escript.html">11. Escripts</a></span></dt><dd><dl><dt><span class="section"><a href="escript.html#_requirements">11.1. Requirements</a></span></dt><dt><span class="section"><a href="escript.html#_generating_an_escript">11.2. Generating an escript</a></span></dt><dt><span class="section"><a href="escript.html#_configuration_2">11.3. Configuration</a></span></dt><dt><span class="section"><a href="escript.html#_extra_files">11.4. Extra files</a></span></dt><dt><span class="section"><a href="escript.html#_optimizing_for_size">11.5. Optimizing for size</a></span></dt></dl></dd><dt><span class="chapter"><a href="kerl.html">12. OTP version management</a></span></dt><dd><dl><dt><span class="section"><a href="kerl.html#_erlang_versions">12.1. Erlang versions</a></span></dt><dt><span class="section"><a href="kerl.html#otp_version_pinning">12.2. OTP version pinning</a></span></dt><dt><span class="section"><a href="kerl.html#_continuous_integration">12.3. Continuous integration</a></span></dt><dt><span class="section"><a href="kerl.html#_configuring_kerl">12.4. Configuring Kerl</a></span></dt></dl></dd><dt><span class="chapter"><a href="cross_compiling.html">13. Cross compiling</a></span></dt><dd><dl><dt><span class="section"><a href="cross_compiling.html#_compiling">13.1. Compiling</a></span></dt><dt><span class="section"><a href="cross_compiling.html#_building_the_release">13.2. Building the release</a></span></dt></dl></dd><dt><span class="chapter"><a href="compat.html">14. Compatibility with other build tools</a></span></dt><dd><dl><dt><span class="section"><a href="compat.html#_rebar_projects_as_erlang_mk_dependencies">14.1. Rebar projects as Erlang.mk dependencies</a></span></dt><dt><span class="section"><a href="compat.html#_erlang_mk_projects_as_rebar_dependencies">14.2. Erlang.mk projects as Rebar dependencies</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="docs.html">II. Documentation</a></span></dt><dd><dl><dt><span class="chapter"><a href="asciidoc.html">15. AsciiDoc documentation</a></span></dt><dd><dl><dt><span class="section"><a href="asciidoc.html#_requirements_2">15.1. Requirements</a></span></dt><dt><span class="section"><a href="asciidoc.html#_writing_asciidoc_documentation">15.2. Writing AsciiDoc documentation</a></span></dt><dt><span class="section"><a href="asciidoc.html#_configuration_3">15.3. Configuration</a></span></dt><dt><span class="section"><a href="asciidoc.html#_usage">15.4. Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="edoc.html">16. EDoc comments</a></span></dt><dd><dl><dt><span class="section"><a href="edoc.html#_writing_edoc_comments">16.1. Writing EDoc comments</a></span></dt><dt><span class="section"><a href="edoc.html#_configuration_4">16.2. Configuration</a></span></dt><dt><span class="section"><a href="edoc.html#_usage_2">16.3. Usage</a></span></dt><dt><span class="section"><a href="edoc.html#_running_edoc_on_all_applications">16.4. Running EDoc on all applications</a></span></dt></dl></dd><dt><span class="chapter"><a href="sphinx.html">17. Sphinx documentation</a></span></dt><dd><dl><dt><span class="section"><a href="sphinx.html#_writing_sphinx_documentation">17.1. Writing Sphinx documentation</a></span></dt><dt><span class="section"><a href="sphinx.html#_basic_setup">17.2. Basic setup</a></span></dt><dt><span class="section"><a href="sphinx.html#_erlang_mk_configuration">17.3. Erlang.mk configuration</a></span></dt><dt><span class="section"><a href="sphinx.html#_generating_man_pages">17.4. Generating man pages</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="tests.html">III. Tests</a></span></dt><dd><dl><dt><span class="chapter"><a href="shell.html">18. Erlang shell</a></span></dt><dd><dl><dt><span class="section"><a href="shell.html#_configuration_5">18.1. Configuration</a></span></dt><dt><span class="section"><a href="shell.html#_usage_3">18.2. Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="eunit.html">19. EUnit</a></span></dt><dd><dl><dt><span class="section"><a href="eunit.html#_writing_tests">19.1. Writing tests</a></span></dt><dt><span class="section"><a href="eunit.html#_configuration_6">19.2. Configuration</a></span></dt><dt><span class="section"><a href="eunit.html#_usage_4">19.3. Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="ct.html">20. Common Test</a></span></dt><dd><dl><dt><span class="section"><a href="ct.html#_writing_tests_2">20.1. Writing tests</a></span></dt><dt><span class="section"><a href="ct.html#_configuration_7">20.2. Configuration</a></span></dt><dt><span class="section"><a href="ct.html#_usage_5">20.3. Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="proper.html">21. PropEr</a></span></dt><dt><span class="chapter"><a href="triq.html">22. Triq</a></span></dt><dt><span class="chapter"><a href="coverage.html">23. Code coverage</a></span></dt><dd><dl><dt><span class="section"><a href="coverage.html#_enabling_cover_when_running_tests">23.1. Enabling cover when running tests</a></span></dt><dt><span class="section"><a href="coverage.html#_adding_applications_to_the_cover_report">23.2. Adding applications to the cover report</a></span></dt><dt><span class="section"><a href="coverage.html#_configuring_paths">23.3. Configuring paths</a></span></dt><dt><span class="section"><a href="coverage.html#_merging_coverdata_files">23.4. Merging coverdata files</a></span></dt></dl></dd><dt><span class="chapter"><a href="ci.html">24. Continuous integration</a></span></dt><dd><dl><dt><span class="section"><a href="ci.html#_configuring_erlang_otp_versions_to_test">24.1. Configuring Erlang/OTP versions to test</a></span></dt><dt><span class="section"><a href="ci.html#_running_tests_across_all_configured_versions">24.2. Running tests across all configured versions</a></span></dt><dt><span class="section"><a href="ci.html#_extending_the_ci_targets">24.3. Extending the CI targets</a></span></dt></dl></dd><dt><span class="chapter"><a href="dialyzer.html">25. Dialyzer</a></span></dt><dd><dl><dt><span class="section"><a href="dialyzer.html#_how_it_works">25.1. How it works</a></span></dt><dt><span class="section"><a href="dialyzer.html#_configuration_8">25.2. Configuration</a></span></dt><dt><span class="section"><a href="dialyzer.html#_usage_6">25.3. Usage</a></span></dt><dt><span class="section"><a href="dialyzer.html#_dialyzing_beam_files">25.4. Dialyzing beam files</a></span></dt></dl></dd><dt><span class="chapter"><a href="concuerror.html">26. Concuerror</a></span></dt><dd><dl><dt><span class="section"><a href="concuerror.html#_configuration_9">26.1. Configuration</a></span></dt><dt><span class="section"><a href="concuerror.html#_writing_tests_3">26.2. Writing tests</a></span></dt><dt><span class="section"><a href="concuerror.html#_usage_7">26.3. Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="xref.html">27. Xref</a></span></dt></dl></dd><dt><span class="part"><a href="plugins.html">IV. Third-party plugins</a></span></dt><dd><dl><dt><span class="chapter"><a href="plugins_usage.html">28. External plugins</a></span></dt><dd><dl><dt><span class="section"><a href="plugins_usage.html#_loading_all_plugins_from_a_dependency">28.1. Loading all plugins from a dependency</a></span></dt><dt><span class="section"><a href="plugins_usage.html#_loading_one_plugin_from_a_dependency">28.2. Loading one plugin from a dependency</a></span></dt><dt><span class="section"><a href="plugins_usage.html#_writing_external_plugins">28.3. Writing external plugins</a></span></dt><dt><span class="section"><a href="plugins_usage.html#_early_stage_plugins">28.4. Early-stage plugins</a></span></dt><dt><span class="section"><a href="plugins_usage.html#_loading_plugins_local_to_the_application">28.5. Loading  plugins local to the application</a></span></dt></dl></dd><dt><span class="chapter"><a href="plugins_list.html">29. List of plugins</a></span></dt><dd><dl><dt><span class="section"><a href="plugins_list.html#_ci_erlang_mk">29.1. ci.erlang.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_efene_mk">29.2. efene.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_elixir_mk">29.3. elixir.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_elvis_mk">29.4. elvis.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_esh_mk">29.5. esh.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_geas">29.6. geas</a></span></dt><dt><span class="section"><a href="plugins_list.html#_hexer_mk">29.7. hexer.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_hexpm_mk">29.8. hexpm.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_jorel">29.9. jorel</a></span></dt><dt><span class="section"><a href="plugins_list.html#_lfe_mk">29.10. lfe.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_mix_mk">29.11. mix.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_reload_mk">29.12. reload.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_rust_mk">29.13. rust.mk</a></span></dt><dt><span class="section"><a href="plugins_list.html#_version_mk">29.14. version.mk</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="about.html">V. About Erlang.mk</a></span></dt><dd><dl><dt><span class="chapter"><a href="why.html">30. Why Erlang.mk</a></span></dt><dd><dl><dt><span class="section"><a href="why.html#_erlang_mk_is_fast">30.1. Erlang.mk is fast</a></span></dt><dt><span class="section"><a href="why.html#_erlang_mk_gives_you_the_full_power_of_unix">30.2. Erlang.mk gives you the full power of Unix</a></span></dt><dt><span class="section"><a href="why.html#_erlang_mk_is_a_text_file">30.3. Erlang.mk is a text file</a></span></dt><dt><span class="section"><a href="why.html#_erlang_mk_can_manage_erlang_itself">30.4. Erlang.mk can manage Erlang itself</a></span></dt><dt><span class="section"><a href="why.html#_erlang_mk_can_do_more_than_erlang">30.5. Erlang.mk can do more than Erlang</a></span></dt><dt><span class="section"><a href="why.html#_erlang_mk_integrates_nicely_in_make_and_automake_projects">30.6. Erlang.mk integrates nicely in Make and Automake projects</a></span></dt></dl></dd><dt><span class="chapter"><a href="history.html">31. Short history</a></span></dt><dd><dl><dt><span class="section"><a href="history.html#_before_erlang_mk">31.1. Before Erlang.mk</a></span></dt><dt><span class="section"><a href="history.html#_lifetime_of_the_project">31.2. Lifetime of the project</a></span></dt></dl></dd><dt><span class="chapter"><a href="contributing.html">32. Contributing</a></span></dt><dd><dl><dt><span class="section"><a href="contributing.html#_priorities">32.1. Priorities</a></span></dt><dt><span class="section"><a href="contributing.html#_bugs">32.2. Bugs</a></span></dt><dt><span class="section"><a href="contributing.html#_code">32.3. Code</a></span></dt><dt><span class="section"><a href="contributing.html#_packages">32.4. Packages</a></span></dt><dt><span class="section"><a href="contributing.html#_documentation">32.5. Documentation</a></span></dt><dt><span class="section"><a href="contributing.html#_feature_requests">32.6. Feature requests</a></span></dt></dl></dd></dl></dd></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="installation.html">Next</a></td></tr></table></div>
 </main>
 </body>
 </html>
diff --git a/guide/overview.html b/guide/overview.html
index 7f98ef3..9aa2b59 100644
--- a/guide/overview.html
+++ b/guide/overview.html
@@ -61,10 +61,10 @@ your entire system with <a class="link" href="ct.html" title="Chapter 20. Comm
 <a class="link" href="coverage.html" title="Chapter 23. Code coverage">Code coverage</a> can of course
 be enabled during tests.</p><p>Erlang.mk comes with features to make your life easier when
 setting up and using <a class="link" href="ci.html" title="Chapter 24. Continuous integration">Continuous integration</a>.</p><p>On the static analysis side of things, Erlang.mk comes with
-support for <a class="link" href="dialyzer.html" title="Chapter 25. Dialyzer">Dialyzer</a> and <a class="link" href="xref.html" title="Chapter 26. Xref">Xref</a>,
+support for <a class="link" href="dialyzer.html" title="Chapter 25. Dialyzer">Dialyzer</a> and <a class="link" href="xref.html" title="Chapter 27. Xref">Xref</a>,
 to perform success typing analysis and cross referencing
-of the code.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_need_more"></a>3.5. Need more?</h2></div></div></div><p>Not convinced yet? You can read about <a class="link" href="why.html" title="Chapter 29. Why Erlang.mk">why you should use Erlang.mk</a>
-and its <a class="link" href="history.html" title="Chapter 30. Short history">history</a>. And if you’re still not
+of the code.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_need_more"></a>3.5. Need more?</h2></div></div></div><p>Not convinced yet? You can read about <a class="link" href="why.html" title="Chapter 30. Why Erlang.mk">why you should use Erlang.mk</a>
+and its <a class="link" href="history.html" title="Chapter 31. Short history">history</a>. And if you’re still not
 convinced after that, it’s OK! The world would be boring if
 everyone agreed on everything all the time.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="getting_started.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="updating.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
 </main>
diff --git a/guide/plugins_list.html b/guide/plugins_list.html
index ff66fc5..eb6b338 100644
--- a/guide/plugins_list.html
+++ b/guide/plugins_list.html
@@ -33,24 +33,24 @@ div.navfooter{margin-bottom:1em}
 </header>
 <main>
 
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="plugins_usage.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="about.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="plugins_list"></a>Chapter 28. List of plugins</h2></div></div></div><p>This is a non-exhaustive list of Erlang.mk plugins, sorted
-alphabetically.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_ci_erlang_mk"></a>28.1. ci.erlang.mk</h2></div></div></div><p>A <a class="ulink" href="https://github.com/ninenines/ci.erlang.mk" target="_top">plugin</a> that keeps
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="plugins_usage.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="about.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="plugins_list"></a>Chapter 29. List of plugins</h2></div></div></div><p>This is a non-exhaustive list of Erlang.mk plugins, sorted
+alphabetically.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_ci_erlang_mk"></a>29.1. ci.erlang.mk</h2></div></div></div><p>A <a class="ulink" href="https://github.com/ninenines/ci.erlang.mk" target="_top">plugin</a> that keeps
 track of released OTP versions to always run CI builds on the
-most recent patch(es).</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_efene_mk"></a>28.2. efene.mk</h2></div></div></div><p>An <a class="ulink" href="https://github.com/ninenines/efene.mk" target="_top">Efene plugin</a> for Erlang.mk.
-<a class="ulink" href="http://efene.org/" target="_top">Efene</a> is an alternative language for the BEAM.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_elixir_mk"></a>28.3. elixir.mk</h2></div></div></div><p>An <a class="ulink" href="https://github.com/botsunit/elixir.mk" target="_top">Elixir plugin</a> for
+most recent patch(es).</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_efene_mk"></a>29.2. efene.mk</h2></div></div></div><p>An <a class="ulink" href="https://github.com/ninenines/efene.mk" target="_top">Efene plugin</a> for Erlang.mk.
+<a class="ulink" href="http://efene.org/" target="_top">Efene</a> is an alternative language for the BEAM.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_elixir_mk"></a>29.3. elixir.mk</h2></div></div></div><p>An <a class="ulink" href="https://github.com/botsunit/elixir.mk" target="_top">Elixir plugin</a> for
 Erlang.mk. <a class="ulink" href="http://elixir-lang.org/" target="_top">Elixir</a> is an alternative
-language for the BEAM.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_elvis_mk"></a>28.4. elvis.mk</h2></div></div></div><p>An <a class="ulink" href="https://github.com/inaka/elvis.mk" target="_top">Elvis plugin</a> for Erlang.mk.
-Elvis is an <a class="ulink" href="https://github.com/inaka/elvis" target="_top">Erlang style reviewer</a>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_esh_mk"></a>28.5. esh.mk</h2></div></div></div><p>An <a class="ulink" href="https://github.com/crownedgrouse/esh.mk" target="_top">Esh template plugin</a> for Erlang.mk.
-<a class="ulink" href="https://github.com/jirutka/esh" target="_top">Esh</a> is a simple template engine using shell.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_geas"></a>28.6. geas</h2></div></div></div><p><a class="ulink" href="https://github.com/crownedgrouse/geas" target="_top">Geas</a> gives aggregated
+language for the BEAM.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_elvis_mk"></a>29.4. elvis.mk</h2></div></div></div><p>An <a class="ulink" href="https://github.com/inaka/elvis.mk" target="_top">Elvis plugin</a> for Erlang.mk.
+Elvis is an <a class="ulink" href="https://github.com/inaka/elvis" target="_top">Erlang style reviewer</a>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_esh_mk"></a>29.5. esh.mk</h2></div></div></div><p>An <a class="ulink" href="https://github.com/crownedgrouse/esh.mk" target="_top">Esh template plugin</a> for Erlang.mk.
+<a class="ulink" href="https://github.com/jirutka/esh" target="_top">Esh</a> is a simple template engine using shell.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_geas"></a>29.6. geas</h2></div></div></div><p><a class="ulink" href="https://github.com/crownedgrouse/geas" target="_top">Geas</a> gives aggregated
 information on a project and its dependencies, and is available
-as an Erlang.mk plugin.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_hexer_mk"></a>28.7. hexer.mk</h2></div></div></div><p>An <a class="ulink" href="https://github.com/inaka/hexer.mk" target="_top">Hex plugin</a> for Erlang.mk
-using the <code class="literal">hexer</code> tool.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_hexpm_mk"></a>28.8. hexpm.mk</h2></div></div></div><p>Another <a class="ulink" href="https://github.com/botsunit/hexpm.mk" target="_top">Hex plugin</a> for
-Erlang.mk, with support for Hex dependency operators.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_jorel"></a>28.9. jorel</h2></div></div></div><p><a class="ulink" href="https://github.com/emedia-project/jorel" target="_top">Jorel</a> is Just anOther RELease
-assembler for Erlang/OTP, and is available as an Erlang.mk plugin.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_lfe_mk"></a>28.10. lfe.mk</h2></div></div></div><p>An <a class="ulink" href="https://github.com/ninenines/lfe.mk" target="_top">LFE plugin</a> for Erlang.mk.
+as an Erlang.mk plugin.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_hexer_mk"></a>29.7. hexer.mk</h2></div></div></div><p>An <a class="ulink" href="https://github.com/inaka/hexer.mk" target="_top">Hex plugin</a> for Erlang.mk
+using the <code class="literal">hexer</code> tool.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_hexpm_mk"></a>29.8. hexpm.mk</h2></div></div></div><p>Another <a class="ulink" href="https://github.com/botsunit/hexpm.mk" target="_top">Hex plugin</a> for
+Erlang.mk, with support for Hex dependency operators.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_jorel"></a>29.9. jorel</h2></div></div></div><p><a class="ulink" href="https://github.com/emedia-project/jorel" target="_top">Jorel</a> is Just anOther RELease
+assembler for Erlang/OTP, and is available as an Erlang.mk plugin.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_lfe_mk"></a>29.10. lfe.mk</h2></div></div></div><p>An <a class="ulink" href="https://github.com/ninenines/lfe.mk" target="_top">LFE plugin</a> for Erlang.mk.
 LFE, or <a class="ulink" href="http://lfe.io/" target="_top">Lisp Flavoured Erlang</a>, is an alternative
-language for the BEAM.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_mix_mk"></a>28.11. mix.mk</h2></div></div></div><p>A <a class="ulink" href="https://github.com/botsunit/mix.mk" target="_top">Mix plugin</a> for Erlang.mk,
+language for the BEAM.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_mix_mk"></a>29.11. mix.mk</h2></div></div></div><p>A <a class="ulink" href="https://github.com/botsunit/mix.mk" target="_top">Mix plugin</a> for Erlang.mk,
 to generate a compatible configuration file for
-<a class="ulink" href="http://elixir-lang.org/getting-started/mix-otp/introduction-to-mix.html" target="_top">Mix</a>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_reload_mk"></a>28.12. reload.mk</h2></div></div></div><p>A <a class="ulink" href="https://github.com/bullno1/reload.mk" target="_top">live reload plugin</a> for Erlang.mk.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_rust_mk"></a>28.13. rust.mk</h2></div></div></div><p>A <a class="ulink" href="https://github.com/goertzenator/rust.mk" target="_top">plugin</a> to build <a class="ulink" href="https://www.rust-lang.org/" target="_top">Rust</a> crates and install binaries into <code class="literal">priv/</code>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_version_mk"></a>28.14. version.mk</h2></div></div></div><p>A <a class="ulink" href="https://github.com/manifest/version.mk" target="_top">plugin</a> to apply a semantic version automatically to Erlang.mk projects.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="plugins_usage.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="plugins.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="about.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
+<a class="ulink" href="http://elixir-lang.org/getting-started/mix-otp/introduction-to-mix.html" target="_top">Mix</a>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_reload_mk"></a>29.12. reload.mk</h2></div></div></div><p>A <a class="ulink" href="https://github.com/bullno1/reload.mk" target="_top">live reload plugin</a> for Erlang.mk.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_rust_mk"></a>29.13. rust.mk</h2></div></div></div><p>A <a class="ulink" href="https://github.com/goertzenator/rust.mk" target="_top">plugin</a> to build <a class="ulink" href="https://www.rust-lang.org/" target="_top">Rust</a> crates and install binaries into <code class="literal">priv/</code>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_version_mk"></a>29.14. version.mk</h2></div></div></div><p>A <a class="ulink" href="https://github.com/manifest/version.mk" target="_top">plugin</a> to apply a semantic version automatically to Erlang.mk projects.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="plugins_usage.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="plugins.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="about.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
 </main>
 </body>
 </html>
diff --git a/guide/plugins_usage.html b/guide/plugins_usage.html
index 93a7d48..1d7159f 100644
--- a/guide/plugins_usage.html
+++ b/guide/plugins_usage.html
@@ -33,7 +33,7 @@ div.navfooter{margin-bottom:1em}
 </header>
 <main>
 
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="plugins.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="plugins_list.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="plugins_usage"></a>Chapter 27. External plugins</h2></div></div></div><p>It is often convenient to be able to keep the build files
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="plugins.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="plugins_list.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="plugins_usage"></a>Chapter 28. External plugins</h2></div></div></div><p>It is often convenient to be able to keep the build files
 used by all your projects in one place. Those files could
 be Makefiles, configuration files, templates and more.</p><p>Erlang.mk allows you to automatically load plugins from
 dependencies. Plugins can do anything, including defining
@@ -42,19 +42,19 @@ inside the normal Erlang.mk processing or even adding new
 rules.</p><p>You can load plugins using one of two methods. You can
 either load all plugins from a dependency, or just one.
 We will also cover conventions about writing external
-plugins.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_loading_all_plugins_from_a_dependency"></a>27.1. Loading all plugins from a dependency</h2></div></div></div><p>To load plugins from a dependency, all you need to do is add
+plugins.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_loading_all_plugins_from_a_dependency"></a>28.1. Loading all plugins from a dependency</h2></div></div></div><p>To load plugins from a dependency, all you need to do is add
 the dependency name to <code class="literal">DEP_PLUGINS</code> in addition to the list
 of dependencies.</p><p>For example, if you have <code class="literal">cowboy</code> in <code class="literal">DEPS</code>, add <code class="literal">cowboy</code> in
 <code class="literal">DEP_PLUGINS</code> also:</p><pre class="programlisting">DEPS = cowboy
 DEP_PLUGINS = cowboy</pre><p>This will load the file <span class="emphasis"><em>plugins.mk</em></span> in the root folder of
-the Cowboy repository.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_loading_one_plugin_from_a_dependency"></a>27.2. Loading one plugin from a dependency</h2></div></div></div><p>Now that we know how to load all plugins, let’s take a look
+the Cowboy repository.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_loading_one_plugin_from_a_dependency"></a>28.2. Loading one plugin from a dependency</h2></div></div></div><p>Now that we know how to load all plugins, let’s take a look
 at how to load one specific plugin from a dependency.</p><p>To do this, instead of writing only the name of the dependency,
 we will write its name and the path to the plugin file. This
 means that writing <code class="literal">DEP_PLUGINS = cowboy</code> is equivalent to
 writing <code class="literal">DEP_PLUGINS = cowboy/plugins.mk</code>.</p><p>Knowing this, if we were to load the plugin <span class="emphasis"><em>mk/dist.mk</em></span>
 from Cowboy and no other, we would write the following in
 our Makefile:</p><pre class="programlisting">DEPS = cowboy
-DEP_PLUGINS = cowboy/mk/dist.mk</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_writing_external_plugins"></a>27.3. Writing external plugins</h2></div></div></div><p>The <span class="emphasis"><em>plugins.mk</em></span> file is a convention. It is meant to load
+DEP_PLUGINS = cowboy/mk/dist.mk</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_writing_external_plugins"></a>28.3. Writing external plugins</h2></div></div></div><p>The <span class="emphasis"><em>plugins.mk</em></span> file is a convention. It is meant to load
 all the plugins from the dependency. The code for the plugin
 can be written directly in <span class="emphasis"><em>plugins.mk</em></span> or be separate.</p><p>If you are providing more than one plugin with your repository,
 the recommended way is to create one file per plugin in the
@@ -67,7 +67,7 @@ include $(THIS)/mk/templates.mk</pre><p>The <code class="literal">THIS</code> va
 plugins, but also select all plugins from the dependency
 in one go if they wish to do so.</p><p>Plugins can include some help text by extending the target
 <code class="literal">help-plugins</code>:</p><pre class="programlisting">help-plugins::
-    $(verbose) printf "%s\n" "" "Run benchmark: $(MAKE) perfs"</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_early_stage_plugins"></a>27.4. Early-stage plugins</h2></div></div></div><p>Plugins declared in <code class="literal">DEP_PLUGINS</code> are loaded near the end of Erlang.mk.
+    $(verbose) printf "%s\n" "" "Run benchmark: $(MAKE) perfs"</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_early_stage_plugins"></a>28.4. Early-stage plugins</h2></div></div></div><p>Plugins declared in <code class="literal">DEP_PLUGINS</code> are loaded near the end of Erlang.mk.
 That’s why you have access to all previously initialized variables.
 However, if you want your plugin to add common dependencies to
 your applications, a regular is loaded too late in the process.
@@ -81,7 +81,7 @@ BUILD_DEPS = common_deps
 DEP_EARLY_PLUGINS = common_deps</pre><pre class="programlisting"># In the plugin's early-plugins.mk
 DEPS += cowboy
 TEST_DEPS = ct_helper
-dep_ct_helper = git https://github.com/ninenines/ct_helper master</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_loading_plugins_local_to_the_application"></a>27.5. Loading  plugins local to the application</h2></div></div></div><p>If the Erlang.mk plugin lives in the same directory or repository as your
+dep_ct_helper = git https://github.com/ninenines/ct_helper master</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_loading_plugins_local_to_the_application"></a>28.5. Loading  plugins local to the application</h2></div></div></div><p>If the Erlang.mk plugin lives in the same directory or repository as your
 application or library, then you can load it exactly like an external
 plugin: the dependency name is simply the name of your application or
 library.</p><p>For example, the following Makefile loads a plugin in the <span class="emphasis"><em>mk</em></span>
diff --git a/guide/why.html b/guide/why.html
index 26ffb78..12705e3 100644
--- a/guide/why.html
+++ b/guide/why.html
@@ -33,14 +33,14 @@ div.navfooter{margin-bottom:1em}
 </header>
 <main>
 
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="about.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="history.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="why"></a>Chapter 29. Why Erlang.mk</h2></div></div></div><p>Why would you choose Erlang.mk, if not for its
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="about.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="history.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="why"></a>Chapter 30. Why Erlang.mk</h2></div></div></div><p>Why would you choose Erlang.mk, if not for its
 <a class="link" href="overview.html" title="Chapter 3. Overview">many features</a>? This chapter will
-attempt to answer that.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_erlang_mk_is_fast"></a>29.1. Erlang.mk is fast</h2></div></div></div><p>Erlang.mk is as fast as it gets.</p><p>Erlang.mk will group the compilation of files so as to avoid
+attempt to answer that.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_erlang_mk_is_fast"></a>30.1. Erlang.mk is fast</h2></div></div></div><p>Erlang.mk is as fast as it gets.</p><p>Erlang.mk will group the compilation of files so as to avoid
 running the BEAM more than necessary. This saves many seconds
 compared to traditional Makefiles, even on small projects.</p><p>Erlang.mk will not try to be too smart. It provides a simple
 solution that works for most people, and gives additional
 options for projects that run into edge cases, often in the
-form of extra variables or rules to be defined.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_erlang_mk_gives_you_the_full_power_of_unix"></a>29.2. Erlang.mk gives you the full power of Unix</h2></div></div></div><p>Erlang.mk is a Makefile.</p><p>You could use Erlang.mk directly without configuring anything
+form of extra variables or rules to be defined.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_erlang_mk_gives_you_the_full_power_of_unix"></a>30.2. Erlang.mk gives you the full power of Unix</h2></div></div></div><p>Erlang.mk is a Makefile.</p><p>You could use Erlang.mk directly without configuring anything
 and it would just work. But you can also extend it greatly
 either through configuration or hooks, and you can of course
 add your own rules to the Makefile.</p><p>In all cases: for configuration, hooks or custom rules, you
@@ -48,22 +48,22 @@ have all the power of Unix at your disposal, and can call
 any utility <span class="emphasis"><em>or even any language interpreter</em></span> you want,
 every time you need to. Erlang.mk also allows you to write
 scripts in this small language called Erlang directly inside
-your Makefile if you ever need to…</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_erlang_mk_is_a_text_file"></a>29.3. Erlang.mk is a text file</h2></div></div></div><p>Erlang.mk is a Makefile.</p><p>Which means Erlang.mk is a simple text file. You can edit a
+your Makefile if you ever need to…</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_erlang_mk_is_a_text_file"></a>30.3. Erlang.mk is a text file</h2></div></div></div><p>Erlang.mk is a Makefile.</p><p>Which means Erlang.mk is a simple text file. You can edit a
 text file. Nothing stops you. If you run into any bug, or
 behavior that does not suit you, you can just open the
 <span class="emphasis"><em>erlang.mk</em></span> file in your favorite editor, fix and/or comment
-a few lines, save, and try again. It’s as simple as it gets.</p><p>Currently using a binary build tool? Good luck with that.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_erlang_mk_can_manage_erlang_itself"></a>29.4. Erlang.mk can manage Erlang itself</h2></div></div></div><p>Erlang.mk isn’t written in Erlang.</p><p>That’s not a good thing, you say? Well, here’s one thing
+a few lines, save, and try again. It’s as simple as it gets.</p><p>Currently using a binary build tool? Good luck with that.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_erlang_mk_can_manage_erlang_itself"></a>30.4. Erlang.mk can manage Erlang itself</h2></div></div></div><p>Erlang.mk isn’t written in Erlang.</p><p>That’s not a good thing, you say? Well, here’s one thing
 that Erlang.mk and Makefiles can do for you that Erlang
 build tool can’t easily: choose what version of Erlang is
 to be used for compiling the project.</p><p>This really is a one-liner in Erlang.mk (a few more lines
 if you also let it download and build Erlang directly)
 and allows for even greater things, like testing your
 project across all supported Erlang versions in one small
-command: <code class="literal">make -k ci</code>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_erlang_mk_can_do_more_than_erlang"></a>29.5. Erlang.mk can do more than Erlang</h2></div></div></div><p>Erlang.mk doesn’t care what your dependencies are written in.</p><p>Erlang.mk will happily compile any dependency, as long as
+command: <code class="literal">make -k ci</code>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_erlang_mk_can_do_more_than_erlang"></a>30.5. Erlang.mk can do more than Erlang</h2></div></div></div><p>Erlang.mk doesn’t care what your dependencies are written in.</p><p>Erlang.mk will happily compile any dependency, as long as
 they come with a Makefile. The dependency can be written
 in C, C++ or even Javascript… Who cares, really? If you
 need Erlang.mk to fetch it, then Erlang.mk will fetch it
-and compile it as needed.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_erlang_mk_integrates_nicely_in_make_and_automake_projects"></a>29.6. Erlang.mk integrates nicely in Make and Automake projects</h2></div></div></div><p>If you are planning to put your project in the middle of
+and compile it as needed.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_erlang_mk_integrates_nicely_in_make_and_automake_projects"></a>30.6. Erlang.mk integrates nicely in Make and Automake projects</h2></div></div></div><p>If you are planning to put your project in the middle of
 a Make or Automake-based build environment, then the most
 logical thing to do is to use a Makefile.</p><p>Erlang.mk will happily sit in such an environment and behave
 as you expect it to.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="about.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="about.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="history.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
diff --git a/guide/xref.html b/guide/xref.html
index 490b04b..8c930a2 100644
--- a/guide/xref.html
+++ b/guide/xref.html
@@ -33,7 +33,7 @@ div.navfooter{margin-bottom:1em}
 </header>
 <main>
 
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="dialyzer.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="plugins.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="xref"></a>Chapter 26. Xref</h2></div></div></div><p>Placeholder chapter.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="dialyzer.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="tests.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="plugins.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="concuerror.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="plugins.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="xref"></a>Chapter 27. Xref</h2></div></div></div><p>Placeholder chapter.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="concuerror.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="tests.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="plugins.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
 </main>
 </body>
 </html>
author	Loïc Hoguin <[email protected]>	2020-06-18 15:11:15 +0200
committer	Loïc Hoguin <[email protected]>	2020-06-18 15:11:15 +0200
commit	4f3353c7bc3e6da54b0613d1f0f89759f6dcbe98 (patch)
tree	a6c84711a1e6cdae6d64e870946699d7febdb435
parent	1e209c658e768911a27fbed8f996e99e8b68f320 (diff)
download	erlang.mk-4f3353c7bc3e6da54b0613d1f0f89759f6dcbe98.tar.gz erlang.mk-4f3353c7bc3e6da54b0613d1f0f89759f6dcbe98.tar.bz2 erlang.mk-4f3353c7bc3e6da54b0613d1f0f89759f6dcbe98.zip