aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2015-12-24 14:16:38 +0100
committerLoïc Hoguin <[email protected]>2015-12-24 14:16:38 +0100
commit0dc7f776c59f2a84acd752b590342757c0f6a39a (patch)
tree3ee200d9826c9c70cfce46e005e3618a59ca004c
parent33728ad57de0799c32cad1dc3ce642e6b2476d79 (diff)
downloaderlang.mk-0dc7f776c59f2a84acd752b590342757c0f6a39a.tar.gz
erlang.mk-0dc7f776c59f2a84acd752b590342757c0f6a39a.tar.bz2
erlang.mk-0dc7f776c59f2a84acd752b590342757c0f6a39a.zip
Update user guide
-rw-r--r--guide/ch15.html38
-rw-r--r--guide/ch20.html4
-rw-r--r--guide/index.html2
3 files changed, 40 insertions, 4 deletions
diff --git a/guide/ch15.html b/guide/ch15.html
index 3f23d71..bc86d71 100644
--- a/guide/ch15.html
+++ b/guide/ch15.html
@@ -31,7 +31,43 @@ 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="ch14.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch16.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="_eunit"></a>Chapter 15. EUnit</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="ch14.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="pt03.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch16.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="ch14.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch16.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="_eunit"></a>Chapter 15. EUnit</h2></div></div></div><p>EUnit is the tool of choice for unit testing. Erlang.mk
+automates a few things on top of EUnit, including the
+discovery and running of unit tests.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_writing_tests"></a>15.1. Writing tests</h2></div></div></div><p>The <a class="ulink" href="http://www.erlang.org/doc/apps/eunit/chapter.html" target="_top">EUnit user guide</a>
+is the best place to learn how to write tests. Of note is
+that all functions ending with <code class="literal">_test</code> or <code class="literal">_test_</code> will be
+picked up as EUnit test cases.</p><p>Erlang.mk will automatically pick up tests found in any of
+the Erlang modules of your application. It will also pick up
+tests located in the <span class="emphasis"><em>$(TEST_DIR)</em></span> directory, which defaults
+to <span class="emphasis"><em>test/</em></span>.</p><p>It is generally a good practice to hide test code from
+the code you ship to production. With Erlang.mk, you can
+do this thanks to the <code class="literal">TEST</code> macro. It is only defined
+when running tests:</p><pre class="programlisting">-ifdef(TEST).
+
+%% Insert tests here.
+
+-endif.</pre><p>Be careful, however, if you include the EUnit header file,
+as it also defines the <code class="literal">TEST</code> macro. Make sure to only include
+it inside an <code class="literal">ifdef</code> block, otherwise tests will always be
+compiled.</p><pre class="programlisting">-ifdef(TEST).
+
+-include_lib(\"eunit/include/eunit.hrl\").
+
+%% Insert tests here.
+
+-endif.</pre><p>Erlang.mk will automatically recompile your code when you
+perform a normal build after running tests, and vice versa.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_configuration_3"></a>15.2. Configuration</h2></div></div></div><p>The <code class="literal">EUNIT_OPTS</code> variable allows you to specify additional
+EUnit options. Options are documented in the
+<a class="ulink" href="http://www.erlang.org/doc/man/eunit.html#test-2" target="_top">EUnit manual</a>.
+At the time of writing, the only available option is <code class="literal">verbose</code>:</p><pre class="programlisting">EUNIT_OPTS = verbose</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_usage_2"></a>15.3. Usage</h2></div></div></div><p>To run all tests (including EUnit):</p><pre class="programlisting">$ make tests</pre><p>To run all tests and static checks (including EUnit):</p><pre class="programlisting">$ make check</pre><p>You can also run EUnit separately:</p><pre class="programlisting">$ make eunit</pre><p>EUnit will be quiet by default, only outputting errors.
+You can easily make it verbose for a single invocation:</p><pre class="programlisting">$ make eunit EUNIT_OPTS=verbose</pre><p>Erlang.mk allows you to run all tests from a specific
+module, or a specific test case from that module, using
+the variable <code class="literal">t</code>.</p><p>For example, to run all tests from the <code class="literal">cow_http_hd</code>
+module (instead of all tests from the entire project),
+one could write:</p><pre class="programlisting">$ make eunit t=cow_http_hd</pre><p>Similarly, to run a specific test case:</p><pre class="programlisting">$ make eunit t=cow_http_hd:parse_accept_test_</pre><p>To do the same against a multi-application repository,
+you can use the <code class="literal">-C</code> option:</p><pre class="programlisting">$ make -C apps/my_app eunit t=my_module:hello_test</pre><p>Note that this also applies to dependencies. From Cowboy,
+you can run the following directly:</p><pre class="programlisting">$ make -C deps/cowlib eunit t=cow_http_hd</pre><p>Finally, <a class="ulink" href="coverage.asciidoc" target="_top">code coverage</a> is available,
+but covered in its own chapter.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch14.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="pt03.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch16.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/ch20.html b/guide/ch20.html
index 5f0b788..8a59b86 100644
--- a/guide/ch20.html
+++ b/guide/ch20.html
@@ -42,7 +42,7 @@ dependencies of the application or applications you are
currently working on, including standard applications in
Erlang/OTP itself.</p><p>Dialyzer can generate this PLT file. Erlang.mk includes rules
to automatically generate the PLT file when it is missing.</p><p>Once the PLT file is generated, Dialyzer can perform the
-analysis in record time.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_configuration_3"></a>20.2. Configuration</h2></div></div></div><p>In a typical usage scenario, no variable needs to be set.
+analysis in record time.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_configuration_4"></a>20.2. Configuration</h2></div></div></div><p>In a typical usage scenario, no variable needs to be set.
The defaults should be enough. Do note however that the
dependencies need to be set properly using the <code class="literal">DEPS</code> and
<code class="literal">LOCAL_DEPS</code> variables.</p><p>The <code class="literal">DIALYZER_PLT</code> file indicates where the PLT file will
@@ -57,7 +57,7 @@ The former one defines which directories should be part
of the analysis. The latter defines what extra warnings
Dialyzer should report.</p><p>Note that Erlang.mk enables the race condition warnings
by default. As it can take considerably large resources
-to run, you may want to disable it on larger projects.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_usage_2"></a>20.3. Usage</h2></div></div></div><p>To perform an analysis, run the following command:</p><pre class="programlisting">$ make dialyze</pre><p>This will create the PLT file if it doesn’t exist.</p><p>The analysis will also be performed when you run the
+to run, you may want to disable it on larger projects.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_usage_3"></a>20.3. Usage</h2></div></div></div><p>To perform an analysis, run the following command:</p><pre class="programlisting">$ make dialyze</pre><p>This will create the PLT file if it doesn’t exist.</p><p>The analysis will also be performed when you run the
following command, alongside tests:</p><pre class="programlisting">$ make check</pre><p>You can use the <code class="literal">plt</code> target to create the PLT file if
it doesn’t exist. This is normally not necessary as
Dialyzer creates it automatically.</p><p>The PLT file will be removed when you run <code class="literal">make distclean</code>.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch19.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="pt03.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch21.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/index.html b/guide/index.html
index 72ec45c..d640329 100644
--- a/guide/index.html
+++ b/guide/index.html
@@ -31,7 +31,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="ch01.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="idm140195492271408"></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="ch01.html">1. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="ch01.html#_on_unix">1.1. On Unix</a></span></dt><dt><span class="section"><a href="ch01.html#_on_windows">1.2. On Windows</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch02.html">2. Getting started</a></span></dt><dd><dl><dt><span class="section"><a href="ch02.html#_creating_a_folder_for_your_project">2.1. Creating a folder for your project</a></span></dt><dt><span class="section"><a href="ch02.html#_downloading_erlang_mk">2.2. Downloading Erlang.mk</a></span></dt><dt><span class="section"><a href="ch02.html#_getting_started_with_otp_applications">2.3. Getting started with OTP applications</a></span></dt><dt><span class="section"><a href="ch02.html#_getting_started_with_otp_libraries">2.4. Getting started with OTP libraries</a></span></dt><dt><span class="section"><a href="ch02.html#_getting_started_with_otp_releases">2.5. Getting started with OTP releases</a></span></dt><dt><span class="section"><a href="ch02.html#_using_spaces_instead_of_tabs">2.6. Using spaces instead of tabs</a></span></dt><dt><span class="section"><a href="ch02.html#_using_templates">2.7. Using templates</a></span></dt><dt><span class="section"><a href="ch02.html#_getting_help">2.8. Getting help</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch03.html">3. Overview</a></span></dt><dd><dl><dt><span class="section"><a href="ch03.html#_building_your_project">3.1. Building your project</a></span></dt><dt><span class="section"><a href="ch03.html#_exploring_the_package_index">3.2. Exploring the package index</a></span></dt><dt><span class="section"><a href="ch03.html#_generating_documentation">3.3. Generating documentation</a></span></dt><dt><span class="section"><a href="ch03.html#_running_tests">3.4. Running tests</a></span></dt><dt><span class="section"><a href="ch03.html#_need_more">3.5. Need more?</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch04.html">4. Updating Erlang.mk</a></span></dt><dd><dl><dt><span class="section"><a href="ch04.html#_initial_bootstrap">4.1. Initial bootstrap</a></span></dt><dt><span class="section"><a href="ch04.html#_updating">4.2. Updating</a></span></dt><dt><span class="section"><a href="ch04.html#_customizing_the_build">4.3. Customizing the build</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch05.html">5. Limitations</a></span></dt><dd><dl><dt><span class="section"><a href="ch05.html#_erlang_must_be_available">5.1. Erlang must be available</a></span></dt><dt><span class="section"><a href="ch05.html#_spaces_in_path">5.2. Spaces in path</a></span></dt><dt><span class="section"><a href="ch05.html#_dependency_tracking_and_modification_times">5.3. Dependency tracking and modification times</a></span></dt></dl></dd><dt><span class="part"><a href="pt01.html">I. Code</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch06.html">6. Building</a></span></dt><dd><dl><dt><span class="section"><a href="ch06.html#_how_to_build">6.1. How to build</a></span></dt><dt><span class="section"><a href="ch06.html#_what_to_build">6.2. What to build</a></span></dt><dt><span class="section"><a href="ch06.html#_application_resource_file">6.3. Application resource file</a></span></dt><dt><span class="section"><a href="ch06.html#_automatic_application_resource_file_values">6.4. Automatic application resource file values</a></span></dt><dt><span class="section"><a href="ch06.html#_file_formats">6.5. File formats</a></span></dt><dt><span class="section"><a href="ch06.html#_compilation_options">6.6. Compilation options</a></span></dt><dt><span class="section"><a href="ch06.html#_cold_and_hot_builds">6.7. Cold and hot builds</a></span></dt><dt><span class="section"><a href="ch06.html#_dependency_tracking">6.8. Dependency tracking</a></span></dt><dt><span class="section"><a href="ch06.html#_generating_erlang_source">6.9. Generating Erlang source</a></span></dt><dt><span class="section"><a href="ch06.html#_cleaning">6.10. Cleaning</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch07.html">7. Packages and dependencies</a></span></dt><dd><dl><dt><span class="section"><a href="ch07.html#_searching_packages">7.1. Searching packages</a></span></dt><dt><span class="section"><a href="ch07.html#_adding_dependencies_to_your_project">7.2. Adding dependencies to your project</a></span></dt><dt><span class="section"><a href="ch07.html#_how_deps_are_fetched_and_built">7.3. How deps are fetched and built</a></span></dt><dt><span class="section"><a href="ch07.html#_ignoring_unwanted_dependencies">7.4. Ignoring unwanted dependencies</a></span></dt><dt><span class="section"><a href="ch07.html#_dependencies_directory">7.5. Dependencies directory</a></span></dt><dt><span class="section"><a href="ch07.html#_dependencies_local_to_the_repository">7.6. Dependencies local to the repository</a></span></dt><dt><span class="section"><a href="ch07.html#_repositories_with_no_application_at_the_root_level">7.7. Repositories with no application at the root level</a></span></dt><dt><span class="section"><a href="ch07.html#_autopatch">7.8. Autopatch</a></span></dt><dt><span class="section"><a href="ch07.html#_skipping_deps">7.9. Skipping deps</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch08.html">8. NIFs and port drivers</a></span></dt><dd><dl><dt><span class="section"><a href="ch08.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="ch08.html#_using_a_custom_makefile">8.2. Using a custom Makefile</a></span></dt><dt><span class="section"><a href="ch08.html#_using_erlang_mk_directly">8.3. Using Erlang.mk directly</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch09.html">9. Releases</a></span></dt><dd><dl><dt><span class="section"><a href="ch09.html#_setup">9.1. Setup</a></span></dt><dt><span class="section"><a href="ch09.html#_configuration">9.2. Configuration</a></span></dt><dt><span class="section"><a href="ch09.html#_generating_the_release">9.3. Generating the release</a></span></dt><dt><span class="section"><a href="ch09.html#_running_the_release">9.4. Running the release</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch10.html">10. Escripts</a></span></dt><dt><span class="chapter"><a href="ch11.html">11. Compatibility with other build tools</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#_rebar_projects_as_erlang_mk_dependencies">11.1. Rebar projects as Erlang.mk dependencies</a></span></dt><dt><span class="section"><a href="ch11.html#_erlang_mk_projects_as_rebar_dependencies">11.2. Erlang.mk projects as Rebar dependencies</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="pt02.html">II. Documentation</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch12.html">12. Asciidoc documentation</a></span></dt><dt><span class="chapter"><a href="ch13.html">13. EDoc comments</a></span></dt></dl></dd><dt><span class="part"><a href="pt03.html">III. Tests</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch14.html">14. Erlang shell</a></span></dt><dd><dl><dt><span class="section"><a href="ch14.html#_configuration_2">14.1. Configuration</a></span></dt><dt><span class="section"><a href="ch14.html#_usage">14.2. Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch15.html">15. EUnit</a></span></dt><dt><span class="chapter"><a href="ch16.html">16. Common Test</a></span></dt><dt><span class="chapter"><a href="ch17.html">17. Property based testing</a></span></dt><dt><span class="chapter"><a href="ch18.html">18. Code coverage</a></span></dt><dt><span class="chapter"><a href="ch19.html">19. Continuous integration</a></span></dt><dt><span class="chapter"><a href="ch20.html">20. Dialyzer</a></span></dt><dd><dl><dt><span class="section"><a href="ch20.html#_how_it_works">20.1. How it works</a></span></dt><dt><span class="section"><a href="ch20.html#_configuration_3">20.2. Configuration</a></span></dt><dt><span class="section"><a href="ch20.html#_usage_2">20.3. Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch21.html">21. Xref</a></span></dt></dl></dd><dt><span class="part"><a href="pt04.html">IV. Third-party plugins</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch22.html">22. External plugins</a></span></dt><dd><dl><dt><span class="section"><a href="ch22.html#_loading_all_plugins_from_a_dependency">22.1. Loading all plugins from a dependency</a></span></dt><dt><span class="section"><a href="ch22.html#_loading_one_plugin_from_a_dependency">22.2. Loading one plugin from a dependency</a></span></dt><dt><span class="section"><a href="ch22.html#_writing_external_plugins">22.3. Writing external plugins</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="pt05.html">V. About Erlang.mk</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch23.html">23. Why Erlang.mk</a></span></dt><dd><dl><dt><span class="section"><a href="ch23.html#_erlang_mk_is_fast">23.1. Erlang.mk is fast</a></span></dt><dt><span class="section"><a href="ch23.html#_erlang_mk_gives_you_the_full_power_of_unix">23.2. Erlang.mk gives you the full power of Unix</a></span></dt><dt><span class="section"><a href="ch23.html#_erlang_mk_is_a_text_file">23.3. Erlang.mk is a text file</a></span></dt><dt><span class="section"><a href="ch23.html#_erlang_mk_can_manage_erlang_itself">23.4. Erlang.mk can manage Erlang itself</a></span></dt><dt><span class="section"><a href="ch23.html#_erlang_mk_can_do_more_than_erlang">23.5. Erlang.mk can do more than Erlang</a></span></dt><dt><span class="section"><a href="ch23.html#_erlang_mk_integrates_nicely_in_make_and_automake_projects">23.6. Erlang.mk integrates nicely in Make and Automake projects</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch24.html">24. Short history</a></span></dt><dd><dl><dt><span class="section"><a href="ch24.html#_before_erlang_mk">24.1. Before Erlang.mk</a></span></dt><dt><span class="section"><a href="ch24.html#_lifetime_of_the_project">24.2. Lifetime of the project</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch25.html">25. Contributing</a></span></dt><dd><dl><dt><span class="section"><a href="ch25.html#_priorities">25.1. Priorities</a></span></dt><dt><span class="section"><a href="ch25.html#_bugs">25.2. Bugs</a></span></dt><dt><span class="section"><a href="ch25.html#_code_2">25.3. Code</a></span></dt><dt><span class="section"><a href="ch25.html#_packages">25.4. Packages</a></span></dt><dt><span class="section"><a href="ch25.html#_documentation_2">25.5. Documentation</a></span></dt><dt><span class="section"><a href="ch25.html#_feature_requests">25.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="ch01.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="ch01.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="idm139926649610928"></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="ch01.html">1. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="ch01.html#_on_unix">1.1. On Unix</a></span></dt><dt><span class="section"><a href="ch01.html#_on_windows">1.2. On Windows</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch02.html">2. Getting started</a></span></dt><dd><dl><dt><span class="section"><a href="ch02.html#_creating_a_folder_for_your_project">2.1. Creating a folder for your project</a></span></dt><dt><span class="section"><a href="ch02.html#_downloading_erlang_mk">2.2. Downloading Erlang.mk</a></span></dt><dt><span class="section"><a href="ch02.html#_getting_started_with_otp_applications">2.3. Getting started with OTP applications</a></span></dt><dt><span class="section"><a href="ch02.html#_getting_started_with_otp_libraries">2.4. Getting started with OTP libraries</a></span></dt><dt><span class="section"><a href="ch02.html#_getting_started_with_otp_releases">2.5. Getting started with OTP releases</a></span></dt><dt><span class="section"><a href="ch02.html#_using_spaces_instead_of_tabs">2.6. Using spaces instead of tabs</a></span></dt><dt><span class="section"><a href="ch02.html#_using_templates">2.7. Using templates</a></span></dt><dt><span class="section"><a href="ch02.html#_getting_help">2.8. Getting help</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch03.html">3. Overview</a></span></dt><dd><dl><dt><span class="section"><a href="ch03.html#_building_your_project">3.1. Building your project</a></span></dt><dt><span class="section"><a href="ch03.html#_exploring_the_package_index">3.2. Exploring the package index</a></span></dt><dt><span class="section"><a href="ch03.html#_generating_documentation">3.3. Generating documentation</a></span></dt><dt><span class="section"><a href="ch03.html#_running_tests">3.4. Running tests</a></span></dt><dt><span class="section"><a href="ch03.html#_need_more">3.5. Need more?</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch04.html">4. Updating Erlang.mk</a></span></dt><dd><dl><dt><span class="section"><a href="ch04.html#_initial_bootstrap">4.1. Initial bootstrap</a></span></dt><dt><span class="section"><a href="ch04.html#_updating">4.2. Updating</a></span></dt><dt><span class="section"><a href="ch04.html#_customizing_the_build">4.3. Customizing the build</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch05.html">5. Limitations</a></span></dt><dd><dl><dt><span class="section"><a href="ch05.html#_erlang_must_be_available">5.1. Erlang must be available</a></span></dt><dt><span class="section"><a href="ch05.html#_spaces_in_path">5.2. Spaces in path</a></span></dt><dt><span class="section"><a href="ch05.html#_dependency_tracking_and_modification_times">5.3. Dependency tracking and modification times</a></span></dt></dl></dd><dt><span class="part"><a href="pt01.html">I. Code</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch06.html">6. Building</a></span></dt><dd><dl><dt><span class="section"><a href="ch06.html#_how_to_build">6.1. How to build</a></span></dt><dt><span class="section"><a href="ch06.html#_what_to_build">6.2. What to build</a></span></dt><dt><span class="section"><a href="ch06.html#_application_resource_file">6.3. Application resource file</a></span></dt><dt><span class="section"><a href="ch06.html#_automatic_application_resource_file_values">6.4. Automatic application resource file values</a></span></dt><dt><span class="section"><a href="ch06.html#_file_formats">6.5. File formats</a></span></dt><dt><span class="section"><a href="ch06.html#_compilation_options">6.6. Compilation options</a></span></dt><dt><span class="section"><a href="ch06.html#_cold_and_hot_builds">6.7. Cold and hot builds</a></span></dt><dt><span class="section"><a href="ch06.html#_dependency_tracking">6.8. Dependency tracking</a></span></dt><dt><span class="section"><a href="ch06.html#_generating_erlang_source">6.9. Generating Erlang source</a></span></dt><dt><span class="section"><a href="ch06.html#_cleaning">6.10. Cleaning</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch07.html">7. Packages and dependencies</a></span></dt><dd><dl><dt><span class="section"><a href="ch07.html#_searching_packages">7.1. Searching packages</a></span></dt><dt><span class="section"><a href="ch07.html#_adding_dependencies_to_your_project">7.2. Adding dependencies to your project</a></span></dt><dt><span class="section"><a href="ch07.html#_how_deps_are_fetched_and_built">7.3. How deps are fetched and built</a></span></dt><dt><span class="section"><a href="ch07.html#_ignoring_unwanted_dependencies">7.4. Ignoring unwanted dependencies</a></span></dt><dt><span class="section"><a href="ch07.html#_dependencies_directory">7.5. Dependencies directory</a></span></dt><dt><span class="section"><a href="ch07.html#_dependencies_local_to_the_repository">7.6. Dependencies local to the repository</a></span></dt><dt><span class="section"><a href="ch07.html#_repositories_with_no_application_at_the_root_level">7.7. Repositories with no application at the root level</a></span></dt><dt><span class="section"><a href="ch07.html#_autopatch">7.8. Autopatch</a></span></dt><dt><span class="section"><a href="ch07.html#_skipping_deps">7.9. Skipping deps</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch08.html">8. NIFs and port drivers</a></span></dt><dd><dl><dt><span class="section"><a href="ch08.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="ch08.html#_using_a_custom_makefile">8.2. Using a custom Makefile</a></span></dt><dt><span class="section"><a href="ch08.html#_using_erlang_mk_directly">8.3. Using Erlang.mk directly</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch09.html">9. Releases</a></span></dt><dd><dl><dt><span class="section"><a href="ch09.html#_setup">9.1. Setup</a></span></dt><dt><span class="section"><a href="ch09.html#_configuration">9.2. Configuration</a></span></dt><dt><span class="section"><a href="ch09.html#_generating_the_release">9.3. Generating the release</a></span></dt><dt><span class="section"><a href="ch09.html#_running_the_release">9.4. Running the release</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch10.html">10. Escripts</a></span></dt><dt><span class="chapter"><a href="ch11.html">11. Compatibility with other build tools</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#_rebar_projects_as_erlang_mk_dependencies">11.1. Rebar projects as Erlang.mk dependencies</a></span></dt><dt><span class="section"><a href="ch11.html#_erlang_mk_projects_as_rebar_dependencies">11.2. Erlang.mk projects as Rebar dependencies</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="pt02.html">II. Documentation</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch12.html">12. Asciidoc documentation</a></span></dt><dt><span class="chapter"><a href="ch13.html">13. EDoc comments</a></span></dt></dl></dd><dt><span class="part"><a href="pt03.html">III. Tests</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch14.html">14. Erlang shell</a></span></dt><dd><dl><dt><span class="section"><a href="ch14.html#_configuration_2">14.1. Configuration</a></span></dt><dt><span class="section"><a href="ch14.html#_usage">14.2. Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch15.html">15. EUnit</a></span></dt><dd><dl><dt><span class="section"><a href="ch15.html#_writing_tests">15.1. Writing tests</a></span></dt><dt><span class="section"><a href="ch15.html#_configuration_3">15.2. Configuration</a></span></dt><dt><span class="section"><a href="ch15.html#_usage_2">15.3. Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch16.html">16. Common Test</a></span></dt><dt><span class="chapter"><a href="ch17.html">17. Property based testing</a></span></dt><dt><span class="chapter"><a href="ch18.html">18. Code coverage</a></span></dt><dt><span class="chapter"><a href="ch19.html">19. Continuous integration</a></span></dt><dt><span class="chapter"><a href="ch20.html">20. Dialyzer</a></span></dt><dd><dl><dt><span class="section"><a href="ch20.html#_how_it_works">20.1. How it works</a></span></dt><dt><span class="section"><a href="ch20.html#_configuration_4">20.2. Configuration</a></span></dt><dt><span class="section"><a href="ch20.html#_usage_3">20.3. Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch21.html">21. Xref</a></span></dt></dl></dd><dt><span class="part"><a href="pt04.html">IV. Third-party plugins</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch22.html">22. External plugins</a></span></dt><dd><dl><dt><span class="section"><a href="ch22.html#_loading_all_plugins_from_a_dependency">22.1. Loading all plugins from a dependency</a></span></dt><dt><span class="section"><a href="ch22.html#_loading_one_plugin_from_a_dependency">22.2. Loading one plugin from a dependency</a></span></dt><dt><span class="section"><a href="ch22.html#_writing_external_plugins">22.3. Writing external plugins</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="pt05.html">V. About Erlang.mk</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch23.html">23. Why Erlang.mk</a></span></dt><dd><dl><dt><span class="section"><a href="ch23.html#_erlang_mk_is_fast">23.1. Erlang.mk is fast</a></span></dt><dt><span class="section"><a href="ch23.html#_erlang_mk_gives_you_the_full_power_of_unix">23.2. Erlang.mk gives you the full power of Unix</a></span></dt><dt><span class="section"><a href="ch23.html#_erlang_mk_is_a_text_file">23.3. Erlang.mk is a text file</a></span></dt><dt><span class="section"><a href="ch23.html#_erlang_mk_can_manage_erlang_itself">23.4. Erlang.mk can manage Erlang itself</a></span></dt><dt><span class="section"><a href="ch23.html#_erlang_mk_can_do_more_than_erlang">23.5. Erlang.mk can do more than Erlang</a></span></dt><dt><span class="section"><a href="ch23.html#_erlang_mk_integrates_nicely_in_make_and_automake_projects">23.6. Erlang.mk integrates nicely in Make and Automake projects</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch24.html">24. Short history</a></span></dt><dd><dl><dt><span class="section"><a href="ch24.html#_before_erlang_mk">24.1. Before Erlang.mk</a></span></dt><dt><span class="section"><a href="ch24.html#_lifetime_of_the_project">24.2. Lifetime of the project</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch25.html">25. Contributing</a></span></dt><dd><dl><dt><span class="section"><a href="ch25.html#_priorities">25.1. Priorities</a></span></dt><dt><span class="section"><a href="ch25.html#_bugs">25.2. Bugs</a></span></dt><dt><span class="section"><a href="ch25.html#_code_2">25.3. Code</a></span></dt><dt><span class="section"><a href="ch25.html#_packages">25.4. Packages</a></span></dt><dt><span class="section"><a href="ch25.html#_documentation_2">25.5. Documentation</a></span></dt><dt><span class="section"><a href="ch25.html#_feature_requests">25.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="ch01.html">Next</a></td></tr></table></div>
</main>
</body>
</html>